Class: RandomAnimationState

RandomAnimationState(optionsopt, subStatesopt)

Class for playing random animations at random intervals within this state.

Constructor

new RandomAnimationState(optionsopt, subStatesopt)

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

Options for the container state.

Properties
Name Type Attributes Default Description
playInterval number <optional>
 3

The base animation playback interval.
subStates Array.<AbstractState> <optional>
 []

states to be randomly picked to play
Implements:

Extends

Members

(readonly) internalWeight :number

Gets the internal weight.

Type:
  • number
Overrides:

paused :number

Gets whether or not the state is currently paused.

Type:
  • number
Overrides:
Implements:

playInterval :float

Gets and sets the base animation play interval

Type:
  • float

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()

Discard the transition state.

Overrides:
Implements:

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

playRandomAnimation(onErroropt)

Pick a random animation and utilize AnimationPlayerInterface to play that animation

Parameters:
Name Type Attributes Description
onError function <optional>

Function to execute if the state encounters
an error during playback.

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:
Implements:

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: