Skip to main content

Movement

Movement tools teleport or tween transforms for the active character.

All movement tools target the active character. Use select_character first when working with multiple characters.

move_character

Teleport the active character to a viewport position instantly. (0, 0) is the top-left corner of the primary monitor.

ParameterTypeDefaultDescription
xnumberrequiredViewport X coordinate (pixels)
ynumberrequiredViewport Y coordinate (pixels)

tween_position

Smoothly animate the active character's position to a target in world space.

ParameterTypeDefaultDescription
targetXnumberrequiredTarget X coordinate (world space)
targetYnumberrequiredTarget Y coordinate (world space)
targetZnumberrequiredTarget Z coordinate (world space)
durationMsnumberrequiredAnimation duration in milliseconds
easingstring"linear"Easing function (see Easing Functions)
waitbooleanfalseWait for animation to finish before returning

tween_rotation

Smoothly animate the active character's rotation to a target quaternion.

ParameterTypeDefaultDescription
targetXnumberrequiredTarget quaternion X
targetYnumberrequiredTarget quaternion Y
targetZnumberrequiredTarget quaternion Z
targetWnumberrequiredTarget quaternion W
durationMsnumberrequiredAnimation duration in milliseconds
easingstring"linear"Easing function (see Easing Functions)
waitbooleanfalseWait for animation to finish before returning

Example — 180° Y-axis rotation over 1 second:

{
"targetX": 0,
"targetY": 1,
"targetZ": 0,
"targetW": 0,
"durationMs": 1000,
"easing": "cubicInOut"
}

tween_scale

Smoothly animate the active character's scale. 1.0 is normal size on each axis.

ParameterTypeDefaultDescription
targetXnumber ≥ 0requiredTarget X scale factor
targetYnumber ≥ 0requiredTarget Y scale factor
targetZnumber ≥ 0requiredTarget Z scale factor
durationMsnumberrequiredAnimation duration in milliseconds
easingstring"linear"Easing function (see Easing Functions)
waitbooleanfalseWait for animation to finish before returning

Easing Functions

All three tween tools (tween_position, tween_rotation, tween_scale) accept the same easing values:

linear, quadraticIn, quadraticOut, quadraticInOut, cubicIn, cubicOut, cubicInOut, quarticIn, quarticOut, quarticInOut, quinticIn, quinticOut, quinticInOut, sineIn, sineOut, sineInOut, circularIn, circularOut, circularInOut, exponentialIn, exponentialOut, exponentialInOut, elasticIn, elasticOut, elasticInOut, backIn, backOut, backInOut, bounceIn, bounceOut, bounceInOut, smoothStepIn, smoothStepOut, smoothStep, smootherStepIn, smootherStepOut, smootherStep