Class: AbstractState

(abstract) AbstractState(optionsopt)

Base class for a state in our animation system.

Constructor

(abstract) new AbstractState(optionsopt)

Parameters:
Name Type Attributes Description
options Object <optional>

Options for the animation state.

Properties
Name Type Attributes Default Description
name string <optional>

Name for the animation state. Names must be
unique for the container the state is applied to and should be validated at
the container level. If no name is given it will default to the constructor
name.
weight weight <optional>
 0

The 0-1 amount of influence the state will have.

Members

(readonly) internalWeight :number

Gets the internal weight.

Type:
  • number

paused :number

Gets whether or not the state is currently paused.

Type:
  • number

weight :number

Gets and sets the user defined weight.

Type:
  • number

(readonly) weightPending :boolean

Gets whether or not the weight is currently being animated.

Type:
  • boolean

Methods

cancel() → {boolean}

Cancel playback of the state and cancel any pending promises.

Returns:
Type
boolean

deactivate()

Force the internal weight to 0. Should be called before switching or transitioning
to a new state.

discard()

Cancel any pending promises and remove reference to them.

pause() → {boolean}

Pause playback of the state. This prevents pending promises from being executed.

Returns:
Type
boolean

play(onFinishopt, onErroropt, onCancelopt) → {Deferred}

Start playback of the state from the beginning.

Parameters:
Name Type Attributes Description
onFinish function <optional>

Function to execute when the state finishes.
onError function <optional>

Function to execute if the state encounters
an error during playback.
onCancel function <optional>

Function to execute if playback is canceled.
Returns:
Type
Deferred

resume(onFinishopt, onErroropt, onCancelopt) → {Deferred}

Resume playback of the state.

Parameters:
Name Type Attributes Description
onFinish function <optional>

Function to execute when the state finishes.
onError function <optional>

Function to execute if the state encounters
an error during playback.
onCancel function <optional>

Function to execute if playback is canceled.
Returns:
Type
Deferred

setWeight(weight, secondsopt, easingFnopt) → {Deferred}

Updates the user defined weight over time.

Parameters:
Name Type Attributes Default Description
weight number

The target weight value.
seconds number <optional>
 0

The amount of time it will take to reach the
target weight.
easingFn function <optional>

The easing function to use for interpolation.
Returns:
Type
Deferred

stop() → {boolean}

Stop playback of the state and resolve any pending promises.

Returns:
Type
boolean

update(deltaTime)

Update any values that need to be evaluated every frame.

Parameters:
Name Type Description
deltaTime number

Time in milliseconds since the last update.

updateInternalWeight(factor)

Multiplies the user weight by a factor to determine the internal weight.

Parameters:
Name Type Description
factor number

0-1 multiplier to apply to the user weight.