Class PlayerSetVisorEvent<RoomType>

Emitted when a player has their player visor updated.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerSetVisorEvent

Implements

Index

Properties

Accessors

alteredVisorId

Constructors

constructor

Methods

Properties

Static eventName

eventName: "player.setvisor" = ...

eventName

eventName: "player.setvisor" = ...

Readonly message

message: undefined | SetVisorMessage

The message that this event originated from.

Readonly newVisorId

newVisorId: string

Readonly oldVisorId

oldVisorId: string

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.

Accessors

alteredVisorId

get alteredVisorId(): string

- Defined in core/lib/events/player/SetVisor.ts:40
The altered visor that the player will have set instead, if changed.

Returns string

Constructors

constructor

new PlayerSetVisorEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | SetVisorMessage, oldVisorId: string, newVisorId: string): PlayerSetVisorEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/SetVisor.ts:19
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | SetVisorMessage
- oldVisorId: string
- newVisorId: string
Returns PlayerSetVisorEvent<RoomType>

Methods

revert

revert(): void

- Defined in core/lib/events/player/SetVisor.ts:47
Revert the player's visor back to their old visor.

Returns void

setVisor

setVisor(visor: string): void

- Defined in core/lib/events/player/SetVisor.ts:55
Change the visor that the player had set.

Parameters
- visor: string
  
  The visor to set.
Returns void

Generated using TypeDoc