Class PlayerSetNameplateEvent<RoomType>

constructor

• new PlayerSetNameplateEvent<RoomType extends StatefulRoom<any>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | SetNameplateMessage,
      oldNameplateId: string,
      newNameplateId: string,
  ): PlayerSetNameplateEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<any>

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | SetNameplateMessage
  • oldNameplateId: string

    The nameplate that the player had before.

  • newNameplateId: string

    The new nameplate that the player has.

  Returns PlayerSetNameplateEvent<RoomType>

eventName

Readonlymessage

ReadonlynewNameplateId

ReadonlyoldNameplateId

Readonlyplayer

Readonlyroom

StaticeventName

alteredNameplateId

• get alteredNameplateId(): string

  The altered nameplate that the player will have set instead, if changed.

  Returns string

revert

• revert(): void

  Revert the player's nameplate back to their old nameplate.

  Returns void

setNameplate

• setNameplate(nameplate: string): void

  Change the nameplate that the player had set.

  Parameters

  • nameplate: string

    The nameplate to set.

  Returns void