Class TweenRuntimeBehavior

RuntimeBehavior represents a behavior being used by a RuntimeObject.

Hierarchy (view full)

RuntimeBehavior
- TweenRuntimeBehavior

Index

Constructors

constructor

new TweenRuntimeBehavior(instanceContainer, behaviorData, owner): TweenRuntimeBehavior
Parameters
- instanceContainer: RuntimeInstanceContainer
  The instance container the behavior belongs to.
- behaviorData: BehaviorData
  The data to initialize the behavior
- owner: RuntimeObject
  The runtime object the behavior belongs to.
Returns TweenRuntimeBehavior
Overrides RuntimeBehavior.constructor
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:71

Properties

name

name: string

owner

owner: RuntimeObject

The object owning the behavior

type

type: string

Methods

activate

activate(enable): void
De/Activate the behavior
Parameters
- enable: boolean
  true to enable the behavior, false to disable it
Returns void
Inherited from RuntimeBehavior.activate
- Defined in GDJS/Runtime/runtimebehavior.ts:157

activated

activated(): boolean
Return true if the behavior is activated

Returns boolean
Inherited from RuntimeBehavior.activated
- Defined in GDJS/Runtime/runtimebehavior.ts:182

addColorEffectPropertyTween

addColorEffectPropertyTween(effectBehavior, identifier, toColorStr, effectName, propertyName, easing, duration, destroyObjectWhenFinished): void
Tween a color object effect property.
Parameters
- effectBehavior: any
  Only used by events can be set to null
- identifier: string
  Unique id to identify the tween
- toColorStr: string
  The target RGB color (format "128;200;255" with values between 0 and 255 for red, green and blue)
- effectName: string
  Effect name
- propertyName: string
  Property name
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1176

addNumberEffectPropertyTween

addNumberEffectPropertyTween(effectBehavior, identifier, toValue, effectName, propertyName, easing, duration, destroyObjectWhenFinished): void
Tween a numeric object effect property.
Parameters
- effectBehavior: any
  Only used by events can be set to null
- identifier: string
  Unique id to identify the tween
- toValue: number
  The targeted value
- effectName: string
  Effect name
- propertyName: string
  Property name
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1132

addObjectAngleTween

addObjectAngleTween(identifier, toAngle, easing, duration, destroyObjectWhenFinished): void
Tween an object angle.
Parameters
- identifier: string
  Unique id to identify the tween
- toAngle: number
  The target angle
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectAngleTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:560

addObjectAngleTween2

addObjectAngleTween2(identifier, toAngle, easing, duration, destroyObjectWhenFinished): void
Tween an object angle.
Parameters
- identifier: string
  Unique id to identify the tween
- toAngle: number
  The target angle
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:585

addObjectColorHSLTween

addObjectColorHSLTween(identifier, toHue, animateHue, toSaturation, toLightness, easing, duration, destroyObjectWhenFinished): void
Tween an object HSL color, with the "to" color given using HSL (H: any number, S and L: 0-100).
Parameters
- identifier: string
  Unique id to identify the tween
- toHue: number
  The target hue, or the same as the from color's hue if blank
- animateHue: boolean
  include hue in calculations, as can't set this to -1 as default to ignore
- toSaturation: number
  The target saturation, or the same as the from color's saturation if blank
- toLightness: number
  The target lightness, or the same as the from color's lightness if blank
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectColorHSLTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1371

addObjectColorHSLTween2

addObjectColorHSLTween2(identifier, toHue, animateHue, toSaturation, toLightness, easing, duration, destroyObjectWhenFinished): void
Tween an object HSL color, with the "to" color given using HSL (H: any number, S and L: 0-100).
Parameters
- identifier: string
  Unique id to identify the tween
- toHue: number
  The target hue, or the same as the from color's hue if blank
- animateHue: boolean
  include hue in calculations, as can't set this to -1 as default to ignore
- toSaturation: number
  The target saturation, or the same as the from color's saturation if blank
- toLightness: number
  The target lightness, or the same as the from color's lightness if blank
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1405

addObjectColorTween

