BGE/Tweens - Documentation

Methods

(static) BounceEaseIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 680

(static) BounceEaseInOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 702

(static) BounceEaseOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 691

(static) BounceEaseOutIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 713

(static) BounceTween(start, finish, currentTime, duration) → {float}

Bounce

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 669

(static) ChangeTweenDest(tween_data, dest_data) → {dynamic}

Parameters:

Name	Type	Description
`tween_data`	object
`dest_data`	object

Source:

utils/tweens.bs, line 45

(static) CircularEaseIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 494

(static) CircularEaseInOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 516

(static) CircularEaseOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 505

(static) CircularEaseOutIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 527

(static) CircularTween(start, finish, currentTime, duration) → {float}

Circular

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 483

(static) CreateTweenObject(start_data, dest_data, duration, tween) → {object}

Parameters:

Name	Type	Description
`start_data`	object
`dest_data`	object
`duration`	integer
`tween`	string

Source:

utils/tweens.bs, line 20

(static) CubicEaseIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 204

(static) CubicEaseInOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 226

(static) CubicEaseOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 215

(static) CubicEaseOutIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 237

(static) CubicTween(start, finish, currentTime, duration) → {float}

Cubic

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 193

(static) ElasticEaseIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {float}

Parameters:

Name	Type	Attributes	Default
`start`	float
`finish`	float
`currentTime`	float
`duration`	float
`amplitude`	dynamic	<optional>	invalid
`period`	dynamic	<optional>	invalid

Source:

utils/tweens.bs, line 554

(static) ElasticEaseInOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {float}

Parameters:

Name	Type	Attributes	Default
`start`	float
`finish`	float
`currentTime`	float
`duration`	float
`amplitude`	dynamic	<optional>	invalid
`period`	dynamic	<optional>	invalid

Source:

utils/tweens.bs, line 580

(static) ElasticEaseOut(start, finish, currentTime, duration, amplitudeopt, periodopt) → {float}

Parameters:

Name	Type	Attributes	Default
`start`	float
`finish`	float
`currentTime`	float
`duration`	float
`amplitude`	dynamic	<optional>	invalid
`period`	dynamic	<optional>	invalid

Source:

utils/tweens.bs, line 567

(static) ElasticEaseOutIn(start, finish, currentTime, duration, amplitudeopt, periodopt) → {float}

Parameters:

Name	Type	Attributes	Default
`start`	float
`finish`	float
`currentTime`	float
`duration`	float
`amplitude`	dynamic	<optional>	invalid
`period`	dynamic	<optional>	invalid

Source:

utils/tweens.bs, line 593

(static) ElasticTween(start, finish, currentTime, duration) → {float}

Elastic

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 541

(static) ExponentialEaseIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 436

(static) ExponentialEaseInOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 458

(static) ExponentialEaseOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 447

(static) ExponentialEaseOutIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 469

(static) ExponentialTween(start, finish, currentTime, duration) → {float}

Exponential

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 425

(static) GetTweenObjectPercentState(tween_object) → {float}

Parameters:

Name	Type	Description
`tween_object`	object

Source:

utils/tweens.bs, line 28

(static) GetTweens() → {object}

Source:

utils/tweens.bs, line 52

(static) HandleTween(tween_data) → {boolean}

Parameters:

Name	Type	Description
`tween_data`	object

Source:

utils/tweens.bs, line 36

(static) LinearTween(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 63

(static) OvershootEaseIn(start, finish, currentTime, duration, overshootopt) → {float}

Parameters:

Name	Type	Attributes	Default
`start`	float
`finish`	float
`currentTime`	float
`duration`	float
`overshoot`	float	<optional>	1.70158

Source:

utils/tweens.bs, line 619

(static) OvershootEaseInOut(start, finish, currentTime, duration, overshootopt) → {float}

Parameters:

Name	Type	Attributes	Default
`start`	float
`finish`	float
`currentTime`	float
`duration`	float
`overshoot`	float	<optional>	1.70158

Source:

utils/tweens.bs, line 643

(static) OvershootEaseOut(start, finish, currentTime, duration, overshootopt) → {float}

Parameters:

Name	Type	Attributes	Default
`start`	float
`finish`	float
`currentTime`	float
`duration`	float
`overshoot`	float	<optional>	1.70158

Source:

utils/tweens.bs, line 631

(static) OvershootEaseOutIn(start, finish, currentTime, duration, overshootopt) → {float}

Parameters:

Name	Type	Attributes	Default
`start`	float
`finish`	float
`currentTime`	float
`duration`	float
`overshoot`	float	<optional>	1.70158

Source:

utils/tweens.bs, line 655

(static) OvershootTween(start, finish, currentTime, duration) → {float}

Overshoot

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 607

(static) QuadraticEaseIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 88

(static) QuadraticEaseInOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 110

(static) QuadraticEaseOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 99

(static) QuadraticEaseOutIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 121

(static) QuadraticTween(start, finish, currentTime, duration) → {float}

Quadratic

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 77

(static) QuarticEaseIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 262

(static) QuarticEaseInOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 284

(static) QuarticEaseOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 273

(static) QuarticEaseOutIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 295

(static) QuarticTween(start, finish, currentTime, duration) → {float}

Quartic

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 251

(static) QuinticEaseIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 320

(static) QuinticEaseInOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 342

(static) QuinticEaseOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 331

(static) QuinticEaseOutIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 353

(static) QuinticTween(start, finish, currentTime, duration) → {float}

Quintic

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 309

(static) SinusoidalEaseIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 378

(static) SinusoidalEaseInOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 400

(static) SinusoidalEaseOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 389

(static) SinusoidalEaseOutIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 411

(static) SinusoidalTween(start, finish, currentTime, duration) → {float}

Sinusoidal

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 367

(static) SquareEaseIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 146

(static) SquareEaseInOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 168

(static) SquareEaseOut(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 157

(static) SquareEaseOutIn(start, finish, currentTime, duration) → {float}

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 179

(static) SquareTween(start, finish, currentTime, duration) → {float}

Square

Parameters:

Name	Type	Description
`start`	float
`finish`	float
`currentTime`	float
`duration`	float

Source:

utils/tweens.bs, line 135