Class PlayerCheckNameEvent<RoomType>

Emitted when a player requests to have their name set. Only emitted if the client is the host.

Type Parameters

Hierarchy

  • CancelableEvent
    • PlayerCheckNameEvent

Implements

Properties

eventName alteredName canceled eventName message originalName player room

Methods

cancel setName

Constructors

constructor

Properties

Static eventName

eventName: "player.checkname"

alteredName

alteredName: string

The altered name, i.e. the original name was taken.

canceled

canceled: boolean

eventName

eventName: "player.checkname"

Readonly message

message: undefined | CheckNameMessage

The message that this event originated from.

Readonly originalName

originalName: string

The original name that the player asked for.

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.

Methods

cancel

  • Returns void

setName

  • Change the altered name for the player to have set.

    Parameters

    • name: string

      The name to set.

    Returns void

Constructors

constructor

  • Type Parameters

    Parameters

    • room: RoomType
    • player: PlayerData<RoomType>
    • message: undefined | CheckNameMessage
    • originalName: string

      The original name that the player asked for.

    • alteredName: string

      The altered name, i.e. the original name was taken.

    Returns PlayerCheckNameEvent<RoomType>

Settings

Member Visibility

Theme

Generated using TypeDoc