Skip to content
KCKingdoms Connected Scripting APIScripting guides and API
Data shapeServer APIGenerated

LevelEditDefinition

Defined in: server/api.d.ts:4279

at: number[] | Vector3

Defined in: server/api.d.ts:4303

Where the level put the object: its pivot, matched within 5 cm. A brush’s key, with its mesh.


optional class?: string

Defined in: server/api.d.ts:4298

An entity’s class, kept for reading only.


optional guid?: string

Defined in: server/api.d.ts:4293

An entity’s level EntityGuid as sixteen hex digits; required for an entity.


optional hidden?: boolean

Defined in: server/api.d.ts:4308

Whether it is taken out of the world: not drawn and not solid.


optional kind?: "brush" | "entity"

Defined in: server/api.d.ts:4283

What the object is; a brush when omitted. A brush has no identity of its own, so it is found by its mesh and where the level put it; a level entity by its EntityGuid.


optional name?: string

Defined in: server/api.d.ts:4288

A brush’s mesh path, objects/...cgf, as the World Builder shows it; required for a brush. An entity’s name, kept for reading only.


optional position?: number[] | Vector3

Defined in: server/api.d.ts:4313

Where it stands instead; present, the edit is a move.


optional rotation?: number[] | Quaternion

Defined in: server/api.d.ts:4318

A move’s orientation: a Quaternion, {x, y, z, w} or [x, y, z, w]. None when omitted.


optional scale?: number[] | Vector3

Defined in: server/api.d.ts:4323

A move’s scale per axis, from 0.01 to 100. None when omitted.