aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorezhh <owlecho@live.com>2018-01-13 03:42:07 +0000
committerparamat <mat.gregory@virginmedia.com>2018-01-13 14:59:18 +0000
commit8349a3db1072e3a805482e91c442f9a158ea60b1 (patch)
tree7de456f8130a2877662897ae44090d961e9c7beb /doc
parent792752997c5ae2aaa4f54d0a2e2af2a96d7d1e9f (diff)
downloadminetest-8349a3db1072e3a805482e91c442f9a158ea60b1.tar.gz
minetest-8349a3db1072e3a805482e91c442f9a158ea60b1.tar.bz2
minetest-8349a3db1072e3a805482e91c442f9a158ea60b1.zip
Lua_api.txt: Add chat command params info
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index fdc8540a8..f4178401a 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -5156,6 +5156,17 @@ Definition tables
-- Returns boolean success and text output.
}
+Note that in params, use of symbols is as follows:
+
+* `<>` signifies a placeholder to be replaced when the command is used. For example,
+ when a player name is needed: `<name>`
+* `[]` signifies param is optional and not required when the command is used. For
+ example, if you require param1 but param2 is optional: `<param1> [<param2>]`
+* `|` signifies exclusive or. The command requires one param from the options
+ provided. For example: `<param1> | <param2>`
+* `()` signifies grouping. For example, when param1 and param2 are both required,
+ or only param3 is required: `(<param1> <param2>) | <param3>`
+
### Detached inventory callbacks
{