Interface TransitionStateHookFn

Callable

• __call(transition: Transition, state: StateDeclaration): HookResult

• The signature for Transition State Hooks.

• The signature for Transition State Hooks.

  A function which hooks into a lifecycle event for a specific state.

  Transition State Hooks are callback functions that hook into the lifecycle events of specific states during a transition. As a transition runs, it may exit some states, retain (keep) states, and enter states. As each lifecycle event occurs, the hooks which are registered for the event and that state are called (in priority order).

  See:

  • IHookRegistry.onExit
  • IHookRegistry.onRetain
  • IHookRegistry.onEnter

  Parameters

  • transition Transition

    :

    the current Transition

  • state StateDeclaration

    :

    the StateObject that the hook is bound to

  Returns HookResult

  :

  a HookResult which may alter the transition

  ---