Package-level declarations

Types

Link copied to clipboard
@Serializable
@SerialName(value = "CancelEvents")
data class CancelEventsEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val cancellableEventId: String) : EventSchema

Cancels the coroutine job registered in the client's CancellableEventsHolder under cancellableEventId, stopping whatever RunCancellableEvents started with that id.

Link copied to clipboard
@Serializable
@SerialName(value = "RunCancellableEvents")
data class RunCancellableEventsEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val cancellableEventId: String) : EventSchema

Runs this event's own events list inside a cancellable job registered in the client's CancellableEventsHolder under cancellableEventId. A later CancelEvents carrying the same id stops the job mid-flight.

Link copied to clipboard
@Serializable
@SerialName(value = "RunEvents")
data class RunEventsEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?) : EventSchema

Runs this event's own events list inline, in order, each receiving this event's incomingData. It is the way to fan a single trigger out into several events, or to group events for reuse.

Link copied to clipboard
@Serializable
@SerialName(value = "TriggerEvent")
data class TriggerEventEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val eventId: String) : EventSchema

Looks up the event registered on the screen under eventId and runs it inline, letting one event chain re-use another that lives on a different tile.

Link copied to clipboard
@Serializable
@SerialName(value = "UpdateEvents")
data class UpdateEventsEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val updates: SerializableImmutableList<UpdateEventsEventSchema.Update>) : EventSchema

Patches events that are already registered on the screen. Each Update targets an event by Update.eventId and merges Update.data into it, the same way UpdateTiles patches a tile, so a chain can rewrite another event's parameters before it runs.