setScale

setScale

Sets the scale of an object.

Signature

setScale(objectName: string, scale: Vector3): Promise<void>

Parameters

Name
Type
Required
Description

objectName

string

Yes

Object name

scale

Yes

New scale {x, y, z}

Returns

Promise<void>

Usage

// Uniform scale (2x bigger)
await api.setScale("Chair", { x: 2, y: 2, z: 2 });

// Non-uniform scale
await api.setScale("Chair", { x: 1, y: 2, z: 1 });

Notes

  • Important: Always provide all three coordinates (x, y, z). Missing values default to 0.001, not preserved

  • Only accepts string name, not array

Last updated