Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PlayerProtectEvent<RoomType>

Emitted when a player (who is a guardian angel) protects another player.

Due to technical limitations, this event cannot be reverted without advanced "breaking game", therefore it is out of scope of a single .revert() function. However, see PlayerCheckProtectEvent to see about canceling a protection before it happens if you are the host.

Type parameters

  • RoomType: Hostable

Hierarchy

Implements

Index

Properties

Static eventName

eventName: "player.protect" = ...

Readonly duration

duration: number

eventName

eventName: "player.protect" = ...

Readonly message

message: undefined | ProtectPlayerMessage

The message that this event originated from.

Readonly player

player: PlayerData<RoomType>

The player that this event is for.

Readonly room

room: RoomType

The room or client that the event came from.

Readonly target

target: PlayerData<RoomType>

Constructors

constructor

  • new PlayerProtectEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | ProtectPlayerMessage, target: PlayerData<RoomType>, duration: number): PlayerProtectEvent<RoomType>

Generated using TypeDoc