Class PlayerCheckMurderEvent<RoomType>

constructor

• new PlayerCheckMurderEvent<
      RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
  >(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | CheckMurderMessage,
      victim: Player<RoomType>,
      isValid: boolean,
  ): PlayerCheckMurderEvent<RoomType>

  Type Parameters

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

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | CheckMurderMessage
  • victim: Player<RoomType>

    The other player that the player is attempting to murder.

  • isValid: boolean

    Whether or not this murder would normally be considered valid and thus the player be murdered.

  Returns PlayerCheckMurderEvent<RoomType>

StaticeventName

eventName

ReadonlyisValid

Readonlymessage

Readonlyplayer

Readonlyroom

Readonlyvictim

alteredIsValid

• get alteredIsValid(): boolean

  Whether or not this murder will be considered valid instead, if altered.

  Returns boolean

alteredPlayer

• get alteredPlayer(): Player<RoomType>

  The player that will murder the victim instead, if altered.

  Returns Player<RoomType>

alteredVictim

• get alteredVictim(): Player<RoomType>

  The player that will murdered instead, if altered.

  Returns Player<RoomType>

setPlayer

• setPlayer(player: Player<RoomType>): void

  Change the player that will actually murder the victim.

  Parameters

  • player: Player<RoomType>

  Returns void

setValid

• setValid(isValid: boolean): void

  Change whether this murder should be consider valid. If valid, this player will indeed be murdered.

  Parameters

  • isValid: boolean

    Whether or not this murder should be considered valid.

  Returns void

setVictim

• setVictim(victim: Player<RoomType>): void

  Change the player that will actually be murdered.

  Parameters

  • victim: Player<RoomType>

    The player to murder.

  Returns void