From 9776b89fb7d9eb99fdf6e3487927b92c8725a2f0 Mon Sep 17 00:00:00 2001 From: madmaxoft Date: Fri, 18 Oct 2013 10:04:44 +0200 Subject: APIDump: Documented HOOK_PLAYER_RIGHT_CLICKING_ENTITY. --- MCServer/Plugins/APIDump/APIDesc.lua | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'MCServer') 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)", -- cgit v1.2.3