diff options
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua')
| -rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua index 1d9585c55..3d4c07950 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerLeftClick.lua @@ -5,15 +5,15 @@ return CalledWhen = "A left-click packet is received from the client. 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 + This hook is called when Cuberite 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> <p> - Plugins may refuse the default processing for the packet, causing MCServer to behave as if the + Plugins may refuse the default processing for the packet, causing Cuberite 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 + if a plugin refuses the processing, Cuberite 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> <p> @@ -31,11 +31,11 @@ return { 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 + If the function returns false or no value, Cuberite calls other plugins' callbacks and finally sends the packet for further processing.</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 + block dig, Cuberite sends the block specified in the coords back to the client. The packet is dropped. ]], }, -- HOOK_PLAYER_LEFT_CLICK |