APIDump: Documented HOOK_PLAYER_SHOOTING.
This commit is contained in:
parent
8020cbd3d7
commit
5a31d191eb
@ -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.",
|
||||
|
Loading…
Reference in New Issue
Block a user