CompletePlayerConsumableUse

completePlayerConsumableUse

COMING IN UPDATE 0.1.2

This function is documented in advance and is not yet available in the current public release.

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.