Namespace: Builders

Phaser.Tweens. Builders

Methods


<static> GetBoolean(source, key, defaultValue)

Retrieves the value of the given key from an object.

Parameters:
Name Type Description
source object

The object to retrieve the value from.

key string

The key to look for in the source object.

defaultValue *

The default value to return if the key doesn't exist or if no source object is provided.

Since: 3.0.0
Source: src/tweens/builders/GetBoolean.js (Line 7)
Returns:

The retrieved value.

Type
*

<static> GetEaseFunction(ease, easeParams)

[description]

Parameters:
Name Type Description
ease string | function

[description]

easeParams array

[description]

Since: 3.0.0
Source: src/tweens/builders/GetEaseFunction.js (Line 9)
Returns:

[description]

Type
function

<static> GetNewValue(source, key, defaultValue)

[description]

Parameters:
Name Type Description
source object

[description]

key string

[description]

defaultValue *

[description]

Since: 3.0.0
Source: src/tweens/builders/GetNewValue.js (Line 7)
Returns:

[description]

Type
function

<static> GetProps(config)

[description]

Parameters:
Name Type Description
config object

The configuration object of the tween to get the target(s) from.

Since: 3.0.0
Source: src/tweens/builders/GetProps.js (Line 9)
Returns:

An array of all the targets the tween is operating on.

Type
array

<static> GetTargets(config)

Extracts an array of targets from a Tween configuration object.

The targets will be looked for in a targets property. If it's a function, its return value will be used as the result.

Parameters:
Name Type Description
config object

The configuration object to use.

Since: 3.0.0
Source: src/tweens/builders/GetTargets.js (Line 9)
Returns:

An array of targets (may contain only one element), or null if no targets were specified.

Type
array

<static> GetTweens(config)

Returns an array of all tweens in the given config

Parameters:
Name Type Description
config object

[description]

Since: 3.0.0
Source: src/tweens/builders/GetTweens.js (Line 9)
Returns:

[description]

Type
array

<static> GetValueOp(key, propertyValue)

Returns getStart and getEnd functions for a Tween's Data based on a target property and end value.

If the end value is a number, it will be treated as an absolute value and the property will be tweened to it. A string can be provided to specify a relative end value which consists of an operation (+= to add to the current value, -= to subtract from the current value, *= to multiply the current value, or /= to divide the current value) followed by its operand. A function can be provided to allow greater control over the end value; it will receive the target object being tweened, the name of the property being tweened, and the current value of the property as its arguments. If both the starting and the ending values need to be controlled, an object with getStart and getEnd callbacks, which will receive the same arguments, can be provided instead. If an object with a value property is provided, the property will be used as the effective value under the same rules described here.

Parameters:
Name Type Description
key string

The name of the property to modify.

propertyValue *

The ending value of the property, as described above.

Since: 3.0.0
Source: src/tweens/builders/GetValueOp.js (Line 31)
Returns:

An array of two functions, getStart and getEnd, which return the starting and the ending value of the property based on the provided value.

Type
function

<static> NumberTweenBuilder(parent, config, defaults)

Creates a new Number Tween.

Parameters:
Name Type Description
parent Phaser.Tweens.TweenManager | Phaser.Tweens.Timeline

The owner of the new Tween.

config Phaser.Types.Tweens.NumberTweenBuilderConfig

Configuration for the new Tween.

defaults Phaser.Types.Tweens.TweenConfigDefaults

Tween configuration defaults.

Since: 3.0.0
Source: src/tweens/builders/NumberTweenBuilder.js (Line 17)
Returns:

The new tween.

Type
Phaser.Tweens.Tween

<static> TimelineBuilder(manager, config)

Builds a Timeline of Tweens based on a configuration object.

Parameters:
Name Type Description
manager Phaser.Tweens.TweenManager

The Tween Manager to which the Timeline will belong.

config Phaser.Types.Tweens.TimelineBuilderConfig

The configuration object for the Timeline.

Since: 3.0.0
Source: src/tweens/builders/TimelineBuilder.js (Line 19)
Returns:

The created Timeline.

Type
Phaser.Tweens.Timeline

<static> TweenBuilder(parent, config, defaults)

Creates a new Tween.

Parameters:
Name Type Description
parent Phaser.Tweens.TweenManager | Phaser.Tweens.Timeline

The owner of the new Tween.

config Phaser.Types.Tweens.TweenBuilderConfig | object

Configuration for the new Tween.

defaults Phaser.Types.Tweens.TweenConfigDefaults

Tween configuration defaults.

Since: 3.0.0
Source: src/tweens/builders/TweenBuilder.js (Line 19)
Returns:

The new tween.

Type
Phaser.Tweens.Tween