flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

Change documentation

Browse Source
This commit is contained in:
Howaner 2014-07-01 20:30:13 +02:00
parent 8e11f7a1f6
commit 5a888f0a51
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
View File

@ -5,18 +5,23 @@ return
CalledWhen = "Called before the player food level changed. Plugin may override / refuse.", CalledWhen = "Called before the player food level changed. Plugin may override / refuse.",
DefaultFnName = "OnPlayerFoodLevelChange", -- also used as pagename DefaultFnName = "OnPlayerFoodLevelChange", -- also used as pagename
Desc = [[ Desc = [[
This hook is called just before the food level change. This hook is called before the food level changes.
The food level is not yet changed, plugins may choose to override the new food level or refuse the change. The food level is not changed yet, plugins may choose
to override the new food level or refuse the change.
]], ]],
Params = Params =
{ {
{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who change the food level." }, { Name = "Player", Type = "{{cPlayer}}", Notes = "The player who changes the food level." },
{ Name = "NewFoodLevel", Type = "number", Notes = "The new food level." }, { Name = "NewFoodLevel", Type = "number", Notes = "The new food level. You can override it." },
}, },
Returns = [[ Returns = [[
If the function returns false or no value, the next plugin's callback is called. Afterwards, the 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. other callback is called for this event and the player's food level doesn't change.
]], ]],
}, -- HOOK_PLAYER_FOOD_LEVEL_CHANGE }, -- HOOK_PLAYER_FOOD_LEVEL_CHANGE
}; };