Class PlayerListRecord

constructor

• new PlayerListRecord(
      uuid: string,
      uniqueId?: null | bigint,
      username?: null | string,
      xuid?: null | string,
      platformChatIdentifier?: null | string,
      platformBuild?: null | number,
      skin?: null | SerializedSkin,
      isTeacher?: null | boolean,
      isHost?: null | boolean,
      isVisitor?: null | boolean,
      locatorColor?: null | Color,
  ): PlayerListRecord

  Creates a new player record.

  Parameters

  • uuid: string

    The uuid of the player.
  • OptionaluniqueId: null | bigint

    The unique actor id of the player.
  • Optionalusername: null | string

    The username of the player.
  • Optionalxuid: null | string

    The xbox user id of the player.
  • OptionalplatformChatIdentifier: null | string

    The platform chat identifier of the player.
  • OptionalplatformBuild: null | number

    The platform build of the player.
  • Optionalskin: null | SerializedSkin

    The skin of the player.
  • OptionalisTeacher: null | boolean

    Whether the player is a teacher.
  • OptionalisHost: null | boolean

    Whether the player is a host.
  • OptionalisVisitor: null | boolean

    Whether the player is a visitor.
  • OptionallocatorColor: null | Color

    The locator bar color of the player.

  Returns PlayerListRecord

ReadonlyisHost

ReadonlyisTeacher

ReadonlyisVisitor

ReadonlylocatorColor

ReadonlyplatformBuild

ReadonlyplatformChatIdentifier

Readonlyskin

ReadonlyuniqueId

Readonlyusername

Readonlyuuid

Readonlyxuid

Staticread

• read(
      stream: BinaryStream,
      options: PacketDataTypeOptions<PlayerListAction>,
  ): PlayerListRecord[]

  Read a value from the stream.

  Parameters

  • stream: BinaryStream

    The BinaryStream to read from.
  • options: PacketDataTypeOptions<PlayerListAction>

    Options for reading the data type, such as endianness.

  Returns PlayerListRecord[]

  The value read from the stream.

Staticwrite

• write(
      stream: BinaryStream,
      records: PlayerListRecord[],
      options: PacketDataTypeOptions<PlayerListAction>,
  ): void

  Write a value to the stream.

  Parameters

  • stream: BinaryStream

    The BinaryStream to write to.
  • records: PlayerListRecord[]
  • options: PacketDataTypeOptions<PlayerListAction>

    Options for writing the data type, such as endianness.

  Returns void