From: est31 <MTest31@outlook.com>
Date: Sun, 2 Aug 2015 16:23:22 +0000 (+0200)
Subject: Actually document what minetest.is_protected should do
X-Git-Tag: 0.4.13~57
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=a890c66bc035918d7478fc1742241eadfd9a5bae;p=oweals%2Fminetest.git

Actually document what minetest.is_protected should do
---

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