summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSmallJoker <SmallJoker@users.noreply.github.com>2019-12-15 18:55:01 +0100
committerGitHub <noreply@github.com>2019-12-15 18:55:01 +0100
commit41ff0f6679ec3b54b8306e20b6564bdf0da34b5a (patch)
treee70221b2e27c43c8b50ff302191b9415501df027 /doc
parent03e1f23a5e7b8daf3431b9e8436d662c0212886a (diff)
downloadminetest-41ff0f6679ec3b54b8306e20b6564bdf0da34b5a.tar.gz
minetest-41ff0f6679ec3b54b8306e20b6564bdf0da34b5a.tar.bz2
minetest-41ff0f6679ec3b54b8306e20b6564bdf0da34b5a.zip
Lua API: Document HP, breath and damage limits (#9080)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index b23bd915c..cb92ea7b8 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -5623,6 +5623,9 @@ This is basically a reference to a C++ `ServerActiveObject`
* `get_hp()`: returns number of hitpoints (2 * number of hearts)
* `set_hp(hp, reason)`: set number of hitpoints (2 * number of hearts).
* See reason in register_on_player_hpchange
+ * Is limited to the range of 0 ... 65535 (2^16 - 1)
+ * For players: HP are also limited by `hp_max` specified in the player's
+ object properties
* `get_inventory()`: returns an `InvRef` for players, otherwise returns `nil`
* `get_wield_list()`: returns the name of the inventory list the wielded item
is in.
@@ -5743,6 +5746,7 @@ This is basically a reference to a C++ `ServerActiveObject`
* `0`: player is drowning
* max: bubbles bar is not shown
* See [Object properties] for more information
+ * Is limited to range 0 ... 65535 (2^16 - 1)
* `set_fov(fov, is_multiplier)`: Sets player's FOV
* `fov`: FOV value.
* `is_multiplier`: Set to `true` if the FOV value is a multiplier.
@@ -6432,6 +6436,7 @@ Used by `minetest.register_node`, `minetest.register_craftitem`, and
uses = 20, maxlevel = 2},
},
damage_groups = {groupname = damage},
+ -- Damage values must be between -32768 and 32767 (2^15)
punch_attack_uses = nil,
-- Amount of uses this tool has for attacking players and entities