aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorest31 <MTest31@outlook.com>2015-08-02 18:23:22 +0200
committerest31 <MTest31@outlook.com>2015-08-02 19:09:55 +0200
commita890c66bc035918d7478fc1742241eadfd9a5bae (patch)
treebcdcf382e06a267c79a96a9ed99eb23639a5a1c1 /doc
parentec796b8e814864b433aea75119c307f44b2b33e8 (diff)
downloadminetest-a890c66bc035918d7478fc1742241eadfd9a5bae.tar.gz
minetest-a890c66bc035918d7478fc1742241eadfd9a5bae.tar.bz2
minetest-a890c66bc035918d7478fc1742241eadfd9a5bae.zip
Actually document what minetest.is_protected should do
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index ab059e182..673eed620 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2300,6 +2300,9 @@ These functions return the leftover itemstack.
* currently supported.
* `...` indicates method-specific arguments. Currently, no methods use this.
* `minetest.is_protected(pos, name)`: returns boolean
+ * Returns true, if player `name` shouldn't be abled to dig at `pos` or do other
+ actions, defineable by mods, due to some mod-defined ownership-like concept.
+ Returns false or nil, if the player is allowed to do such actions.
* This function should be overridden by protection mods and should be used to
check if a player can interact at a position.
* This function should call the old version of itself if the position is not