addObjectColorTween(identifier, toColorStr, easing, duration, destroyObjectWhenFinished, useHSLColorTransition): void
Tween an object color.
Parameters
- identifier: string
  Unique id to identify the tween
- toColorStr: string
  The target RGB color (format "128;200;255" with values between 0 and 255 for red, green and blue)
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
- useHSLColorTransition: boolean
  Tween using HSL color mappings, rather than direct RGB line
Returns void
Deprecated
Use addObjectColorTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1244

addObjectColorTween2

addObjectColorTween2(identifier, toColorStr, easing, duration, destroyObjectWhenFinished, useHSLColorTransition?): void
Tween an object color.
Parameters
- identifier: string
  Unique id to identify the tween
- toColorStr: string
  The target RGB color (format "128;200;255" with values between 0 and 255 for red, green and blue)
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
- useHSLColorTransition: boolean = true
  Tween using HSL color mappings, rather than direct RGB line
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1272

addObjectDepthTween

addObjectDepthTween(identifier, toDepth, easing, duration, destroyObjectWhenFinished): void
Tween an object depth.
Parameters
- identifier: string
  Unique id to identify the tween
- toDepth: number
  The target depth
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectDepthTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1720

addObjectDepthTween2

addObjectDepthTween2(object3DBehavior, identifier, toDepth, easing, duration, destroyObjectWhenFinished): void
Tween an object depth.
Parameters
- object3DBehavior: any
  Only used by events can be set to null
- identifier: string
  Unique id to identify the tween
- toDepth: number
  The target depth
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1746

addObjectHeightTween

addObjectHeightTween(identifier, toHeight, easing, duration, destroyObjectWhenFinished): void
Tween an object height.
Parameters
- identifier: string
  Unique id to identify the tween
- toHeight: number
  The target height
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectHeightTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1648

addObjectHeightTween2

addObjectHeightTween2(identifier, toHeight, easing, duration, destroyObjectWhenFinished): void
Tween an object height.
Parameters
- identifier: string
  Unique id to identify the tween
- toHeight: number
  The target height
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1673

addObjectOpacityTween

addObjectOpacityTween(identifier, toOpacity, easing, duration, destroyObjectWhenFinished): void
Tween an object opacity.
Parameters
- identifier: string
  Unique id to identify the tween
- toOpacity: number
  The target opacity
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectOpacityTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1055

addObjectOpacityTween2

addObjectOpacityTween2(identifier, toOpacity, easing, duration, destroyObjectWhenFinished): void
Tween an object opacity.
Parameters
- identifier: string
  Unique id to identify the tween
- toOpacity: number
  The target opacity
- easing: string
  Easing function identifier
- duration: number
  Duration in second
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1080

addObjectPositionTween

addObjectPositionTween(identifier, toX, toY, easing, duration, destroyObjectWhenFinished): void
Tween an object position.
Parameters
- identifier: string
  Unique id to identify the tween
- toX: number
  The target X position
- toY: number
  The target Y position
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectPositionTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:261

addObjectPositionTween2

addObjectPositionTween2(identifier, toX, toY, easing, duration, destroyObjectWhenFinished): void
Tween an object position.
Parameters
- identifier: string
  Unique id to identify the tween
- toX: number
  The target X position
- toY: number
  The target Y position
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:289

addObjectPositionXTween

addObjectPositionXTween(identifier, toX, easing, duration, destroyObjectWhenFinished): void
Tween an object X position.
Parameters
- identifier: string
  Unique id to identify the tween
- toX: number
  The target X position
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectPositionXTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:339

addObjectPositionXTween2

addObjectPositionXTween2(identifier, toX, easing, duration, destroyObjectWhenFinished): void
Tween an object X position.
Parameters
- identifier: string
  Unique id to identify the tween
- toX: number
  The target X position
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:364

addObjectPositionYTween

addObjectPositionYTween(identifier, toY, easing, duration, destroyObjectWhenFinished): void
Tween an object Y position.
Parameters
- identifier: string
  Unique id to identify the tween
