Blocker

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

Invisible replicated collision volume.

Extends

• Entity

Constructors

Constructor

new Blocker(id): Blocker

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

Creates a script wrapper for an existing blocker with this ID; use Blocker.create() to create a blocker.

Parameters

id

number

Network entity identifier.

Returns

Blocker

Methods

destroy()

destroy(): void

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

Destroys this replicated collision volume.

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

Defined in: shared.d.ts:83

Parameters

world

number

Returns

void

---

setVisibleTo()

setVisibleTo(player): void

Defined in: shared.d.ts:84

Parameters

player

Entity | null

Returns

void

---

toString()

toString(): string

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

Returns a readable representation of this blocker.

Returns

string

The blocker ID formatted for logging or debugging.

---

create()

static create(x, y, z, sizeX, sizeY, sizeZ, typeMask?, rotation?, virtualWorld?): Blocker

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

Creates and replicates an invisible collision volume.

Parameters

x

number

World-space X coordinate of the volume center.

y

number

World-space Y coordinate of the volume center.

z

number

World-space Z coordinate of the volume center.

sizeX

number

Full local width of the volume.

sizeY

number

Full local depth of the volume.

sizeZ

number

Full local height of the volume.

typeMask?

number

Optional collision mask selecting vehicle and pedestrian blocking.

rotation?

Vector3 | Quaternion

Optional orientation: a Quaternion, or a Vector3 of Euler angles in radians.

virtualWorld?

number

Optional virtual-world ID used for visibility filtering.

Returns

Blocker

The newly created blocker handle.

Properties

blockPeds

blockPeds: boolean

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

Whether the volume blocks pedestrians and players.

---

blockVehicles

blockVehicles: boolean

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

Whether the volume blocks vehicles.

---

enabled

enabled: boolean

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

Whether collision for this blocker is active.

---

id

readonly id: number

Defined in: shared.d.ts:79

---

position

position: Vector3

Defined in: shared.d.ts:81

---

rotation

rotation: Vector3 | Quaternion

Defined in: shared.d.ts:82

---

size

readonly size: Vector3

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

Full local dimensions of the collision volume.

---

virtualWorld

readonly virtualWorld: number

Defined in: shared.d.ts:80