Class MedScanLeaveQueueEvent<RoomType>

Emitted when a player leaves the queue for a med scan.

Type parameters

RoomType: Hostable

Hierarchy

RevertableEvent
- MedScanLeaveQueueEvent

Implements

Index

Properties

Accessors

alteredPlayer

Constructors

constructor

Methods

Properties

Static eventName

eventName: "medscan.leavequeue" = ...

eventName

eventName: "medscan.leavequeue" = ...

Readonly medscan

medscan: MedScanSystem<RoomType>

The med scan system that this event is for.

Readonly message

message: undefined | RepairSystemMessage

The message that this event originated from.

Readonly player

player: PlayerData<RoomType>

reverted

reverted: boolean

Readonly room

room: RoomType

The room or client that the event came from.

Accessors

alteredPlayer

get alteredPlayer(): PlayerData<RoomType>

- Defined in core/lib/events/medscan/LeaveQueue.ts:36
The alternate player that will leave the queue instead, if changed.

Returns PlayerData<RoomType>

Constructors

constructor

new MedScanLeaveQueueEvent<RoomType>(room: RoomType, medscan: MedScanSystem<RoomType>, message: undefined | RepairSystemMessage, player: PlayerData<RoomType>): MedScanLeaveQueueEvent<RoomType>

Overrides RevertableEvent.constructor
- Defined in core/lib/events/medscan/LeaveQueue.ts:19
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- medscan: MedScanSystem<RoomType>
- message: undefined | RepairSystemMessage
- player: PlayerData<RoomType>
Returns MedScanLeaveQueueEvent<RoomType>

Methods

revert

revert(): void

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

setPlayer

setPlayer(player: PlayerData<RoomType>): void

- Defined in core/lib/events/medscan/LeaveQueue.ts:44
Change the player that left the queue.

Parameters
- player: PlayerData<RoomType>
  
  The player that left the queue.
Returns void

Generated using TypeDoc