KSLCore/ksl.modeling.guidedpath/TransporterState

TransporterState

enum TransporterState : Enum<TransporterState> (source)

What a transporter is doing.

The states divide into those that involve an entity and those that do not, and blocking can happen from either side: a transporter returning to its home base with nothing aboard can be blocked just as a loaded one can. That is why blocking remembers what was interrupted rather than inferring it from whether an entity is present.

Entries

IDLE

Allocated to no one and going nowhere. Still occupying its zones.

MOVING_EMPTY

Travelling without an entity aboard, to collect one.

MOVING_LOADED

Travelling with an entity aboard.

An entity is being loaded.

UNLOADING

An entity is being unloaded.

RETURNING_HOME

Travelling to a home base or staging area, allocated to no one.

TOWED

Being moved by something other than itself -- pushed or towed off the guide path by a person.

BLOCKED

Unable to claim the next zone, and waiting for whoever holds it.

Properties

entries

val entries: EnumEntries<TransporterState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

valueOf

fun valueOf(value: String): TransporterState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<TransporterState>

Returns an array containing the constants of this enum type, in the order they're declared.