CompletePlayerConsumableUse: Difference between revisions
Jump to navigation
Jump to search
Document Lua functions planned for G1R:MP update 0.1.2 |
Document Lua APIs available or improved from G1R:MP 0.1.2 |
||
| Line 1: | Line 1: | ||
= completePlayerConsumableUse = | = completePlayerConsumableUse = | ||
<div style="background:# | <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:# | <div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.2</div> | ||
<div style="color:# | <div style="color:#111111; margin-top:0.25rem;">This function is available in G1R:MP 0.1.2 and later. The contract below includes the compatibility guarantees introduced in that update.</div> | ||
</div> | </div> | ||
Revision as of 18:39, 3 September 2026
completePlayerConsumableUse
AVAILABLE FROM UPDATE 0.1.2
This function is available in G1R:MP 0.1.2 and later. The contract below includes the compatibility guarantees introduced in that update.
Completes or rejects a pending authoritative consumable inventory commit after the resource has persisted its result.
Syntax
bool completePlayerConsumableUse(int playerId, int sequence, string commitKey, bool committed)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | The connected player identifier. |
sequence |
int |
yes | The positive consumable-use sequence received by the resource. |
commitKey |
string |
yes | The non-empty commit key supplied for the same pending operation; maximum 96 bytes. |
committed |
bool |
yes | True after the inventory mutation was committed, or false after it was rejected or rolled back. |
Returns
Returns true only when the matching pending completion is accepted; otherwise returns false.
Examples
Acknowledge a successfully persisted consumable use:
if not completePlayerConsumableUse(playerId, sequence, commitKey, true) then
outputDebugString("Consumable commit acknowledgement was rejected", 1)
end
Notes
- Available only in server-side resource scripts.
- This is an advanced transaction-completion function intended for the resource that owns the authoritative inventory workflow.
- The player, sequence and commit key must match the pending server operation. Reusing values from a different operation is rejected.
- Call it exactly once after the corresponding persistence result is known; do not use it to start a consumable animation or grant an effect.