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: `` +* `[]` signifies param is optional and not required when the command is used. For + example, if you require param1 but param2 is optional: ` []` +* `|` signifies exclusive or. The command requires one param from the options + provided. For example: ` | ` +* `()` signifies grouping. For example, when param1 and param2 are both required, + or only param3 is required: `( ) | ` + ### Detached inventory callbacks {