Marker
Defined in: server/api.d.ts:934
Replicated world marker that can emit markerHit and markerLeave events.
Extends
Section titled “Extends”Entity
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Marker(
id):Marker
Defined in: server/api.d.ts:939
Creates a script wrapper for an existing marker with this ID; use Marker.create() to create a marker.
Parameters
Section titled “Parameters”number
Network entity identifier.
Returns
Section titled “Returns”Marker
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: server/api.d.ts:970
Destroys this replicated marker and removes it from connected clients.
Returns
Section titled “Returns”void
setColor()
Section titled “setColor()”setColor(
r,g,b):void
Defined in: server/api.d.ts:984
Changes the marker’s replicated RGB color.
Parameters
Section titled “Parameters”number
Red color component.
number
Green color component.
number
Blue color component.
Returns
Section titled “Returns”void
setScale()
Section titled “setScale()”setScale(
scale):void
Defined in: server/api.d.ts:976
Changes the marker’s replicated visual scale.
Parameters
Section titled “Parameters”number
Uniform visual scale applied to the marker model.
Returns
Section titled “Returns”void
setTriggerRadius()
Section titled “setTriggerRadius()”setTriggerRadius(
radius):void
Defined in: server/api.d.ts:990
Changes the radius used to emit marker contact events.
Parameters
Section titled “Parameters”radius
Section titled “radius”number
Contact radius in world units.
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:965
Returns a readable representation of this marker.
Returns
Section titled “Returns”string
The marker ID formatted for logging or debugging.
create()
Section titled “create()”
staticcreate(x,y,z,model?,virtualWorld?,triggerRadius?):Marker
Defined in: server/api.d.ts:1002
Creates and replicates a world marker.
Parameters
Section titled “Parameters”number
Initial world-space X coordinate.
number
Initial world-space Y coordinate.
number
Initial world-space Z coordinate.
model?
Section titled “model?”number
Optional marker model identifier.
virtualWorld?
Section titled “virtualWorld?”number
Optional virtual-world ID used for visibility filtering.
triggerRadius?
Section titled “triggerRadius?”number
Optional radius for markerHit and markerLeave events.
Returns
Section titled “Returns”Marker
The newly created marker handle.
Properties
Section titled “Properties”
readonlycolor:number
Defined in: server/api.d.ts:954
Packed replicated marker color.
readonlyid:number
Defined in: shared.d.ts:79
readonlymodel:number
Defined in: server/api.d.ts:944
Replicated marker model identifier.
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
readonlyscale:number
Defined in: server/api.d.ts:949
Current uniform visual scale.
triggerRadius
Section titled “triggerRadius”
readonlytriggerRadius:number
Defined in: server/api.d.ts:959
Radius used for player contact events, in world units.
virtualWorld
Section titled “virtualWorld”
readonlyvirtualWorld:number
Defined in: shared.d.ts:80