Player

Defined in: client/api.d.ts:960

Client handle for a streamed M2O player.

Extends

• Player

Constructors

Constructor

new Player(id): Player

Defined in: client/api.d.ts:965

Creates a script wrapper for an existing streamed player with this ID; it does not create or spawn a player.

Parameters

id

number

Network entity identifier.

Returns

Player

Methods

emit()

emit(eventName, payloadJson?): void

Defined in: shared.d.ts:96

Parameters

eventName

string

payloadJson?

string

Returns

void

---

getBoneTransform()

getBoneTransform(boneId): BoneTransform | null

Defined in: client/api.d.ts:978

Resolves the current world-space transform of one of this player’s skeleton bones.

Parameters

boneId

number

Numeric bone identifier, typically obtained from the global Bone table.

Returns

BoneTransform | null

The bone transform, or null when the player or requested bone is unavailable.

---

getIP()

getIP(): string

Defined in: shared.d.ts:97

Returns

string

---

getNametagColor()

getNametagColor(): number

Defined in: shared.d.ts:105

Returns

number

---

getNametagText()

getNametagText(): string

Defined in: shared.d.ts:103

Returns

string

---

getVehicle()

getVehicle(): Vehicle | null

Defined in: client/api.d.ts:984

Returns the streamed vehicle currently occupied by this player.

Returns

Vehicle | null

The current vehicle handle, or null when the player is not inside a streamed vehicle.

---

isNametagHealthVisible()

isNametagHealthVisible(): boolean

Defined in: shared.d.ts:101

Returns

boolean

---

isNametagVisible()

isNametagVisible(): boolean

Defined in: shared.d.ts:99

Returns

boolean

---

kick()

kick(reason?): void

Defined in: shared.d.ts:95

Parameters

reason?

string

Returns

void

---

setNametagColor()

setNametagColor(color): void

Defined in: shared.d.ts:104

Parameters

color

number

Returns

void

---

setNametagHealthVisible()

setNametagHealthVisible(visible): void

Defined in: shared.d.ts:100

Parameters

visible

boolean

Returns

void

---

setNametagText()

setNametagText(text?): void

Defined in: shared.d.ts:102

Parameters

text?

string

Returns

void

---

setNametagVisible()

setNametagVisible(visible): void

Defined in: shared.d.ts:98

Parameters

visible

boolean

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

Defined in: shared.d.ts:83

Parameters

world

number

Returns

void

---

setVisibleTo()

setVisibleTo(player): void

Defined in: shared.d.ts:84

Parameters

player

Entity | null

Returns

void

---

toString()

toString(): string

Defined in: client/api.d.ts:971

Returns a readable representation of this player handle.

Returns

string

The player ID formatted for logging or debugging.

Properties

discordId

readonly discordId: string

Defined in: shared.d.ts:91

---

hardwareId

readonly hardwareId: string

Defined in: shared.d.ts:92

---

id

readonly id: number

Defined in: shared.d.ts:79

---

ip

readonly ip: string

Defined in: shared.d.ts:94

---

ping

readonly ping: number

Defined in: shared.d.ts:93

---

position

position: Vector3

Defined in: shared.d.ts:81

---

rotation

rotation: Vector3 | Quaternion

Defined in: shared.d.ts:82

---

steamId

readonly steamId: string

Defined in: shared.d.ts:90

---

virtualWorld

readonly virtualWorld: number

Defined in: shared.d.ts:80