path: root/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua

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
};