Class PlayerCheckNameEvent<RoomType>

constructor

• new PlayerCheckNameEvent<RoomType extends StatefulRoom<any>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | CheckNameMessage,
      originalName: string,
      alteredName: string,
  ): PlayerCheckNameEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<any>

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | CheckNameMessage
  • originalName: string

    The original name that the player asked for.

  • alteredName: string

    The altered name, i.e. the original name was taken.

  Returns PlayerCheckNameEvent<RoomType>

alteredName

eventName

Readonlymessage

ReadonlyoriginalName

Readonlyplayer

Readonlyroom

StaticeventName

setName

• setName(name: string): void

  Change the altered name for the player to have set.

  Parameters

  • name: string

    The name to set.

  Returns void