diff options
Diffstat (limited to 'Server/Plugins/APIDump/Hooks/OnPlayerAnimation.lua')
| -rw-r--r-- | Server/Plugins/APIDump/Hooks/OnPlayerAnimation.lua | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/Server/Plugins/APIDump/Hooks/OnPlayerAnimation.lua b/Server/Plugins/APIDump/Hooks/OnPlayerAnimation.lua new file mode 100644 index 000000000..baf99834e --- /dev/null +++ b/Server/Plugins/APIDump/Hooks/OnPlayerAnimation.lua @@ -0,0 +1,28 @@ +return +{ + HOOK_PLAYER_ANIMATION = + { + CalledWhen = "A client has sent an Animation packet (0x12)", + DefaultFnName = "OnPlayerAnimation", -- also used as pagename + Desc = [[ + This hook is called when the server receives an Animation packet (0x12) from the client.</p> + <p> + For the list of animations that are sent by the client, see the + <a href="http://wiki.vg/Protocol#0x12">Protocol wiki</a>. + ]], + Params = + { + { Name = "Player", Type = "{{cPlayer}}", Notes = "The player from whom the packet was received" }, + { Name = "Animation", Type = "number", Notes = "The kind of animation" }, + }, + Returns = [[ + If the function returns false or no value, the next plugin's callback is called. Afterwards, the + server broadcasts the animation packet to all nearby clients. If the function returns true, no other + callback is called for this event and the packet is not broadcasted. + ]], + }, -- HOOK_PLAYER_ANIMATION +} + + + + |