QCherry: Update Lua event reference

2026-08-14T22:31:59Z

Update Lua event reference

New page

= onPlayerRangedImpact =
Triggered when an authoritative arrow or bolt impacts a player or the world.

== Availability ==
This event is available in '''server-side''' scripts.

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerRangedImpact(ownerPlayerId, targetPlayerId, projectileId, shotId, weaponType, damage, healthAfter, killed, x, y, z)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>ownerPlayerId</code> || <code>int</code> || The shooting player ID.
|-
| <code>targetPlayerId</code> || <code>int</code> || The impacted player ID, or the runtime's no-player value.
|-
| <code>projectileId</code> || <code>int</code> || The projectile ID.
|-
| <code>shotId</code> || <code>int</code> || The shot sequence ID.
|-
| <code>weaponType</code> || <code>string</code> || Either bow or crossbow.
|-
| <code>damage</code> || <code>number</code> || Validated impact damage.
|-
| <code>healthAfter</code> || <code>number</code> || Target health after the impact.
|-
| <code>killed</code> || <code>bool</code> || Whether the target reached zero health.
|-
| <code>x</code> || <code>number</code> || Impact X coordinate in metres.
|-
| <code>y</code> || <code>number</code> || Impact Y coordinate in metres.
|-
| <code>z</code> || <code>number</code> || Impact Z coordinate in metres.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerRangedImpact", root, function(ownerPlayerId, targetPlayerId, projectileId, shotId, weaponType, damage, healthAfter, killed, x, y, z)
outputDebugString(weaponType .. " impact at " .. x .. ", " .. y .. ", " .. z)
end)
</syntaxhighlight>

[[Category:Lua Events]]
[[Category:Server Events]]
[[Category:Ranged Events]]

OnPlayerRangedImpact - Revision history

QCherry: Update Lua event reference