Class PlayerSetVisorEvent<RoomType>

Emitted when a player has their player visor updated.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSetVisorEvent

Implements

Properties

eventName eventName message newVisorId oldVisorId player room

Accessors

alteredVisorId

Constructors

constructor

Methods

revert setVisor

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

The new visor that the player has.

Readonly oldVisorId

oldVisorId: string

The visor that the player had before.

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

  • The altered visor that the player will have set instead, if changed.

    Returns string

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | SetVisorMessage
    • oldVisorId: string

      The visor that the player had before.

    • newVisorId: string

      The new visor that the player has.

    Returns PlayerSetVisorEvent<RoomType>

Methods

revert

  • Revert the player's visor back to their old visor.

    Returns void

setVisor

  • Change the visor that the player had set.

    Parameters

    • visor: string

      The visor to set.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc