diff options
author | Howaner <franzi.moos@googlemail.com> | 2014-11-15 12:37:12 +0100 |
---|---|---|
committer | Howaner <franzi.moos@googlemail.com> | 2014-11-15 12:37:12 +0100 |
commit | ba1f0958e825b0c8075aa85fe23448f90c0456b3 (patch) | |
tree | 8cf3ff67bbffc470021095975c204d9abdb80fdd /MCServer | |
parent | Missing space :D (diff) | |
download | cuberite-ba1f0958e825b0c8075aa85fe23448f90c0456b3.tar cuberite-ba1f0958e825b0c8075aa85fe23448f90c0456b3.tar.gz cuberite-ba1f0958e825b0c8075aa85fe23448f90c0456b3.tar.bz2 cuberite-ba1f0958e825b0c8075aa85fe23448f90c0456b3.tar.lz cuberite-ba1f0958e825b0c8075aa85fe23448f90c0456b3.tar.xz cuberite-ba1f0958e825b0c8075aa85fe23448f90c0456b3.tar.zst cuberite-ba1f0958e825b0c8075aa85fe23448f90c0456b3.zip |
Diffstat (limited to 'MCServer')
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerAnimation.lua | 2 | ||||
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua | 25 | ||||
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerRightClick.lua | 10 |
3 files changed, 16 insertions, 21 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerAnimation.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerAnimation.lua index baf99834e..9d7d5fa5a 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerAnimation.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerAnimation.lua @@ -2,7 +2,7 @@ return { HOOK_PLAYER_ANIMATION = { - CalledWhen = "A client has sent an Animation packet (0x12)", + CalledWhen = "<b>DEPRECATED!</b> 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> diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua index 1d9585c55..38a998e1c 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua @@ -2,24 +2,19 @@ return { HOOK_PLAYER_LEFT_CLICK = { - CalledWhen = "A left-click packet is received from the client. Plugin may override / refuse.", + CalledWhen = "A client do a left click. Plugin may override / refuse.", DefaultFnName = "OnPlayerLeftClick", -- also used as pagename Desc = [[ - This hook is called when MCServer receives a left-click packet from the {{cClientHandle|client}}. It - is called before any processing whatsoever is performed on the packet, meaning that hacked / - malicious clients may be trigerring this event very often and with unchecked parameters. Therefore - plugin authors are advised to use extreme caution with this callback.</p> + This hook is called when a player do a left click to a specific block or the air.</p> <p> Plugins may refuse the default processing for the packet, causing MCServer to behave as if the packet has never arrived. This may, however, create inconsistencies in the client - the client may think that they broke a block, while the server didn't process the breaking, etc. For this reason, if a plugin refuses the processing, MCServer sends the block specified in the packet back to the - client (as if placed anew), if the status code specified a block-break action. For other actions, - plugins must rectify the situation on their own.</p> + client (as if placed anew).</p> <p> - The client sends the left-click packet for several other occasions, such as dropping the held item - (Q keypress) or shooting an arrow. This is reflected in the Status code. Consult the - <a href="http://wiki.vg/Protocol#0x0E">protocol documentation</a> for details on the actions. + If BlockFace is BLOCK_FACE_NONE, the client interacts with the air and not with a specific block. + In this case, BlockX/Y/Z are 0. ]], Params = { @@ -28,15 +23,13 @@ return { Name = "BlockY", Type = "number", Notes = "Y-coord of the block" }, { Name = "BlockZ", Type = "number", Notes = "Z-coord of the block" }, { Name = "BlockFace", Type = "number", Notes = "Face of the block upon which the player interacted. One of the BLOCK_FACE_ constants" }, - { Name = "Action", Type = "number", Notes = "Action to be performed on the block (\"status\" in the protocol docs)" }, }, Returns = [[ - If the function returns false or no value, MCServer calls other plugins' callbacks and finally sends - the packet for further processing.</p> + If the function returns false or no value, MCServer calls other plugins' callbacks and finally break + the block.</p> <p> - If the function returns true, no other plugins are called, processing is halted. If the action was a - block dig, MCServer sends the block specified in the coords back to the client. The packet is - dropped. + If the function returns true, no other plugins are called, processing is halted. + MCServer sends the block specified in the coords back to the client. The packet is dropped. ]], }, -- HOOK_PLAYER_LEFT_CLICK } diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClick.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClick.lua index de9b3662c..9f23a8039 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClick.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerRightClick.lua @@ -2,17 +2,19 @@ return { HOOK_PLAYER_RIGHT_CLICK = { - CalledWhen = "A right-click packet is received from the client. Plugin may override / refuse.", + CalledWhen = "The client do a right click. Plugin may override / refuse.", DefaultFnName = "OnPlayerRightClick", -- also used as pagename Desc = [[ This hook is called when MCServer receives a right-click packet from the {{cClientHandle|client}}. It is called before any processing whatsoever is performed on the packet, meaning that hacked / - malicious clients may be trigerring this event very often and with unchecked parameters. Therefore + malicious clients may be trigerring this even very often and with unchecked parameters. Therefore plugin authors are advised to use extreme caution with this callback.</p> <p> Plugins may refuse the default processing for the packet, causing MCServer to behave as if the packet has never arrived. This may, however, create inconsistencies in the client - the client may - think that they placed a block, while the server didn't process the placing, etc. + think that they placed a block, while the server didn't process the placing, etc.</p> + <p> + If BlockFace is BLOCK_FACE_NONE, the player interacts with the air and not with a specific block. ]], Params = { @@ -37,4 +39,4 @@ return - +t |