Class PlayerSetNameplateEvent<RoomType>

Emitted when a player has their player nameplate updated.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSetNameplateEvent

Implements

Properties

eventName eventName message newNameplateId oldNameplateId player room

Accessors

alteredNameplateId

Constructors

constructor

Methods

revert setNameplate

Properties

Static eventName

eventName: "player.setnameplate"

eventName

eventName: "player.setnameplate"

Readonly message

message: undefined | SetNameplateMessage

The message that this event originated from.

Readonly newNameplateId

newNameplateId: string

The new nameplate that the player has.

Readonly oldNameplateId

oldNameplateId: string

The nameplate 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

alteredNameplateId

  • get alteredNameplateId(): string

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

    Returns string

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | SetNameplateMessage
    • oldNameplateId: string

      The nameplate that the player had before.

    • newNameplateId: string

      The new nameplate that the player has.

    Returns PlayerSetNameplateEvent<RoomType>

Methods

revert

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

    Returns void

setNameplate

  • Change the nameplate that the player had set.

    Parameters

    • nameplate: string

      The nameplate to set.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc