Update documentation
This commit is contained in:
parent
4a9002045b
commit
835d00428c
@ -2,17 +2,17 @@ return
|
|||||||
{
|
{
|
||||||
HOOK_PLAYER_FOOD_LEVEL_CHANGE =
|
HOOK_PLAYER_FOOD_LEVEL_CHANGE =
|
||||||
{
|
{
|
||||||
CalledWhen = "Called before the player food level changed. Plugin may override / refuse.",
|
CalledWhen = "Called before the player food level changed. Plugin may override",
|
||||||
DefaultFnName = "OnPlayerFoodLevelChange", -- also used as pagename
|
DefaultFnName = "OnPlayerFoodLevelChange", -- also used as pagename
|
||||||
Desc = [[
|
Desc = [[
|
||||||
This hook is called before the food level changes.
|
This hook is called before the food level changes.
|
||||||
The food level is not changed yet, plugins may choose
|
The food level is not changed yet, plugins may choose
|
||||||
to override the new food level or refuse the change.
|
to refuse the change.
|
||||||
]],
|
]],
|
||||||
Params =
|
Params =
|
||||||
{
|
{
|
||||||
{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who changes the 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." },
|
{ Name = "NewFoodLevel", Type = "number", Notes = "The new food level." },
|
||||||
},
|
},
|
||||||
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
|
||||||
|
Loading…
Reference in New Issue
Block a user