QCherry: Document stable consumable lifecycle callbacks for 0.1.3

2026-09-08T14:06:31Z

Document stable consumable lifecycle callbacks for 0.1.3

New page

= onPlayerConsumableEffectTick =
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.3</div>
<div style="color:#111111; margin-top:0.25rem;">This event is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.</div>
</div>

Triggered after a periodic consumable tick successfully changes authoritative health or mana.

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

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerConsumableEffectTick(playerId, inventoryItemId, sequence, appliedHealth, appliedMana, ticksRemaining)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>playerId</code> || <code>int</code> || The player receiving the periodic effect.
|-
| <code>inventoryItemId</code> || <code>int</code> || The native numeric consumable ID that created the effect.
|-
| <code>sequence</code> || <code>int</code> || The consumable-use sequence that created the effect.
|-
| <code>appliedHealth</code> || <code>number</code> || The health change actually applied by this tick after clamping.
|-
| <code>appliedMana</code> || <code>number</code> || The mana change actually applied by this tick after clamping.
|-
| <code>ticksRemaining</code> || <code>int</code> || The number of scheduled ticks remaining after this tick.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerConsumableEffectTick", root, function(playerId, inventoryItemId, sequence, appliedHealth, appliedMana, ticksRemaining)
outputDebugString("Consumable tick item=" .. inventoryItemId .. ", hp=" .. appliedHealth .. ", mana=" .. appliedMana)
end)
</syntaxhighlight>

== Notes ==
* This read-only effect callback is part of the stable server-side Lua contract beginning with update 0.1.3.
* The event is emitted only when at least one applied delta is non-zero. A scheduled tick clamped by full health or mana does not emit it.
* A failed authoritative progression write is retried and does not emit this callback until the tick succeeds.
* The values are already applied by the server. Do not apply them again from the handler.

[[Category:Lua Events]]
[[Category:Server Events]]
[[Category:Magic Events]]

OnPlayerConsumableEffectTick - Revision history

QCherry: Document stable consumable lifecycle callbacks for 0.1.3