aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobert Zenz <Robert.Zenz@bonsaimind.org>2015-09-03 21:28:38 +0200
committerest31 <MTest31@outlook.com>2015-10-22 19:55:48 +0200
commitc32847838d72c327031520c48b76607b63da4ccc (patch)
tree9b5d7f9015dda039264652d23f8a38f4a09e3b74 /doc
parent37c1e2012724a5d74aa0b720ab91953a2cf2bf05 (diff)
downloadminetest-c32847838d72c327031520c48b76607b63da4ccc.tar.gz
minetest-c32847838d72c327031520c48b76607b63da4ccc.tar.bz2
minetest-c32847838d72c327031520c48b76607b63da4ccc.zip
Add more ways to pass data to check_player_privs
The callback can now be invoked with either the player object or name as the first parameter, and with either a table or a list of strings, like this: minetest.check_player_privs(player_name, { shout = true, fly = true }) minetest.check_player_privs(player_name, "shout", "fly") minetest.check_player_privs(player, { shout = true, fly = true }) minetest.check_player_privs(player, "shout", "fly")
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 489154fb3..0339345ba 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -1924,8 +1924,11 @@ Call these functions only at load time!
* `minetest.set_player_privs(name, {priv1=true,...})`
* `minetest.get_player_privs(name) -> {priv1=true,...}`
* `minetest.auth_reload()`
-* `minetest.check_player_privs(name, {priv1=true,...})`: returns `bool, missing_privs`
- * A quickhand for checking privileges
+* `minetest.check_player_privs(player_or_name, ...)`: returns `bool, missing_privs`
+ * A quickhand for checking privileges.
+ * `player_or_name`: Either a Player object or the name of a player.
+ * `...` is either a list of strings, e.g. `"priva", "privb"` or
+ a table, e.g. `{ priva = true, privb = true }`.
* `minetest.get_player_ip(name)`: returns an IP address string
`minetest.set_player_password`, `minetest_set_player_privs`, `minetest_get_player_privs`