summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
diff options
context:
space:
mode:
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua15
1 files changed, 10 insertions, 5 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
index 4838573e5..5a6fc862a 100644
--- a/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
+++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
@@ -5,18 +5,23 @@ return
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.
+ This hook is called before the food level changes.
+ The food level is not changed yet, 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." },
+ { Name = "Player", Type = "{{cPlayer}}", Notes = "The player who changes the food level." },
+ { Name = "NewFoodLevel", Type = "number", Notes = "The new food level. You can override it." },
},
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
+ 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
};
+
+
+
+