summaryrefslogtreecommitdiffstats
path: root/MCServer
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-18 09:57:35 +0200
committermadmaxoft <github@xoft.cz>2013-10-18 09:57:35 +0200
commit5a31d191eb9f12f20899db3ff1361891f29e4e10 (patch)
tree06728928d8ebd61daba1b16f844bb91de97f8859 /MCServer
parentAPIDump: Documented HOOK_PLAYER_SPAWNED. (diff)
downloadcuberite-5a31d191eb9f12f20899db3ff1361891f29e4e10.tar
cuberite-5a31d191eb9f12f20899db3ff1361891f29e4e10.tar.gz
cuberite-5a31d191eb9f12f20899db3ff1361891f29e4e10.tar.bz2
cuberite-5a31d191eb9f12f20899db3ff1361891f29e4e10.tar.lz
cuberite-5a31d191eb9f12f20899db3ff1361891f29e4e10.tar.xz
cuberite-5a31d191eb9f12f20899db3ff1361891f29e4e10.tar.zst
cuberite-5a31d191eb9f12f20899db3ff1361891f29e4e10.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua25
1 files changed, 25 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index d8aa77b19..4c22853f7 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2894,6 +2894,31 @@ end;
]],
}, -- HOOK_PLAYER_RIGHT_CLICK
+ HOOK_PLAYER_SHOOTING =
+ {
+ CalledWhen = "When the player releases the bow, shooting an arrow (other projectiles: unknown)",
+ DefaultFnName = "OnPlayerShooting", -- also used as pagename
+ Desc = [[
+ This hook is called when the {{cPlayer|player}} shoots their bow. It is called for the actual
+ release of the {{cArrowEntity|arrow}}. FIXME: It is currently unknown whether other
+ {{cProjectileEntity|projectiles}} (snowballs, eggs) trigger this hook.</p>
+ <p>
+ To get the player's position and direction, use the {{cPlayer}}:GetEyePosition() and
+ cPlayer:GetLookVector() functions. Note that for shooting a bow, the position for the arrow creation
+ is not at the eye pos, some adjustments are required. FIXME: Export the {{cPlayer}} function for
+ this adjustment.
+ ]],
+ Params =
+ {
+ { Name = "Player", Type = "{{cPlayer}}", Notes = "The player shooting" },
+ },
+ Returns = [[
+ If the function returns false or no value, the next plugin's callback is called, and finally
+ MCServer creates the projectile. If the functino returns true, no other callback is called and no
+ projectile is created.
+ ]],
+ }, -- HOOK_PLAYER_SHOOTING
+
HOOK_PLAYER_SPAWNED =
{
CalledWhen = "After a player (re)spawns in the world to which they belong to.",