SpikeStrip

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

Replicated tyre spike strip that can be enabled or disabled by the server.

Extends

• Entity

Constructors

Constructor

new SpikeStrip(id): SpikeStrip

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

Creates a script wrapper for an existing spike strip with this ID; use SpikeStrip.create() to create one.

Parameters

id

number

Network entity identifier.

Returns

SpikeStrip

Inherited from

Entity.constructor

Methods

destroy()

destroy(): void

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

Destroys this replicated spike strip.

Returns

void

---

setEnabled()

setEnabled(enabled): void

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

Sets whether this spike strip is active.

Parameters

enabled

boolean

True to activate tyre puncturing; false to disable it.

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

Returns a readable representation of this spike strip.

Returns

string

The spike-strip ID formatted for logging or debugging.

Inherited from

Entity.toString

---

create()

static create(x, y, z, length?, heading?, virtualWorld?): SpikeStrip

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

Creates and replicates an enabled tyre spike strip.

Parameters

x

number

Initial world-space X coordinate.

y

number

Initial world-space Y coordinate.

z

number

Initial world-space Z coordinate.

length?

number

Optional physical strip length in world units.

heading?

number

Optional world-space heading angle.

virtualWorld?

number

Optional virtual-world ID used for visibility filtering.

Returns

SpikeStrip

The newly created spike-strip handle.

Properties

enabled

readonly enabled: boolean

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

Whether tyre puncturing is active.

---

heading

readonly heading: number

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

World-space heading angle.

---

id

readonly id: number

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

Immutable network entity identifier.

Inherited from

Entity.id

---

length

readonly length: number

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

Physical strip length in world units.

---

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

---

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