summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-18 10:04:44 +0200
committermadmaxoft <github@xoft.cz>2013-10-18 10:04:44 +0200
commit9776b89fb7d9eb99fdf6e3487927b92c8725a2f0 (patch)
tree9ddfa3bbe0b620d5c2496bfa0bbd8c85e363a12d /MCServer/Plugins/APIDump
parentAPIDump: Documented HOOK_PLAYER_SHOOTING. (diff)
downloadcuberite-9776b89fb7d9eb99fdf6e3487927b92c8725a2f0.tar
cuberite-9776b89fb7d9eb99fdf6e3487927b92c8725a2f0.tar.gz
cuberite-9776b89fb7d9eb99fdf6e3487927b92c8725a2f0.tar.bz2
cuberite-9776b89fb7d9eb99fdf6e3487927b92c8725a2f0.tar.lz
cuberite-9776b89fb7d9eb99fdf6e3487927b92c8725a2f0.tar.xz
cuberite-9776b89fb7d9eb99fdf6e3487927b92c8725a2f0.tar.zst
cuberite-9776b89fb7d9eb99fdf6e3487927b92c8725a2f0.zip
Diffstat (limited to 'MCServer/Plugins/APIDump')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua20
1 files changed, 20 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 4c22853f7..2ea51dbf2 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2894,6 +2894,26 @@ end;
]],
}, -- HOOK_PLAYER_RIGHT_CLICK
+ HOOK_PLAYER_RIGHT_CLICKING_ENTITY =
+ {
+ CalledWhen = "A player has right-clicked an entity. Plugins may override / refuse.",
+ DefaultFnName = "OnPlayerRightClickingEntity", -- also used as pagename
+ Desc = [[
+ This hook is called when the {{cPlayer|player}} right-clicks an {{cEntity|entity}}. Plugins may
+ override the default behavior or even cancel the default processing.
+ ]],
+ Params =
+ {
+ { Name = "Player", Type = "{{cPlayer}}", Notes = "The player who has right-clicked the entity" },
+ { Name = "Entity", Type = "{{cEntity}} descendant", Notes = "The entity that has been right-clicked" },
+ },
+ Returns = [[
+ If the functino returns false or no value, MCServer calls other plugins' callbacks and finally does
+ the default processing for the right-click. If the function returns true, no other callbacks are
+ called and the default processing is skipped.
+ ]],
+ }, -- HOOK_PLAYER_RIGHT_CLICKING_ENTITY
+
HOOK_PLAYER_SHOOTING =
{
CalledWhen = "When the player releases the bow, shooting an arrow (other projectiles: unknown)",