Player

constructor

• new Player(id: number): Player

  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

emit

• emit(eventName: string, payloadJson?: string): void

  Parameters

  • eventName: string
  • OptionalpayloadJson: string

  Returns void

getBoneTransform

• getBoneTransform(boneId: number): BoneTransform | null

  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

  Returns string

getVehicle

• getVehicle(): Vehicle | null

  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.

kick

• kick(reason?: string): void

  Parameters

  • Optionalreason: string

  Returns void

setVirtualWorld

• setVirtualWorld(world: number): void

  Parameters

  • world: number

  Returns void

setVisibleTo

• setVisibleTo(player: Entity | null): void

  Parameters

  • player: Entity | null

  Returns void

toString

• toString(): string

  Returns a readable representation of this player handle.

  Returns string

  The player ID formatted for logging or debugging.

ReadonlydiscordId

ReadonlyhardwareId

Readonlyid

Readonlyip

Readonlyping

position

rotation

ReadonlysteamId

ReadonlyvirtualWorld