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)

[description]

Parameters:
Name Type Description
config object

[description]

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

[description]

Type
array

<static> GetTweens(config)

[description]

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)

[description]

Parameters:
Name Type Description
key string

[description]

propertyValue *

[description]

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

[description]

Type
function

<static> NumberTweenBuilder(parent, config, defaults)

[description]

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

[description]

config object

[description]

defaults Phaser.Tweens.TweenConfigDefaults

[description]

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

[description]

Type
Phaser.Tweens.Tween

<static> TimelineBuilder(manager, config)

[description]

Parameters:
Name Type Description
manager Phaser.Tweens.TweenManager

[description]

config object

[description]

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

[description]

Type
Phaser.Tweens.Timeline

<static> TweenBuilder(parent, config, defaults)

[description]

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

[description]

config object

[description]

defaults Phaser.Tweens.TweenConfigDefaults

[description]

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

[description]

Type
Phaser.Tweens.Tween