Brighterscript Game Engine

BGE/Tweens

Alias: BGE.Tweens

Static Methods

CreateTweenObject( start_data: roAssociativeArray, dest_data: roAssociativeArray, duration: integer, tween: Easing, ): TweenObject

static

Parameters

  • start_data (roAssociativeArray)
  • dest_data (roAssociativeArray)
  • duration (integer)
  • tween (Easing)

Returns

GetTweenObjectPercentState(tween_object: TweenObject): float

static

Parameters

Returns

  • float

HandleTween(tween_data: TweenObject): boolean

static

Parameters

Returns

  • boolean

ChangeTweenDest( tween_data: TweenObject, dest_data: roAssociativeArray, ): dynamic

static

Parameters

  • tween_data (TweenObject)
  • dest_data (roAssociativeArray)

Returns

  • dynamic

GetTweens(): object

static

Returns

  • object

LinearTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SphericalTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuadraticTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Quadratic

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuadraticEaseIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuadraticEaseOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuadraticEaseInOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuadraticEaseOutIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SquareTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Square

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SquareEaseIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SquareEaseOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SquareEaseInOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SquareEaseOutIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CubicTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Cubic

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CubicEaseIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CubicEaseOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CubicEaseInOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CubicEaseOutIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuarticTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Quartic

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuarticEaseIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuarticEaseOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuarticEaseInOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuarticEaseOutIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuinticTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Quintic

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuinticEaseIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuinticEaseOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuinticEaseInOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

QuinticEaseOutIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SinusoidalTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Sinusoidal

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SinusoidalEaseIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SinusoidalEaseOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SinusoidalEaseInOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

SinusoidalEaseOutIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

ExponentialTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Exponential

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

ExponentialEaseIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

ExponentialEaseOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

ExponentialEaseInOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

ExponentialEaseOutIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CircularTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Circular

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CircularEaseIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CircularEaseOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CircularEaseInOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

CircularEaseOutIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

ElasticTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Elastic

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

ElasticEaseIn( start: float, finish: float, currentTime: float, duration: float, amplitude?: dynamic, period?: dynamic, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)
  • amplitude (dynamic, optional, default: "invalid")
  • period (dynamic, optional, default: "invalid")

Returns

  • float

ElasticEaseOut( start: float, finish: float, currentTime: float, duration: float, amplitude?: dynamic, period?: dynamic, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)
  • amplitude (dynamic, optional, default: "invalid")
  • period (dynamic, optional, default: "invalid")

Returns

  • float

ElasticEaseInOut( start: float, finish: float, currentTime: float, duration: float, amplitude?: dynamic, period?: dynamic, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)
  • amplitude (dynamic, optional, default: "invalid")
  • period (dynamic, optional, default: "invalid")

Returns

  • float

ElasticEaseOutIn( start: float, finish: float, currentTime: float, duration: float, amplitude?: dynamic, period?: dynamic, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)
  • amplitude (dynamic, optional, default: "invalid")
  • period (dynamic, optional, default: "invalid")

Returns

  • float

OvershootTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Overshoot

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

OvershootEaseIn( start: float, finish: float, currentTime: float, duration: float, overshoot?: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)
  • overshoot (float, optional, default: 1.70158)

Returns

  • float

OvershootEaseOut( start: float, finish: float, currentTime: float, duration: float, overshoot?: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)
  • overshoot (float, optional, default: 1.70158)

Returns

  • float

OvershootEaseInOut( start: float, finish: float, currentTime: float, duration: float, overshoot?: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)
  • overshoot (float, optional, default: 1.70158)

Returns

  • float

OvershootEaseOutIn( start: float, finish: float, currentTime: float, duration: float, overshoot?: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)
  • overshoot (float, optional, default: 1.70158)

Returns

  • float

BounceTween( start: float, finish: float, currentTime: float, duration: float, ): float

static

Bounce

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

BounceEaseIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

BounceEaseOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

