Skip to main content

TweenAnimation

Base class for all tween types.

TypeNameInterface Description
Variablesdelay: number

Function: Delay in seconds before the animation starts after calling start().

Variablesduration: number

Function: Animation duration in seconds (one cycle, excluding PingPong reverse).

VariableseasingFunction: TweenEasingFunction

Function: Easing curve shape. Combine with easingType. Non-Linear auto-defaults easingType to Out if it was None.

VariableseasingType: TweenEasingType

Function: Easing direction: None (only valid with Linear), In (slow start), Out (fast start), InOut (both). Setting None on non-Linear is rejected.

VariablesmotionType: TweenMotionType

Function: Interpolation mode: FromTo (start→end), To (current→end, ignores start values), Offset (current+offset, ignores start/end values).

Variablesobject: SceneObject | null

Function: Target SceneObject to animate. Set to null to clear target.

VariablesplayMode: TweenPlayMode

Function: Loop behavior: Loop (continuous), LoopOnce (play once), PingPong (forward+reverse continuous), PingPongOnce (forward+reverse once).

VariablestargetType: TweenTargetType

Function: Property to animate. Transform/Path/Follow: Position/Rotation/Scale. Material: AlbedoColor/EmissionColor/UV.

Functionsconstructor()

Functionspause(): void

Function: Pause the tween animation. Call resume() to continue from the paused position.

Functionsresume(): void

Function: Resume the tween animation from a paused state.

Functionsstart(): void

Function: Start tween animation from initial state.

Functionsstop(): void

Function: Stop the tween animation and keep the current state.

Examples

constructor()

let obj = new APJS.TweenAnimation();

Use Case

@component()
export class NewBehaviourScript extends APJS.BasicScriptComponent {
onStart() {
// TODO: instantiate / use TweenAnimation here
}
onUpdate(deltaTime: number) {
}
}
Copyright © 2026 TikTok. All rights reserved.
About TikTokHelp CenterCareersContactLegalTerms of ServicePrivacy PolicyCookies