Skip to main content

tweenScale

Smoothly animate an entity's scale to a target [x, y, z] value over a given duration using an easing function.

Parameters

ParameterTypeDescription
entityIdnumberThe entity ID to tween
requestTweenScaleRequestTween parameters

Returns

Promise<void>

Example

await entities.tweenScale(vrmEntity, {
target: [2, 2, 2],
durationMs: 800,
easing: "bounceOut",
wait: false, // fire-and-forget
});

Bounce scale effect

// Quick scale-up with bounce
await entities.tweenScale(entity, {
target: [1.5, 1.5, 1.5],
durationMs: 300,
easing: "bounceOut",
wait: true,
});

// Return to normal
await entities.tweenScale(entity, {
target: [1, 1, 1],
durationMs: 200,
easing: "quadraticOut",
wait: true,
});