- toY: number
  The target Y position
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectPositionYTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:411

addObjectPositionYTween2

addObjectPositionYTween2(identifier, toY, easing, duration, destroyObjectWhenFinished): void
Tween an object Y position.
Parameters
- identifier: string
  Unique id to identify the tween
- toY: number
  The target Y position
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:436

addObjectPositionZTween

addObjectPositionZTween(identifier, toZ, easing, duration, destroyObjectWhenFinished): void
Tween an object Z position.
Parameters
- identifier: string
  Unique id to identify the tween
- toZ: number
  The target Z position
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectPositionZTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:483

addObjectPositionZTween2

addObjectPositionZTween2(object3DBehavior, identifier, toZ, easing, duration, destroyObjectWhenFinished): void
Tween an object Z position.
Parameters
- object3DBehavior: any
  Only used by events can be set to null
- identifier: string
  Unique id to identify the tween
- toZ: number
  The target Z position
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:509

addObjectRotationXTween

addObjectRotationXTween(object3DBehavior, identifier, toAngle, easing, duration, destroyObjectWhenFinished): void
Tween a 3D object rotation X.
Parameters
- object3DBehavior: any
  Only used by events can be set to null
- identifier: string
  Unique id to identify the tween
- toAngle: number
  The target angle
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:632

addObjectRotationYTween

addObjectRotationYTween(object3DBehavior, identifier, toAngle, easing, duration, destroyObjectWhenFinished): void
Tween a 3D object rotation Y.
Parameters
- object3DBehavior: any
  Only used by events can be set to null
- identifier: string
  Unique id to identify the tween
- toAngle: number
  The target angle
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:665

addObjectScaleTween

addObjectScaleTween(identifier, toScaleX, toScaleY, easing, duration, destroyObjectWhenFinished, scaleFromCenterOfObject): void
Tween an object scale.
Parameters
- identifier: string
  Unique id to identify the tween
- toScaleX: number
  The target X-scale
- toScaleY: number
  The target Y-scale
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
- scaleFromCenterOfObject: boolean
  Scale the transform from the center of the object (or point that is called center), not the top-left origin
Returns void
Deprecated
Use addObjectScaleTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:700

addObjectScaleTween2

addObjectScaleTween2(identifier, toScaleX, toScaleY, easing, duration, destroyObjectWhenFinished, scaleFromCenterOfObject): void
Tween an object scale.
Parameters
- identifier: string
  Unique id to identify the tween
- toScaleX: number
  The target X-scale
- toScaleY: number
  The target Y-scale
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
- scaleFromCenterOfObject: boolean
  Scale the transform from the center of the object (or point that is called center), not the top-left origin
Returns void
Deprecated
Use addObjectScaleXTween2 and addObjectScaleYTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:733

addObjectScaleTween3

addObjectScaleTween3(identifier, toScale, easing, duration, destroyObjectWhenFinished, scaleFromCenterOfObject): void
Tween an object scale.
Parameters
- identifier: string
  Unique id to identify the tween
- toScale: number
  The target scale
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
- scaleFromCenterOfObject: boolean
  Scale the transform from the center of the object (or point that is called center), not the top-left origin
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:807

addObjectScaleXTween

addObjectScaleXTween(identifier, toScaleX, easing, duration, destroyObjectWhenFinished, scaleFromCenterOfObject): void
Tween an object X-scale.
Parameters
- identifier: string
  Unique id to identify the tween
- toScaleX: number
  The target X-scale
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
- scaleFromCenterOfObject: boolean
  Scale the transform from the center of the object (or point that is called center), not the top-left origin
Returns void
Deprecated
Use addObjectScaleXTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:870

addObjectScaleXTween2

addObjectScaleXTween2(identifier, toScaleX, easing, duration, destroyObjectWhenFinished, scaleFromCenterOfObject): void
Tween an object X-scale.
Parameters
- identifier: string
  Unique id to identify the tween
- toScaleX: number
  The target X-scale
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
- scaleFromCenterOfObject: boolean
  Scale the transform from the center of the object (or point that is called center), not the top-left origin
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:899

