Class PlayerSetNameEvent<RoomType>

Emitted when a player has their player name updated.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSetNameEvent

Implements

Properties

eventName eventName message newName oldName player room

Accessors

alteredName

Constructors

constructor

Methods

revert setName

Properties

Static eventName

eventName: "player.setname"

eventName

eventName: "player.setname"

Readonly message

message: undefined | SetNameMessage

The message that this event originated from.

Readonly newName

newName: string

The new name that the player has.

Readonly oldName

oldName: string

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

alteredName

  • get alteredName(): string

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

    Returns string

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | SetNameMessage
    • oldName: string

      The name that the player had before.

    • newName: string

      The new name that the player has.

    Returns PlayerSetNameEvent<RoomType>

Methods

revert

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

    Returns void

setName

  • Change the name that the player had set.

    Parameters

    • name: string

      The name to set.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc