Class: QueueState

QueueState(optionsopt, queueStatesopt)

Class for playing an ordered array of animation states in sequence.

Constructor

new QueueState(optionsopt, queueStatesopt)

Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}

Options for the state.

Properties
Name Type Attributes Default Description
autoAdvance boolean <optional>
 true

Whether to autmatically advance
to the next state in the queue as each state completes.
queueStates Array.<AbstractState> <optional>
 []

Array of states to be played
in order.
Implements:
  • @AnimationPlayerInterface

Extends

Members

done

Gets whether the animation queue has reached the end.

(readonly) internalWeight :number

Gets the internal weight.

Type:
  • number
Overrides:

paused :number

Gets whether or not the state is currently paused.

Type:
  • number
Overrides:

weight :number

Gets and sets the user defined weight.

Type:
  • number
Overrides:

(readonly) weightPending :boolean

Gets whether or not the weight is currently being animated.

Type:
  • boolean
Overrides:

Methods

cancel() → {boolean}

Cancel playback of the state and cancel any pending promises.

Overrides:
Returns:
Type
boolean

deactivate()

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

Overrides:

discard()

Cancel any pending promises and remove reference to them.

Overrides:

next(onNextopt, wrapopt) → {Deferred}

Start the next animation in the queue.

Parameters:
Name Type Attributes Default Description
onNext function <optional>

Function to execute each time an animation completes
and the queue moves to the next animation.
wrap boolean <optional>
 false

Whether or not to start the queue from the
beginning again if the end has been reached.
Returns:
Type
Deferred

pause() → {boolean}

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

Overrides:
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.
Overrides:
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.
Overrides:
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.
Overrides:
Returns:
Type
Deferred

stop() → {boolean}

Stop playback of the state and resolve any pending promises.

Overrides:
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.
Overrides:

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.
Overrides: