CompletePlayerConsumableFinalize - Revision history

QCherry: Clarify GothicRP consumable persistence ownership

2026-09-08T14:06:37Z

Clarify GothicRP consumable persistence ownership

← Older revision		Revision as of 14:06, 8 September 2026
Line 43:		Line 43:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* This is an ~~advanced~~ transaction-completion function ~~intended for~~ the resource ~~that owns the authoritative inventory workflow~~.		* This is an internal transaction-completion capability for the bundled <code>gothic_rp</code> persistence workflow, not a general gameplay function.
			* The runtime accepts this call only when the calling resource is named exactly <code>gothic_rp</code>; every other resource receives <code>false</code>.
	* The player, sequence, generation and commit key must all match the pending operation.		* The player, sequence, generation and commit key must all match the pending operation.
	* Call it only after the final persistence result is known; it does not play an animation or apply a consumable effect by itself.		* Call it only after the final persistence result is known; it does not play an animation or apply a consumable effect by itself.

QCherry: Document Lua APIs available or improved from G1R:MP 0.1.2

2026-09-03T18:39:52Z

Document Lua APIs available or improved from G1R:MP 0.1.2

← Older revision		Revision as of 18:39, 3 September 2026
Line 1:		Line 1:
	= completePlayerConsumableFinalize =		= completePlayerConsumableFinalize =
	<div style="background:#~~0b0b0b~~; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#~~f1f1f1~~; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">		<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:#~~ff5a5a~~; font-weight:bold; letter-spacing:0.04em;">~~COMING IN~~ UPDATE 0.1.2</div>		<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.2</div>
	<div style="color:#~~f1f1f1~~; margin-top:0.25rem;">This function is ~~documented~~ in ~~advance~~ and ~~is not yet available~~ in ~~the current public release~~.</div>		<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>

QCherry: Document Lua functions planned for G1R:MP update 0.1.2

2026-09-02T17:32:44Z

Document Lua functions planned for G1R:MP update 0.1.2

New page

= completePlayerConsumableFinalize =
<div style="background:#0b0b0b; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#f1f1f1; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">
<div style="color:#ff5a5a; font-weight:bold; letter-spacing:0.04em;">COMING IN UPDATE 0.1.2</div>
<div style="color:#f1f1f1; margin-top:0.25rem;">This function is documented in advance and is not yet available in the current public release.</div>
</div>

Completes or rejects the persistence-finalization stage of a pending authoritative consumable operation.

== Syntax ==
<syntaxhighlight lang="lua">
bool completePlayerConsumableFinalize(int playerId, int sequence, int generation, string commitKey, bool committed)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|-
| <code>sequence</code> || <code>int</code> || yes || The positive consumable-use sequence received by the resource.
|-
| <code>generation</code> || <code>int</code> || yes || The positive session generation supplied for this finalization request.
|-
| <code>commitKey</code> || <code>string</code> || yes || The non-empty commit key supplied for the same pending operation; maximum 96 bytes.
|-
| <code>committed</code> || <code>bool</code> || yes || True after final persistence succeeded, or false after it was rejected or rolled back.
|}

== Returns ==
Returns <code>true</code> only when the matching pending finalization is accepted; otherwise returns <code>false</code>.

== Examples ==
Confirm a persisted consumable finalization:
<syntaxhighlight lang="lua" line>
local accepted = completePlayerConsumableFinalize(
playerId, sequence, generation, commitKey, true
)
if not accepted then
outputDebugString("Consumable finalization acknowledgement was rejected", 1)
end
</syntaxhighlight>

== 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, generation and commit key must all match the pending operation.
* Call it only after the final persistence result is known; it does not play an animation or apply a consumable effect by itself.

[[Category:Lua Functions]]
[[Category:Server Functions]]
[[Category:Inventory Functions]]