KSLCore/ksl.animation/AnimationEvent/GuidedTransporterStateChanged

GuidedTransporterStateChanged

@Serializable

@SerialName(value = "GuidedTransporterStateChanged")

data class GuidedTransporterStateChanged(val simTime: Double, val transporterName: String, val networkName: String, val state: String, val spaceName: String? = null, val halted: Boolean = false, val awaitedZoneName: String? = null, val awaitedLinkName: String? = null, val blockReason: String? = null) : AnimationEvent(source)

A transporter changed what it is doing: travelling empty, carrying, returning, blocked, or idle. state is the transporter state's own name.

This is what lets a viewer tell the two kinds of stillness apart. A transporter parked with nothing to do and one stopped because the path ahead is taken look identical on a canvas, and they mean opposite things about the design.

Constructors

GuidedTransporterStateChanged

constructor(simTime: Double, transporterName: String, networkName: String, state: String, spaceName: String? = null, halted: Boolean = false, awaitedZoneName: String? = null, awaitedLinkName: String? = null, blockReason: String? = null)

Properties

awaitedLinkName

val awaitedLinkName: String?

While BLOCKED on a link rather than a zone, the link.

awaitedZoneName

val awaitedZoneName: String?

While BLOCKED, the zone it is waiting to enter.

blockReason

val blockReason: String?

While BLOCKED, why: ZONE (another vehicle holds it), CLOSURE (a closure holds or is draining it), DIRECTION_LOCK (a two-way link is in use the other way) or SPUR_RESERVATION (another vehicle has reserved the spur).

halted

val halted: Boolean

True when the transporter was stopped by something outside it (a breakdown, a flat battery, a gate) rather than being idle; the state then reads IDLE.

networkName

val networkName: String

simTime

open override val simTime: Double

spaceName

val spaceName: String?

state

val state: String

transporterName

val transporterName: String