UpdateEventsEventSchema

@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.

All updates are attempted; a failure in one does not stop the others.

incomingData consumed: not used.

Triggers fired:

  • OnSuccessEventTrigger — when every update was applied. No data is passed downstream.

  • OnFailureEventTrigger — when at least one update failed, typically because no event carries that id. Fired once at the end, after all updates were attempted, with no data attached.

Constructors

Types

Link copied to clipboard
@Serializable
data class Update(val eventId: String, val data: Map<String, AnySerializable?>)

Properties

Link copied to clipboard
@SerialName(value = "events")
open override val events: SerializableImmutableList<EventSchema>?

This event's own children — each declaring, via its own trigger, which of this event's outgoing triggers runs it. null when this event declares no children.

Link copied to clipboard
@SerialName(value = "id")
open override val id: String

Unique identifier — how TriggerEvent/UpdateEvents address this event by id. Defaults to a random id when omitted from the DSL.

Link copied to clipboard
@SerialName(value = "trigger")
open override val trigger: EventTrigger

The condition that must occur for this event to run — matched by structural equality (data class/data object equality) against whatever trigger value fired, never by any kind of subscription or listener registry.

Link copied to clipboard