Class PlayerSetNameEvent<RoomType>

Emitted when a player has their player name updated.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerSetNameEvent

Implements

Index

Properties

Accessors

alteredName

Constructors

constructor

Methods

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

Readonly oldName

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

Accessors

alteredName

get alteredName(): string

- Defined in core/lib/events/player/SetName.ts:40
The altered name that the player will have set instead, if changed.

Returns string

Constructors

constructor

new PlayerSetNameEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | SetNameMessage, oldName: string, newName: string): PlayerSetNameEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/SetName.ts:19
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | SetNameMessage
- oldName: string
- newName: string
Returns PlayerSetNameEvent<RoomType>

Methods

revert

revert(): void

- Defined in core/lib/events/player/SetName.ts:47
Revert the player's name back to their old name.

Returns void

setName

setName(name: string): void

- Defined in core/lib/events/player/SetName.ts:55
Change the name that the player had set.

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

Generated using TypeDoc