Runtime classServer APIGenerated

Marker

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

Replicated world marker that can emit markerHit and markerLeave events.

Extends

Entity

Constructors

Constructor

new Marker(id): Marker

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

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

Parameters

id

number

Network entity identifier.

Returns

Marker

Inherited from

Entity.constructor

Methods

destroy()

destroy(): void

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

Destroys this replicated marker and removes it from connected clients.

Returns

void

setColor()

setColor(r, g, b): void

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

Changes the marker’s replicated RGB color.

Parameters

r

number

Red color component.

g

number

Green color component.

b

number

Blue color component.

Returns

void

setScale()

setScale(scale): void

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

Changes the marker’s replicated visual scale.

Parameters

scale

number

Uniform visual scale applied to the marker model.

Returns

void

setTriggerRadius()

setTriggerRadius(radius): void

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

Changes the radius used to emit marker contact events.

Parameters

radius

number

Contact radius in world units.

Returns

void

setVirtualWorld()

setVirtualWorld(world): void

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

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

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

Returns a readable representation of this marker.

Returns

string

The marker ID formatted for logging or debugging.

Inherited from

Entity.toString

create()

static create(x, y, z, model?, virtualWorld?, triggerRadius?): Marker

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

Creates and replicates a world marker.

Parameters

x

number

Initial world-space X coordinate.

y

number

Initial world-space Y coordinate.

z

number

Initial world-space Z coordinate.

model?

number

Optional marker model identifier.

virtualWorld?

number

Optional virtual-world ID used for visibility filtering.

triggerRadius?

number

Optional radius for markerHit and markerLeave events.

Returns

Marker

The newly created marker handle.

Properties

color

readonly color: number

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

Packed replicated marker color.

id

readonly id: number

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

Immutable network entity identifier.

Inherited from

Entity.id

model

readonly model: number

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

Replicated marker model identifier.

position

position: Vector3

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

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

rotation

rotation: Vector3 | Quaternion

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

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

Inherited from

Entity.rotation

scale

readonly scale: number

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

Current uniform visual scale.

state

readonly state: StateBag

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

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

triggerRadius

readonly triggerRadius: number

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

Radius used for player contact events, in world units.

virtualWorld

readonly virtualWorld: number

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

Current virtual-world identifier.

Inherited from

Entity.virtualWorld