Class PlayerSetRoleEvent<RoomType>

constructor

• new PlayerSetRoleEvent<RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | SetRoleMessage,
      oldRole: undefined | typeof BaseRole,
      newRole: typeof BaseRole,
  ): PlayerSetRoleEvent<RoomType>

  Type Parameters

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

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | SetRoleMessage
  • oldRole: undefined | typeof BaseRole

    The role that the player had before, if any.

  • newRole: typeof BaseRole

    The new role that the player has, if any.

  Returns PlayerSetRoleEvent<RoomType>

StaticeventName

eventName

Readonlymessage

ReadonlynewRole

ReadonlyoldRole

Readonlyplayer

Readonlyroom

alteredRole

• get alteredRole(): typeof BaseRole

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

  Returns typeof BaseRole

setRole

• setRole(roleCtr: typeof BaseRole): void

  Change the role that the player had set, or completely remove it altogether.

  Parameters

  • roleCtr: typeof BaseRole

  Returns void