BRNSystems/minetest
1
0
Fork 0
forked from Mirrorlandia_minetest/minetest
Code Pull Requests 1 Activity

Lua_api.txt: Add chat command params info

Browse Source
This commit is contained in:
ezhh 2018-01-13 03:42:07 +00:00 committed by paramat
parent 792752997c
commit 8349a3db10
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/lua_api.txt
View File

@ -5156,6 +5156,17 @@ Definition tables
-- Returns boolean success and text output. -- 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 ### Detached inventory callbacks
{ {