Class PlayerRemoveProtectionEvent<RoomType>

Emitted when a player's protection by a guardian angel ends, either by running out of time or attempted to be murdered by an impostor.

See PlayerProtectEvent to listen for when a player gets protected initially.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

RevertableEvent
- PlayerRemoveProtectionEvent

Implements

PlayerEvent<RoomType>

Index

Constructors

Properties

eventName eventName player reason reverted room

Methods

Constructors

constructor

new PlayerRemoveProtectionEvent<
    RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
>(
    room: RoomType,
    player: Player<RoomType>,
    reason: ProtectionRemoveReason,
): PlayerRemoveProtectionEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>
Parameters
- room: RoomType
- player: Player<RoomType>
- reason: ProtectionRemoveReason
Returns PlayerRemoveProtectionEvent<RoomType>
Overrides RevertableEvent.constructor
- Defined in packages/core/lib/events/player/RemoveProtection.ts:19

Properties

`Static`eventName

eventName: "player.removeprotection" = ...

eventName

eventName: "player.removeprotection" = ...

`Readonly`player

player: Player<RoomType>

`Readonly`reason

reason: ProtectionRemoveReason

reverted

reverted: boolean

`Readonly`room

Methods

revert

revert(): void
Returns void
Inherited from RevertableEvent.revert
- Defined in packages/events/lib/RevertableEvent.ts:12