receipt · command

Command receipt

Reports validation and owner completion for a typed command.

command.receipt
Stable ID
command.receipt
Owner
app.script-command-service
Authority
read_only
Timing
post_commit
Availability
active-session
Side effects
none
Determinism
ordered by engine-assigned receipt sequence
Introduced
1.0.0

Usage

Keep the receipt sequence and status as request evidence. Use post-commit events for completion; an accepted receipt is not authoritative completion.

Parameters

Returns

An immutable receipt record describing a submitted command and its current status.

Cost

Bounded by per-package command and queue limits; authoritative work occurs once through the fixed-tick owner.

Fields

IDTypeUnitsRequiredDescription
recorded_at_tickticksimulation-ticksyesCommitted simulation tick when the receipt was recorded.
request_sequenceunsigned-integernoneyesEngine-assigned command request sequence.
sequenceunsigned-integernoneyesEngine-assigned receipt sequence.
statusstringnoneyesSubmitted, accepted, rejected, completed, or failed.

Errors

Examples

local receipt = command.submit("command.actor.take-control", arguments, 1)
if receipt.status == "accepted" then
    -- Wait for the corresponding completion event.
end

API history

Related symbols

Project references