summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks
diff options
context:
space:
mode:
authorHowaner <franzi.moos@googlemail.com>2014-06-30 15:22:48 +0200
committerHowaner <franzi.moos@googlemail.com>2014-06-30 15:22:48 +0200
commit5a152435b3fa1452a842519e21ab0643020bc1ab (patch)
tree46f8d7ad234af617a144c1d5dc8255684c8bbe0b /MCServer/Plugins/APIDump/Hooks
parentAdd new hook: HOOK_PLAYER_FOOD_LEVEL_CHANGE (diff)
downloadcuberite-5a152435b3fa1452a842519e21ab0643020bc1ab.tar
cuberite-5a152435b3fa1452a842519e21ab0643020bc1ab.tar.gz
cuberite-5a152435b3fa1452a842519e21ab0643020bc1ab.tar.bz2
cuberite-5a152435b3fa1452a842519e21ab0643020bc1ab.tar.lz
cuberite-5a152435b3fa1452a842519e21ab0643020bc1ab.tar.xz
cuberite-5a152435b3fa1452a842519e21ab0643020bc1ab.tar.zst
cuberite-5a152435b3fa1452a842519e21ab0643020bc1ab.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua22
1 files changed, 22 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
new file mode 100644
index 000000000..4838573e5
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
@@ -0,0 +1,22 @@
+return
+{
+ HOOK_PLAYER_FOOD_LEVEL_CHANGE =
+ {
+ CalledWhen = "Called before the player food level changed. Plugin may override / refuse.",
+ DefaultFnName = "OnPlayerFoodLevelChange", -- also used as pagename
+ Desc = [[
+ This hook is called just before the food level change.
+ The food level is not yet changed, plugins may choose to override the new food level or refuse the change.
+ ]],
+ Params =
+ {
+ { Name = "Player", Type = "{{cPlayer}}", Notes = "The player who change the food level." },
+ { Name = "NewFoodLevel", Type = "number", Notes = "The new food level." },
+ },
+ Returns = [[
+ If the function returns false or no value, the next plugin's callback is called. Afterwards, the
+ server change the food level from the player. If the function returns true, no
+ other callback is called for this event and the player's food level doesn't change.
+ ]],
+ }, -- HOOK_PLAYER_FOOD_LEVEL_CHANGE
+};