Shortcut function for type safe argument transition. Data transition can be target-less (self-targeted), it is useful to update DataState data Note that transition must be TransitionType.EXTERNAL to update data.

dataTransitionOn

inline fun <E : DataEvent<D>, D : Any> TransitionStateApi.dataTransitionOn(name: String? = null, block: DataGuardedTransitionOnBuilder<E, D>.() -> Unit): Transition<E>

Data transition, otherwise same as transitionOn

findTransition

inline fun <E : Event> TransitionStateApi.findTransition(): Transition<E>?

Find transition by Event type. This might be used to start listening to transition after state machine setup.

fun TransitionStateApi.findTransition(name: String): Transition<*>?

Find transition by name. This might be used to start listening to transition after state machine setup.

requireTransition

inline fun <E : Event> TransitionStateApi.requireTransition(): Transition<E>

Require transition by Event type

fun TransitionStateApi.requireTransition(name: String): Transition<*>

transition

inline fun <E : Event> TransitionStateApi.transition(name: String? = null, block: UnitGuardedTransitionBuilder<E>.() -> Unit): Transition<E>

Creates transition. You can specify guard function. Such guarded transition is triggered only when guard function returns true.

inline fun <E : Event> TransitionStateApi.transition(name: String? = null, targetState: State? = null, type: TransitionType = LOCAL, metaInfo: MetaInfo? = null): Transition<E>

Shortcut overload for transition with an optional target state

transitionConditionally

inline fun <E : Event> TransitionStateApi.transitionConditionally(name: String? = null, block: ConditionalTransitionBuilder<E>.() -> Unit): Transition<E>

Creates conditional transition. Caller should specify lambda which calculates TransitionDirection. For example target state may be different depending on some condition.

transitionOn

inline fun <E : Event> TransitionStateApi.transitionOn(name: String? = null, block: UnitGuardedTransitionOnBuilder<E>.() -> Unit): Transition<E>

This is more powerful version of transition function. Here target state is a lambda which returns desired State. This allows to use lateinit state variables for recursively depending states and choose target state depending on application business logic.