addObjectScaleYTween

addObjectScaleYTween(identifier, toScaleY, easing, duration, destroyObjectWhenFinished, scaleFromCenterOfObject): void
Tween an object Y-scale.
Parameters
- identifier: string
  Unique id to identify the tween
- toScaleY: number
  The target Y-scale
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
- scaleFromCenterOfObject: boolean
  Scale the transform from the center of the object (or point that is called center), not the top-left origin
Returns void
Deprecated
Use addObjectScaleYTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:963

addObjectScaleYTween2

addObjectScaleYTween2(identifier, toScaleY, easing, duration, destroyObjectWhenFinished, scaleFromCenterOfObject): void
Tween an object Y-scale.
Parameters
- identifier: string
  Unique id to identify the tween
- toScaleY: number
  The target Y-scale
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
- scaleFromCenterOfObject: boolean
  Scale the transform from the center of the object (or point that is called center), not the top-left origin
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:992

addObjectWidthTween

addObjectWidthTween(identifier, toWidth, easing, duration, destroyObjectWhenFinished): void
Tween an object width.
Parameters
- identifier: string
  Unique id to identify the tween
- toWidth: number
  The target width
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addObjectWidthTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1576

addObjectWidthTween2

addObjectWidthTween2(identifier, toWidth, easing, duration, destroyObjectWhenFinished): void
Tween an object width.
Parameters
- identifier: string
  Unique id to identify the tween
- toWidth: number
  The target width
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1601

addTextObjectCharacterSizeTween

addTextObjectCharacterSizeTween(identifier, toSize, easing, duration, destroyObjectWhenFinished): void
Tween a text object character size.
Parameters
- identifier: string
  Unique id to identify the tween
- toSize: number
  The target character size
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addTextObjectCharacterSizeTween2 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1498

addTextObjectCharacterSizeTween2

addTextObjectCharacterSizeTween2(identifier, toSize, easing, duration, destroyObjectWhenFinished): void
Tween a text object character size.
Parameters
- identifier: string
  Unique id to identify the tween
- toSize: number
  The target character size
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1524

addValueTween

addValueTween(identifier, fromValue, toValue, easing, duration, useExponentialInterpolation, destroyObjectWhenFinished): void
Add an object value tween.
Parameters
- identifier: string
  Unique id to identify the tween
- fromValue: number
  Start value
- toValue: number
  End value
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- useExponentialInterpolation: boolean
  Set it to true to use a exponential It's useful for values that are factors like a scale or a zoom.
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:227

addVariableTween

addVariableTween(identifier, variable, fromValue, toValue, easing, duration, destroyObjectWhenFinished): void
Add an object variable tween.
Parameters
- identifier: string
  Unique id to identify the tween
- variable: Variable
  The object variable to store the tweened value
- fromValue: number
  Start value
- toValue: number
  End value
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addVariableTween3 instead. This function is misleading since one could think that the tween starts right at the moment this function is called whereas the value of the variable will change at the next frame only. Moreover, the variable will not start from the start value exactly since time will have passed at the moment the next frame is rendered. See https://github.com/4ian/GDevelop/issues/4270
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:112

addVariableTween2

addVariableTween2(identifier, variable, toValue, easing, duration, destroyObjectWhenFinished): void
Tween an object variable.
Parameters
- identifier: string
  Unique id to identify the tween
- variable: Variable
  The object variable to store the tweened value
- toValue: number
  End value
- easing: string
  Easing function identifier
- duration: number
  Duration in milliseconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
Deprecated
Use addVariableTween3 instead.
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:144

addVariableTween3

addVariableTween3(identifier, variable, toValue, easing, duration, destroyObjectWhenFinished): void
Tween an object variable.
Parameters
- identifier: string
  Unique id to identify the tween
- variable: Variable
  The object variable to store the tweened value
- toValue: number
  End value
- easing: string
  Easing function identifier
- duration: number
  Duration in seconds
- destroyObjectWhenFinished: boolean
  Destroy this object when the tween ends
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:172

doStepPostEvents

