BasePlayer

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

Framework-owned base handle for a connected player, extended by each game or mod.

Extends

• Entity

Extended by

• Player

Constructors

Constructor

new BasePlayer(id): BasePlayer

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

Creates a wrapper for an existing connected player with this ID; it does not connect or spawn a player.

Parameters

id

number

Network entity identifier.

Returns

BasePlayer

Inherited from

Entity.constructor

Methods

emit()

emit(eventName, payloadJson?): void

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

Emits a named script event to this player’s client connection.

Parameters

eventName

string

Client event name.

payloadJson?

string

Optional JSON payload forwarded verbatim to the owning client.

Returns

void

---

getIP()

getIP(): string

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

Returns this player’s current remote network address.

Returns

string

Address string, or an empty string when the player or peer is unavailable.

---

getNametagColor()

getNametagColor(): number

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

Reads this player’s nametag color.

Returns

number

Packed 0xAARRGGBB color; opaque white when untinted.

---

getNametagText()

getNametagText(): string

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

Reads this player’s nametag text override.

Returns

string

The override, or an empty string when the player’s own name is drawn.

---

isNametagHealthVisible()

isNametagHealthVisible(): boolean

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

Checks whether the health bar under this player’s nametag is shown.

Returns

boolean

True unless the health bar was hidden; false also when this game has no nametags.

---

isNametagVisible()

isNametagVisible(): boolean

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

Checks whether this player’s nametag is shown to other players.

Returns

boolean

True unless the nametag was hidden; false also when this game has no nametags.

---

kick()

kick(reason?): void

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

Disconnects this player from the server.

Parameters

reason?

string

Optional reason shown to the disconnected player; omitting it uses the generic kicked reason.

Returns

void

---

setNametagColor()

setNametagColor(color): void

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

Tints the text on this player’s nametag.

Parameters

color

number

Packed 0xAARRGGBB color.

Returns

void

---

setNametagHealthVisible()

setNametagHealthVisible(visible): void

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

Shows or hides the health bar under this player’s nametag, leaving the name itself alone.

Parameters

visible

boolean

True to show the health bar under this player’s name, false to hide it.

Returns

void

---

setNametagText()

setNametagText(text?): void

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

Overrides the text drawn on this player’s nametag.

Parameters

text?

string

Text to show instead of the player’s name, cut to 64 bytes; empty or omitted restores the name.

Returns

void

---

setNametagVisible()

setNametagVisible(visible): void

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

Shows or hides the name over this player’s head for every other player. The health bar has its own switch, and each player can still hide all nametags locally.

Parameters

visible

boolean

True to show this player’s nametag to everyone, false to hide it.

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

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

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

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

Formats this player handle for logging and debugging.

Returns

string

Text containing the player’s network entity ID.

Inherited from

Entity.toString

Properties

discordId

readonly discordId: string

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

Authenticated Discord identifier, or an empty string when unavailable.

---

hardwareId

readonly hardwareId: string

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

Framework hardware identifier, or an empty string when unavailable.

---

id

readonly id: number

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

Immutable network entity identifier.

Inherited from

Entity.id

---

ip

readonly ip: string

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

Current remote network address, or an empty string when unavailable.

---

ping

readonly ping: number

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

Current round-trip latency in milliseconds, or -1 when unavailable.

---

position

position: Vector3

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

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

---

rotation

rotation: Vector3 | Quaternion

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

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

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

---

steamId

readonly steamId: string

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

Authenticated Steam identifier, or an empty string when unavailable.

---

virtualWorld

readonly virtualWorld: number

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

Current virtual-world identifier.

Inherited from

Entity.virtualWorld