StartTimeLoopEventSchema

@Serializable
@SerialName(value = "StartTimeLoop")
data class StartTimeLoopEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val timeData: StartTimeLoopEventSchema.TimeData) : EventSchema

Starts an endless loop in a coroutine launched from the running event's context, firing once per period. TimeData sets the period and its unit: Milliseconds or Seconds. The first fire happens after the first delay, not immediately.

The event returns as soon as the loop is launched, so the chain continues while it keeps running. The loop runs forever by design: to be able to stop it, launch it from inside a RunCancellableEvents and cancel that id with CancelEvents.

incomingData consumed: not used.

Triggers fired:

  • OnTimeLoopEventTrigger — once per period, indefinitely. No data is passed downstream.

Neither success nor failure is reported.

Constructors

Link copied to clipboard

Types

Link copied to clipboard
@Serializable
sealed interface TimeData

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 = "timeData")
val timeData: StartTimeLoopEventSchema.TimeData
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.