VesselActionDefinition
Defined in: packages/protocol/src/lib/vessel.ts:225
Author-facing shape for a VesselAction. See VesselDefinition.
Properties
Section titled “Properties”description
Section titled “description”
readonlydescription:string
Defined in: packages/protocol/src/lib/vessel.ts:227
idempotent?
Section titled “idempotent?”
readonlyoptionalidempotent?:boolean
Defined in: packages/protocol/src/lib/vessel.ts:240
Whether re-running this Action with the same parameters leaves the Vessel
in the state a single run would. The Engine may re-emit an Action on a
turn triggered by nothing but a chart resize, and it cannot see Vessel
contents to tell a first run from a repeat; such a turn admits only
actions marked true that the model invoked with no parameters, since a
parameter value there could only have come from an earlier turn. Omit the
flag for anything that appends, removes, or otherwise accumulates.
Defaults to false.
readonlyname:string
Defined in: packages/protocol/src/lib/vessel.ts:226
parameters?
Section titled “parameters?”
readonlyoptionalparameters?: readonlyobject[]
Defined in: packages/protocol/src/lib/vessel.ts:228
transitionsTo?
Section titled “transitionsTo?”
readonlyoptionaltransitionsTo?:string
Defined in: packages/protocol/src/lib/vessel.ts:229