Document hpchange callback ordering thing (#3981)

Document hpchange callback ordering thing

Callbacks registered by register_on_player_hpchange are ordered so that non-modifiers are called after modifiers are called. Credit to @TeTpaAka who mentioned this previously-undocumented feature in #3799.

See also commit

aa13baa30a45b0f834c23bd5c0407895eb8ec0ee "Add minetest.register_on_player_hpchange"

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index a03a95d9edb2c6171c2c7e99056f00b79a738695..17b311ffdf72e7c45f21e85e35d94bd2894a94de 100644 (file)
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -1870,6 +1870,7 @@ Call these functions only at load time!
     * `modifier`: when true, the function should return the actual hp_change.
       Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
       modifiers can return true as a second argument to stop the execution of further functions.
+      Non-modifiers receive the final hp change calculated by the modifiers.
 * `minetest.register_on_respawnplayer(func(ObjectRef))`
      * Called when player is to be respawned
      * Called _before_ repositioning of player occurs