summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorShadowNinja <shadowninja@minetest.net>2014-01-29 18:27:05 -0500
committerShadowNinja <shadowninja@minetest.net>2014-05-28 18:36:46 -0400
commite7706593c6cbbab97667387e7c6cdb493ec2a98d (patch)
tree71ab20017a780029a814a61f63043724d06346d9 /doc
parent832d7973c8028d743eb331cb3d499692cebdc724 (diff)
downloadminetest-e7706593c6cbbab97667387e7c6cdb493ec2a98d.tar.gz
minetest-e7706593c6cbbab97667387e7c6cdb493ec2a98d.tar.bz2
minetest-e7706593c6cbbab97667387e7c6cdb493ec2a98d.zip
Add success and output return values to chat commands
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 803314925..f4e1fd230 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2543,10 +2543,11 @@ Decoration definition (register_decoration)
Chatcommand definition (register_chatcommand)
{
- params = "<name> <privilege>", -- short parameter description
- description = "Remove privilege from player", -- full description
- privs = {privs=true}, -- require the "privs" privilege to run
- func = function(name, param), -- called when command is run
+ params = "<name> <privilege>", -- Short parameter description
+ description = "Remove privilege from player", -- Full description
+ privs = {privs=true}, -- Require the "privs" privilege to run
+ func = function(name, param), -- Called when command is run.
+ -- Returns boolean success and text output.
}
Detached inventory callbacks