Class: Animation

new Animation(options)

Parameters:

Name Type Description

options

object

Animation options

Properties

Name	Type	Attributes	Description
`duration`	number	<optional>	Duration of the animation in seconds
`curve`	function	<optional>	Curve function that takes a time between [0, 1] and returns a value between [0, 1]
`delay`	number	<optional>	The amount of delay before the animation starts
`onstop`	function	<optional>	Function that is fired when the animation is forcibly stopped
`onend`	function	<optional>	Function fired when the function completes successfully
`ontick`	function	<optional>	Function fired when the animation ticks every frame. Takes a number between [0, 1] for the animation's progress.
`World`	World	<optional>	World the animation should be bound to. If specified, the animation will use the world's timescale. If not, it will run independent of any world's timescale.

Source: other/Animation.js, line 125

Members

ease

A variety of built in ease functions to use for animations
See easings.net for animation types. All animation types except elastic and bounce are implemented.

Properties

Name	Type	Description
`ease.linear`	function
`ease.in.sine`	function
`ease.in.quadratic`	function
`ease.in.cubic`	function
`ease.in.quartic`	function
`ease.in.quintic`	function
`ease.in.exponential`	function
`ease.in.circular`	function
`ease.in.back`	function
`ease.out.sine`	function
`ease.out.quadratic`	function
`ease.out.cubic`	function
`ease.out.quartic`	function
`ease.out.quintic`	function
`ease.out.exponential`	function
`ease.out.circular`	function
`ease.out.back`	function
`ease.inOut.sine`	function
`ease.inOut.quadratic`	function
`ease.inOut.cubic`	function
`ease.inOut.quartic`	function
`ease.inOut.quintic`	function
`ease.inOut.exponential`	function
`ease.inOut.circular`	function
`ease.inOut.back`	function

Source: other/Animation.js, line 55

Example

Animation.ease.in.cubic // access the cubic ease in function

Methods

isRunning() → {boolean}

Gets if the animation is currently running. Running includes any delay that the animation may have.

Source: other/Animation.js, line 110

Returns:

If the animation is running

Type:: boolean

run() → {Promise}

Starts the animation

Source: other/Animation.js, line 138

Returns:

Resolves when the animation completes. Resolves to true if the animation finished, false if it was stopped before it finished.

Type:: Promise

stop()

Stops the animation before it finishes. Triggers onstop and resolves promises to false.

Source: other/Animation.js, line 173