mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.event/CancelEventsEventSchema

CancelEventsEventSchema

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

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — when a running job was found under cancellableEventId and cancelled. No data is passed downstream.
OnFailureEventTrigger — when nothing is registered under cancellableEventId, either because it never ran or because its job already finished; a NoSuchElementException is passed as incomingData and the error is logged.

Constructors

CancelEventsEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, cancellableEventId: String)

Properties

cancellableEventId

@SerialName(value = "cancellableEventId")

val cancellableEventId: String

events

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

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

trigger

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