Data shapeServer APIGenerated

AreaDefinition

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

Properties

collision?

optional collision?: boolean

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

Invisible boundary collision from both sides; false when omitted. Polygons need a simple outline and positive height. Walls are 0.2 m thick; spheres use a tessellated boundary.

enabled?

optional enabled?: boolean

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

Whether it starts enabled; true when omitted.

height?

optional height?: number

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

shape: how far above its lowest corner the area reaches; 0, the default, for no ceiling.

id

id: string

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

The area’s identity, unique among script areas. It may not be sixteen hex digits, which is how a level area’s GUID reads.

labels?

optional labels?: string[]

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

Free-form labels, found again with Area.withLabel.

max?

optional max?: Vector3

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

box: the opposite corner. Every component must be above min’s.

metadata?

optional metadata?: Record<string, unknown>

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

Anything JSON can hold, kept on the area for scripts.

min?

optional min?: Vector3

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

box: the corner nearest negative infinity, relative to position before rotation.

name?

optional name?: string

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

A readable name; the id when omitted.

points?

optional points?: Vector3[]

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

shape: 3 to 256 corners relative to position before rotation, closed back to the first. As in the engine, the floor is the lowest corner.

position?

optional position?: Vector3

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

Where the shape is placed from; the origin when omitted.

radius?

optional radius?: number

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

sphere: its radius around position.

rotation?

optional rotation?: Vector3 | Quaternion

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

The shape’s orientation: a Quaternion or {x, y, z, w}, or Euler angles in degrees.

type

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

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

CryEngine’s own area shapes: AreaBox, AreaShape (a closed polygon with a height) and AreaSphere.

virtualWorld?

optional virtualWorld?: number

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

The one virtual world it belongs to; every world when omitted.