API Documentation for: 1.1.2
Show:

StateEvent Class

Defined in: StateEvent:8
Namespace: cloudkid

A state-related event used by the State Manager

Constructor

StateEvent

(
  • type
  • currentState
  • visibleState
)

Defined in StateEvent:8

Parameters:

  • type String

    See createjs.Event

  • currentState BaseState

    The currentState of the state manager

  • visibleState BaseState

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

Methods

initialize

(
  • type
  • currentState
  • visibleState
)

Defined in initialize:86

Initialize the event

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

Properties

currentState

BaseState

Defined in currentState:66

A reference to the current state of the state manager

type

String

Defined in type:80

visibleState

BaseState

Defined in visibleState:73

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

Events

onHidden

String

Defined in onHidden:59

When the state becomes hidden

onTransitionStateIn

Defined in onTransitionStateIn:24

The name of the event for when the state starts transitioning in

onTransitionStateInDone

String

Defined in onTransitionStateInDone:31

The name of the event for when the state finishes transition in

onTransitionStateOut

String

Defined in onTransitionStateOut:38

The name of the event for when the state starts transitioning out

onTransitionStateOutDone

String

Defined in onTransitionStateOutDone:45

The name of the event for when the state is done transitioning out

onVisible

String

Defined in onVisible:52

When the state besome visible