Class PlayerEnterVentEvent<RoomType>

Emitted when a player goes into a vent.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

BasicEvent
- PlayerEnterVentEvent

Implements

Index

Properties

eventName eventName message player room ventId

Constructors

Properties

`Static` eventName

eventName: "player.entervent"

eventName

eventName: "player.entervent"

`Readonly` message

message: undefined | EnterVentMessage

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` ventId

ventId: number

The ID of the vent that the player went into.

Constructors

constructor

new PlayerEnterVentEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | EnterVentMessage, ventId: number): PlayerEnterVentEvent<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | EnterVentMessage
- ventId: number
  
  The ID of the vent that the player went into.
Returns PlayerEnterVentEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/events/player/EnterVent.d.ts:21

Generated using TypeDoc