QCherry: Document stable consumable lifecycle callbacks for 0.1.3

2026-09-08T14:06:29Z

Document stable consumable lifecycle callbacks for 0.1.3

New page

= onPlayerConsumableDurablySettled =
<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 for a connected player after the consumable inventory removal and final authoritative progression snapshot are both durably committed.

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

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerConsumableDurablySettled(playerId, itemKey, inventoryItemId, sequence, generation, commitKey, quantityRemaining, health, maxHealth, mana, maxMana, appliedHealth, appliedMana, periodicTicks)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>playerId</code> || <code>int</code> || The player who used the consumable.
|-
| <code>itemKey</code> || <code>string</code> || The stable native inventory key of the consumable.
|-
| <code>inventoryItemId</code> || <code>int</code> || The native numeric consumable ID.
|-
| <code>sequence</code> || <code>int</code> || The positive client request sequence.
|-
| <code>generation</code> || <code>int</code> || The settlement generation that became durable.
|-
| <code>commitKey</code> || <code>string</code> || The opaque durable-operation key.
|-
| <code>quantityRemaining</code> || <code>int</code> || The final authoritative quantity remaining.
|-
| <code>health</code> || <code>number</code> || Authoritative health after the instant effect.
|-
| <code>maxHealth</code> || <code>number</code> || Authoritative maximum health.
|-
| <code>mana</code> || <code>number</code> || Authoritative mana after the instant effect.
|-
| <code>maxMana</code> || <code>number</code> || Authoritative maximum mana.
|-
| <code>appliedHealth</code> || <code>number</code> || The instant health change actually applied after clamping.
|-
| <code>appliedMana</code> || <code>number</code> || The instant mana change actually applied after clamping.
|-
| <code>periodicTicks</code> || <code>int</code> || The number of periodic ticks scheduled after settlement, or zero.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerConsumableDurablySettled", root, function(playerId, itemKey, inventoryItemId, sequence, generation, commitKey, quantityRemaining, health, maxHealth, mana, maxMana, appliedHealth, appliedMana, periodicTicks)
outputDebugString(itemKey .. " settled; remaining=" .. quantityRemaining .. ", hp=" .. health .. "/" .. maxHealth)
end)
</syntaxhighlight>

== Notes ==
* This read-only completion callback is part of the stable server-side Lua contract beginning with update 0.1.3.
* Inventory and instant progression changes are already authoritative and durable. Do not remove the item or apply the effect again.
* A late durable settlement can still be observed after the client has already received a persistence-timeout result; this event proves storage completion, not client receipt of an Accepted packet.
* Periodic restoration begins after this callback. Observe each non-zero applied tick with <code>onPlayerConsumableEffectTick</code>.
* Strength, dexterity, alcohol and swampweed are not repeated in this compact callback; query <code>getPlayerProgression</code> when those values are needed.

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

OnPlayerConsumableDurablySettled - Revision history

QCherry: Document stable consumable lifecycle callbacks for 0.1.3