Blocker

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

Invisible replicated collision volume.

Extends

• Entity

Constructors

Constructor

new Blocker(id): Blocker

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

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

Inherited from

Entity.constructor

Methods

destroy()

destroy(): void

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

Destroys this replicated collision volume.

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

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

Moves this entity into another virtual world.

Parameters

world

number

Virtual-world identifier used to partition replication and visibility.

Returns

void

Inherited from

Entity.setVirtualWorld

---

setVisibleTo()

setVisibleTo(player): void

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

Restricts replication of this entity to one owning connection while preserving normal range and visibility checks.

Parameters

player

Entity | null

Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.

Returns

void

Inherited from

Entity.setVisibleTo

---

toString()

toString(): string

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

Returns a readable representation of this blocker.

Returns

string

The blocker ID formatted for logging or debugging.

Inherited from

Entity.toString

---

create()

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

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

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 degrees.

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:1523

Whether the volume blocks pedestrians and players.

---

blockVehicles

blockVehicles: boolean

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

Whether the volume blocks vehicles.

---

enabled

enabled: boolean

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

Whether collision for this blocker is active.

---

id

readonly id: number

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

Immutable network entity identifier.

Inherited from

Entity.id

---

position

position: Vector3

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

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

---

rotation

rotation: Vector3 | Quaternion

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

Authoritative rotation; reads return a quaternion and assignments accept a quaternion or Euler angles in degrees.

Inherited from

Entity.rotation

---

size

readonly size: Vector3

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

Full local dimensions of the collision volume.

---

state

readonly state: StateBag

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

Arbitrary key/value state carried by this entity. The server writes it and every client that can see the entity receives it; see StateBag.

Inherited from

Entity.state

---

virtualWorld

readonly virtualWorld: number

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

Current virtual-world identifier.

Inherited from

Entity.virtualWorld