GizmoArea

Defined in: client/api.d.ts:2308

Geometry from an Area.toJSON() or World Builder area export. Extra fields are ignored; this draws debug geometry and creates no trigger.

Properties

height?

optional height?: number

Defined in: client/api.d.ts:2347

Shape height above its lowest transformed point, 0 to less than 16384 metres. Zero (default) draws one ring at the points’ own heights.

---

max?

optional max?: GizmoPoint

Defined in: client/api.d.ts:2332

Box maximum in local space; defaults to {1,1,1}.

---

min?

optional min?: GizmoPoint

Defined in: client/api.d.ts:2327

Box minimum in local space; defaults to {-1,-1,-1}. Each component must be less than max.

---

points?

optional points?: GizmoPoint[]

Defined in: client/api.d.ts:2342

Required for shapes: 3 to 256 local points, forming a closed polygon.

---

position?

optional position?: GizmoPoint

Defined in: client/api.d.ts:2317

World origin in metres; defaults to zero.

---

radius?

optional radius?: number

Defined in: client/api.d.ts:2337

Required for spheres: radius in metres, greater than zero and less than 16384.

---

rotation?

optional rotation?: object

Defined in: client/api.d.ts:2322

Local-to-world quaternion, normalized on input; defaults to identity. Plain {x,y,z,w} objects work.

w

w: number

x

x: number

y

y: number

z

z: number

---

type

type: "box" | "sphere" | "shape"

Defined in: client/api.d.ts:2312

Which area geometry to draw.