oss/luanti
oss/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-09-15 18:57:08 +00:00
Code Wiki Activity

Docs: Clarify where to check for 'protection_bypass' (#8675)

Browse source
This commit is contained in:
SmallJoker 2019-07-14 13:23:38 +02:00 • committed by GitHub
parent 0c31946943
commit 47492386ec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/lua_api.txt
View file

@ -4856,15 +4856,13 @@ Misc.
* `minetest.decode_base64(string)`: returns string
* Decodes a string encoded in base64.
* `minetest.is_protected(pos, name)`: returns boolean
* Returns true, if player `name` shouldn't be able to dig at `pos` or do
other actions, definable by mods, due to some mod-defined ownership-like
concept.
* Returns false or nil, if the player is allowed to do such actions.
* `name` will be "" for non-players or unknown players.
* 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 protected by the mod.
* Returning `true` restricts the player `name` from modifying (i.e. digging,
placing) the node at position `pos`.
* `name` will be `""` for non-players or unknown players.
* This function should be overridden by protection mods. It is highly
recommended to grant access to players with the `protection_bypass` privilege.
* Cache and call the old version of this function if the position is
not protected by the mod. This will allow using multiple protection mods.
* Example:
local old_is_protected = minetest.is_protected