BounceEaseInOut( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

BounceEaseOutIn( start: float, finish: float, currentTime: float, duration: float, ): float

static

Parameters

  • start (float)
  • finish (float)
  • currentTime (float)
  • duration (float)

Returns

  • float

Enums

BGE.Tweens.Easing

enumstaticreadonly

Every named easing function GetTweens() exposes, as a validated enum instead of a bare string - a typo in a string easing name used to be a runtime crash on an invalid array index rather than a compile-time error. Each value is exactly its own GetTweens() key, so there is no translation layer: m.tweens[someEasingEnumValue] just works.

Properties

  • LinearTween (default: "LinearTween")
  • QuadraticTween (default: "QuadraticTween")
  • QuadraticEaseIn (default: "QuadraticEaseIn")
  • QuadraticEaseOut (default: "QuadraticEaseOut")
  • QuadraticEaseInOut (default: "QuadraticEaseInOut")
  • QuadraticEaseOutIn (default: "QuadraticEaseOutIn")
  • SquareTween (default: "SquareTween")
  • SquareEaseIn (default: "SquareEaseIn")
  • SquareEaseOut (default: "SquareEaseOut")
  • SquareEaseInOut (default: "SquareEaseInOut")
  • SquareEaseOutIn (default: "SquareEaseOutIn")
  • CubicTween (default: "CubicTween")
  • CubicEaseIn (default: "CubicEaseIn")
  • CubicEaseOut (default: "CubicEaseOut")
  • CubicEaseInOut (default: "CubicEaseInOut")
  • CubicEaseOutIn (default: "CubicEaseOutIn")
  • QuarticTween (default: "QuarticTween")
  • QuarticEaseIn (default: "QuarticEaseIn")
  • QuarticEaseOut (default: "QuarticEaseOut")
  • QuarticEaseInOut (default: "QuarticEaseInOut")
  • QuarticEaseOutIn (default: "QuarticEaseOutIn")
  • QuinticTween (default: "QuinticTween")
  • QuinticEaseIn (default: "QuinticEaseIn")
  • QuinticEaseOut (default: "QuinticEaseOut")
  • QuinticEaseInOut (default: "QuinticEaseInOut")
  • QuinticEaseOutIn (default: "QuinticEaseOutIn")
  • SinusoidalTween (default: "SinusoidalTween")
  • SinusoidalEaseIn (default: "SinusoidalEaseIn")
  • SinusoidalEaseOut (default: "SinusoidalEaseOut")
  • SinusoidalEaseInOut (default: "SinusoidalEaseInOut")
  • SinusoidalEaseOutIn (default: "SinusoidalEaseOutIn")
  • ExponentialTween (default: "ExponentialTween")
  • ExponentialEaseIn (default: "ExponentialEaseIn")
  • ExponentialEaseOut (default: "ExponentialEaseOut")
  • ExponentialEaseInOut (default: "ExponentialEaseInOut")
  • ExponentialEaseOutIn (default: "ExponentialEaseOutIn")
  • CircularTween (default: "CircularTween")
  • CircularEaseIn (default: "CircularEaseIn")
  • CircularEaseOut (default: "CircularEaseOut")
  • CircularEaseInOut (default: "CircularEaseInOut")
  • CircularEaseOutIn (default: "CircularEaseOutIn")
  • ElasticTween (default: "ElasticTween")
  • ElasticEaseIn (default: "ElasticEaseIn")
  • ElasticEaseOut (default: "ElasticEaseOut")
  • ElasticEaseInOut (default: "ElasticEaseInOut")
  • ElasticEaseOutIn (default: "ElasticEaseOutIn")
  • OvershootTween (default: "OvershootTween")
  • OvershootEaseIn (default: "OvershootEaseIn")
  • OvershootEaseOut (default: "OvershootEaseOut")
  • OvershootEaseInOut (default: "OvershootEaseInOut")
  • OvershootEaseOutIn (default: "OvershootEaseOutIn")
  • BounceTween (default: "BounceTween")
  • BounceEaseIn (default: "BounceEaseIn")
  • BounceEaseOut (default: "BounceEaseOut")
  • BounceEaseInOut (default: "BounceEaseInOut")
  • BounceEaseOutIn (default: "BounceEaseOutIn")
  • SphericalTween (default: "SphericalTween")

BGE.Tweens.TweenLoopMode

enumstaticreadonly

How a managed BGE.TweenManager tween behaves once it reaches its destination.

Properties

  • none (default: "none") — Retire the tween once it reaches its destination (the default).
  • restart (default: "restart") — Jump back to the start value and run the same tween again.
  • pingPong (default: "pingPong") — Reverse direction each time it finishes, alternating endpoints indefinitely.

Other

TweenObject

static

A live tween's start/current/dest values and progress state, as returned by CreateTweenObject() and consumed by HandleTween()/ChangeTweenDest()/ GetTweenObjectPercentState() - and, wrapped one per managed tween, by BGE.TweenManager.

Properties

  • start (roAssociativeArray)
  • current (roAssociativeArray)
  • dest (roAssociativeArray)
  • duration (integer)
  • timer (BGE.GameTimer)
  • tween (Easing)