Class PlayerCheckNameEvent<RoomType>

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

Type parameters

RoomType: Hostable

Hierarchy

CancelableEvent
- PlayerCheckNameEvent

Implements

Index

Properties

Methods

Constructors

constructor

Properties

Static eventName

eventName: "player.checkname" = ...

alteredName

alteredName: string

canceled

canceled: boolean

eventName

eventName: "player.checkname" = ...

Readonly message

message: undefined | CheckNameMessage

The message that this event originated from.

Readonly originalName

originalName: 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.

Methods

cancel

cancel(): void

Inherited from CancelableEvent.cancel
- Defined in events/lib/CancelableEvent.ts:12
Returns void

setName

setName(name: string): void

- Defined in core/lib/events/player/CheckName.ts:38
Change the altered name for the player to have set.

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

Constructors

constructor

new PlayerCheckNameEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | CheckNameMessage, originalName: string, alteredName: string): PlayerCheckNameEvent<RoomType>

Overrides CancelableEvent.constructor
- Defined in core/lib/events/player/CheckName.ts:18
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | CheckNameMessage
- originalName: string
- alteredName: string
Returns PlayerCheckNameEvent<RoomType>

Generated using TypeDoc