SpikeStrip
Defined in: server/api.d.ts:1439
Replicated tyre spike strip that can be enabled or disabled by the server.
Extends
Section titled “Extends”Entity
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SpikeStrip(
id):SpikeStrip
Defined in: server/api.d.ts:1444
Creates a script wrapper for an existing spike strip with this ID; use SpikeStrip.create() to create one.
Parameters
Section titled “Parameters”number
Network entity identifier.
Returns
Section titled “Returns”SpikeStrip
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: server/api.d.ts:1470
Destroys this replicated spike strip.
Returns
Section titled “Returns”void
setEnabled()
Section titled “setEnabled()”setEnabled(
enabled):void
Defined in: server/api.d.ts:1476
Sets whether this spike strip is active.
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
True to activate tyre puncturing; false to disable it.
Returns
Section titled “Returns”void
setVirtualWorld()
Section titled “setVirtualWorld()”setVirtualWorld(
world):void
Defined in: shared.d.ts:83
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
setVisibleTo()
Section titled “setVisibleTo()”setVisibleTo(
player):void
Defined in: shared.d.ts:84
Parameters
Section titled “Parameters”player
Section titled “player”Entity | null
Returns
Section titled “Returns”void
toString()
Section titled “toString()”toString():
string
Defined in: server/api.d.ts:1465
Returns a readable representation of this spike strip.
Returns
Section titled “Returns”string
The spike-strip ID formatted for logging or debugging.
create()
Section titled “create()”
staticcreate(x,y,z,length?,heading?,virtualWorld?):SpikeStrip
Defined in: server/api.d.ts:1488
Creates and replicates an enabled tyre spike strip.
Parameters
Section titled “Parameters”number
Initial world-space X coordinate.
number
Initial world-space Y coordinate.
number
Initial world-space Z coordinate.
length?
Section titled “length?”number
Optional physical strip length in world units.
heading?
Section titled “heading?”number
Optional world-space heading angle.
virtualWorld?
Section titled “virtualWorld?”number
Optional virtual-world ID used for visibility filtering.
Returns
Section titled “Returns”SpikeStrip
The newly created spike-strip handle.
Properties
Section titled “Properties”enabled
Section titled “enabled”
readonlyenabled:boolean
Defined in: server/api.d.ts:1459
Whether tyre puncturing is active.
heading
Section titled “heading”
readonlyheading:number
Defined in: server/api.d.ts:1454
World-space heading angle.
readonlyid:number
Defined in: shared.d.ts:79
length
Section titled “length”
readonlylength:number
Defined in: server/api.d.ts:1449
Physical strip length in world units.
position
Section titled “position”position:
Vector3
Defined in: shared.d.ts:81
rotation
Section titled “rotation”rotation:
Vector3|Quaternion
Defined in: shared.d.ts:82
virtualWorld
Section titled “virtualWorld”
readonlyvirtualWorld:number
Defined in: shared.d.ts:80