springroll.StateEvent Class

Defined in: springroll.StateEvent:9
Module: States

A state-related event used by the State Manager

Constructor

springroll.StateEvent

(
  • type
  • currentState
  • visibleState
)

Defined in springroll.StateEvent:9

Parameters:

  • type String

    The type of event.

  • currentState BaseState

    The currentState of the state manager

  • visibleState BaseState

    The current state being transitioned or changing visibility, default to currentState

currentState

BaseState

Defined in currentState:21

A reference to the current state of the state manager

type

String

Defined in type:35

visibleState

BaseState

Defined in visibleState:28

A reference to the state who's actually being transitioned or being changed

onHidden

String

Defined in onHidden:51

When the state becomes hidden

onVisible

String

Defined in onVisible:44

When the state besome visible