doStepPostEvents(instanceContainer): void
This method is called each tick after events are done.
Parameters
- instanceContainer: RuntimeInstanceContainer
  The instanceContainer owning the object
Returns void
Inherited from RuntimeBehavior.doStepPostEvents
- Defined in GDJS/Runtime/runtimebehavior.ts:207

doStepPreEvents

doStepPreEvents(instanceContainer): void
This method is called each tick before events are done.
Parameters
- instanceContainer: RuntimeInstanceContainer
  The instanceContainer owning the object
Returns void
Overrides RuntimeBehavior.doStepPreEvents
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:87

enableSynchronization

enableSynchronization(enable): void
Parameters
- enable: boolean
Returns void
Inherited from RuntimeBehavior.enableSynchronization
- Defined in GDJS/Runtime/runtimebehavior.ts:238

exists

exists(identifier): boolean
Tween exists.
Parameters
- identifier: string
  Unique id to identify the tween
Returns boolean
The tween exists
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1801

getName

getName(): string
Get the name of the behavior.

Returns string
The behavior's name.
Inherited from RuntimeBehavior.getName
- Defined in GDJS/Runtime/runtimebehavior.ts:105

getNameId

getNameId(): number
Get the name identifier of the behavior.

Returns number
The behavior's name identifier.
Inherited from RuntimeBehavior.getNameId
- Defined in GDJS/Runtime/runtimebehavior.ts:113

getNetworkSyncData

getNetworkSyncData(): BehaviorNetworkSyncData
Returns BehaviorNetworkSyncData
Inherited from RuntimeBehavior.getNetworkSyncData
- Defined in GDJS/Runtime/runtimebehavior.ts:80

getProgress

getProgress(identifier): number
Get tween progress.
Parameters
- identifier: string
  Unique id to identify the tween
Returns number
Progress of playing tween animation (between 0.0 and 1.0)
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1857

getValue

getValue(identifier): number
Get tween value.

It returns 0 for tweens with several values.
Parameters
- identifier: string
  Unique id to identify the tween
Returns number
Value of playing tween animation
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1869

hasFinished

hasFinished(identifier): boolean
Tween has finished.
Parameters
- identifier: string
  Unique id to identify the tween
Returns boolean
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1809

isPlaying

isPlaying(identifier): boolean
Tween is playing.
Parameters
- identifier: string
  Unique id to identify the tween
Returns boolean
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1792

isSyncedOverNetwork

isSyncedOverNetwork(): boolean
Returns boolean
Inherited from RuntimeBehavior.isSyncedOverNetwork
- Defined in GDJS/Runtime/runtimebehavior.ts:242

onActivate

onActivate(): void
Reimplement this method to do extra work when the behavior is activated (after it has been deactivated, see onDeActivate).

Returns void
Overrides RuntimeBehavior.onActivate
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1877

onCreated

onCreated(): void
Reimplement this to do extra work when the behavior is created (i.e: an object using it was created), after the object is fully initialized (so you can use this.owner without risk).

Returns void
Inherited from RuntimeBehavior.onCreated
- Defined in GDJS/Runtime/runtimebehavior.ts:177

onDeActivate

onDeActivate(): void
Reimplement this method to do extra work when the behavior is deactivated.

Returns void
Overrides RuntimeBehavior.onDeActivate
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1873

onDestroy

onDestroy(): void
This method is called when the owner of the behavior is being removed from the scene and is about to be destroyed/reused later or when the behavior is removed from an object (can happen in case of hot-reloading only. Otherwise, behaviors are just de-activated, not removed. See onDeActivate).

Returns void
Inherited from RuntimeBehavior.onDestroy
- Defined in GDJS/Runtime/runtimebehavior.ts:216

onObjectHotReloaded

onObjectHotReloaded(): void
This method is called when the owner of the behavior was hot reloaded, so its position, angle, size can have been changed outside of events.

Returns void
Inherited from RuntimeBehavior.onObjectHotReloaded
- Defined in GDJS/Runtime/runtimebehavior.ts:223

pauseTween

