Class SecurityCameraJoinEvent<RoomType>

Emitted when a player starts watching security cameras.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

RevertableEvent
- SecurityCameraJoinEvent

Implements

Index

Constructors

Properties

eventName message player reverted room security eventName

Methods

Constructors

constructor

new SecurityCameraJoinEvent<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    security: SecurityCameraSystem<RoomType>,
    message: undefined | RepairSystemMessage,
    player: Player<RoomType>,
): SecurityCameraJoinEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- security: SecurityCameraSystem<RoomType>
- message: undefined | RepairSystemMessage
- player: Player<RoomType>
  The player that went onto the security cameras.
Returns SecurityCameraJoinEvent<RoomType>
Overrides RevertableEvent.constructor
- Defined in packages/core/lib/events/cameras/Join.ts:16

Properties

eventName

eventName: "security.cameras.join" = ...

`Readonly`message

message: undefined | RepairSystemMessage

The message that this event originated from.

`Readonly`player

player: Player<RoomType>

The player that went onto the security cameras.

reverted

reverted: boolean

`Readonly`room

The room or client that the event came from.

`Readonly`security

security: SecurityCameraSystem<RoomType>

The security cameras that the event is for.

`Static`eventName

eventName: "security.cameras.join" = ...

Methods

revert

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