diff options
author | Tiger Wang <ziwei.tiger@hotmail.co.uk> | 2014-07-02 19:48:05 +0200 |
---|---|---|
committer | Tiger Wang <ziwei.tiger@hotmail.co.uk> | 2014-07-02 19:48:05 +0200 |
commit | f5659a08b8413bf756cd15308e66e7927cae8c9f (patch) | |
tree | 455172b964b2eb5eebb82b6366ce7ac2fb54fc48 /MCServer/Plugins/APIDump/Hooks | |
parent | Fixed player teleport food drain (diff) | |
parent | Merge pull request #1139 from Howaner/Hooks (diff) | |
download | cuberite-f5659a08b8413bf756cd15308e66e7927cae8c9f.tar cuberite-f5659a08b8413bf756cd15308e66e7927cae8c9f.tar.gz cuberite-f5659a08b8413bf756cd15308e66e7927cae8c9f.tar.bz2 cuberite-f5659a08b8413bf756cd15308e66e7927cae8c9f.tar.lz cuberite-f5659a08b8413bf756cd15308e66e7927cae8c9f.tar.xz cuberite-f5659a08b8413bf756cd15308e66e7927cae8c9f.tar.zst cuberite-f5659a08b8413bf756cd15308e66e7927cae8c9f.zip |
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks')
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua | 27 |
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 +}; + + + + |