Class PlayerSetNameEvent<RoomType>

constructor

• new PlayerSetNameEvent<RoomType extends StatefulRoom<any>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | SetNameMessage,
      oldName: string,
      newName: string,
  ): PlayerSetNameEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<any>

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | SetNameMessage
  • oldName: string

    The name that the player had before.

  • newName: string

    The new name that the player has.

  Returns PlayerSetNameEvent<RoomType>

eventName

Readonlymessage

ReadonlynewName

ReadonlyoldName

Readonlyplayer

Readonlyroom

StaticeventName

alteredName

• get alteredName(): string

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

  Returns string

revert

• revert(): void

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

  Returns void

setName

• setName(name: string): void

  Change the name that the player had set.

  Parameters

  • name: string

    The name to set.

  Returns void