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

APIDump: Documented HOOK_PLAYER_ANIMATION.

Browse Source
This commit is contained in:
madmaxoft 2013-10-14 22:01:10 +02:00
parent e4bb796c6b
commit d34fa4970a
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -2611,6 +2611,27 @@ end;
]],
}, -- HOOK_LOGIN
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
}, -- Hooks[]