Class PlayerSetVisorEvent<RoomType>

constructor

• new PlayerSetVisorEvent<
      RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
  >(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | SetVisorMessage,
      oldVisorId: string,
      newVisorId: string,
  ): PlayerSetVisorEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | SetVisorMessage
  • oldVisorId: string

    The visor that the player had before.

  • newVisorId: string

    The new visor that the player has.

  Returns PlayerSetVisorEvent<RoomType>

StaticeventName

eventName

Readonlymessage

ReadonlynewVisorId

ReadonlyoldVisorId

Readonlyplayer

Readonlyroom

alteredVisorId

• get alteredVisorId(): string

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

  Returns string

revert

• revert(): void

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

  Returns void

setVisor

• setVisor(visor: string): void

  Change the visor that the player had set.

  Parameters

  • visor: string

    The visor to set.

  Returns void