pauseTween(identifier): void
Pause a tween.
Parameters
- identifier: string
  Unique id to identify the tween
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1817

removeTween

removeTween(identifier): void
Remove a tween.
Parameters
- identifier: string
  Unique id to identify the tween
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1848

resumeTween

resumeTween(identifier): void
Resume a tween.
Parameters
- identifier: string
  Unique id to identify the tween
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1838

stepPostEvents

stepPostEvents(instanceContainer): void
Called at each frame after events. Call doStepPostEvents.
Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.
Parameters
- instanceContainer: RuntimeInstanceContainer
  The instanceContainer owning the object
Returns void
Inherited from RuntimeBehavior.stepPostEvents
- Defined in GDJS/Runtime/runtimebehavior.ts:140

stepPreEvents

stepPreEvents(instanceContainer): void
Called at each frame before events. Call doStepPreEvents.
Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.
Parameters
- instanceContainer: RuntimeInstanceContainer
  The instanceContainer owning the object
Returns void
Inherited from RuntimeBehavior.stepPreEvents
- Defined in GDJS/Runtime/runtimebehavior.ts:122

stopTween

stopTween(identifier, jumpToDest): void
Stop a tween.
Parameters
- identifier: string
  Unique id to identify the tween
- jumpToDest: boolean
  Move to destination
Returns void
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:1828

updateFromBehaviorData

updateFromBehaviorData(oldBehaviorData, newBehaviorData): boolean
Called when the behavior must be updated using the specified behaviorData. This is the case during hot-reload, and is only called if the behavior was modified.
Parameters
- oldBehaviorData: BehaviorData
  The previous data for the behavior.
- newBehaviorData: BehaviorData
  The new data for the behavior.
Returns boolean
true if the behavior was updated, false if it could not (i.e: hot-reload is not supported).

See
gdjs.RuntimeBehavior#onObjectHotReloaded
Overrides RuntimeBehavior.updateFromBehaviorData
- Defined in Extensions/TweenBehavior/tweenruntimebehavior.ts:79

updateFromNetworkSyncData

updateFromNetworkSyncData(networkSyncData): void
Update the behavior properties using the provided data.
Parameters
- networkSyncData: BehaviorNetworkSyncData
  The new properties of the behavior.
Returns void
Inherited from RuntimeBehavior.updateFromNetworkSyncData
- Defined in GDJS/Runtime/runtimebehavior.ts:93

usesLifecycleFunction

usesLifecycleFunction(): boolean
Should return false if the behavior does not need any lifecycle function to be called. Default, hidden, "capability" behaviors set it to false. This avoids useless calls to empty lifecycle functions, which would waste CPU time (and have a sizeable impact for example when lots of static instances are living in the scene).

Returns boolean
Inherited from RuntimeBehavior.usesLifecycleFunction
- Defined in GDJS/Runtime/runtimebehavior.ts:234

Class TweenRuntimeBehavior

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TweenRuntimeBehavior

Properties

name

owner

type

Methods

activate

Parameters

Returns void

activated

Returns boolean

addColorEffectPropertyTween

Parameters

Returns void

addNumberEffectPropertyTween

Parameters

Returns void

addObjectAngleTween

Parameters

Returns void

Deprecated

addObjectAngleTween2

Parameters

Returns void

addObjectColorHSLTween

Parameters

Returns void

Deprecated

addObjectColorHSLTween2

Parameters

Returns void

addObjectColorTween

Parameters

Returns void

Deprecated

addObjectColorTween2

Parameters

Returns void

addObjectDepthTween

Parameters

Returns void

Deprecated

addObjectDepthTween2

Parameters

Returns void

addObjectHeightTween

Parameters

Returns void

Deprecated

addObjectHeightTween2

Parameters

Returns void

addObjectOpacityTween

Parameters

Returns void

Deprecated

addObjectOpacityTween2

Parameters

Returns void

addObjectPositionTween

Parameters

Returns void

Deprecated

addObjectPositionTween2

Parameters

Returns void

addObjectPositionXTween

Parameters

Returns void

Deprecated

addObjectPositionXTween2