Add list setting -> chatcmd def for external access (#62)

* Add list setting -> chatcmd def for external access

* Document the _list_setting field

... in both the chatcmd def and minetest.register_list_command

* doc: add missing 'by'

* remove underscore (_list_setting -> list_setting)

---------

Co-authored-by: Lizzy Fleckenstein <eliasfleckenstein@web.de>
master
Cora de la Mouche 2023-06-23 18:26:33 +02:00 committed by GitHub
parent 2c050a42d7
commit 6df1590803
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 0 deletions

View File

@ -74,6 +74,7 @@ if INIT == "client" then
local def = {}
def.description = desc
def.params = "del <item> | add <item> | list"
def.list_setting = setting
function def.func(param)
local list = (minetest.settings:get(setting) or ""):split(",")
if param == "list" then

View File

@ -712,6 +712,8 @@ Call these functions only at load time!
* `add` adds something to the list
* `del` del removes something from the list
* `list` lists all items on the list
* The field `list_setting` will be set in the chatcommand definition to be able to recover it the
value of the 3rd parameter (settings) from minetest.registered_chatcommands later.
* `minetest.register_on_chatcommand(function(command, params))`
* Called always when a chatcommand is triggered, before `minetest.registered_chatcommands`
is checked to see if that the command exists, but after the input is parsed.
@ -1632,6 +1634,7 @@ It can be created via `Raycast(pos1, pos2, objects, liquids)` or
description = "Remove privilege from player", -- Full description
func = function(param), -- Called when command is run.
-- Returns boolean success and text output.
list_setting, -- this field will be automatically set by the minetest.register_list_command reflecting the 3rd "setting" parameter
}
### Server info
```lua