summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins
diff options
context:
space:
mode:
authorMattes D <github@xoft.cz>2014-07-02 16:33:24 +0200
committerMattes D <github@xoft.cz>2014-07-02 16:33:24 +0200
commit9204c8a124c015be6919be8428517e0e3f0429e7 (patch)
tree4038c19d1cb7f74baf427923869c5c450ed1583c /MCServer/Plugins
parentCMake: Use cmake for file-copying. (diff)
parentUpdate documentation (diff)
downloadcuberite-9204c8a124c015be6919be8428517e0e3f0429e7.tar
cuberite-9204c8a124c015be6919be8428517e0e3f0429e7.tar.gz
cuberite-9204c8a124c015be6919be8428517e0e3f0429e7.tar.bz2
cuberite-9204c8a124c015be6919be8428517e0e3f0429e7.tar.lz
cuberite-9204c8a124c015be6919be8428517e0e3f0429e7.tar.xz
cuberite-9204c8a124c015be6919be8428517e0e3f0429e7.tar.zst
cuberite-9204c8a124c015be6919be8428517e0e3f0429e7.zip
Diffstat (limited to 'MCServer/Plugins')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua27
1 files changed, 27 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..53637d5f1
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
@@ -0,0 +1,27 @@
+return
+{
+ HOOK_PLAYER_FOOD_LEVEL_CHANGE =
+ {
+ CalledWhen = "Called before the player food level changed. Plugin may override",
+ DefaultFnName = "OnPlayerFoodLevelChange", -- also used as pagename
+ Desc = [[
+ This hook is called before the food level changes.
+ The food level is not changed yet, plugins may choose
+ to refuse the change.
+ ]],
+ Params =
+ {
+ { Name = "Player", Type = "{{cPlayer}}", Notes = "The player who changes 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 changes the food level of 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
+};
+
+
+
+