Class PlayerSetNameplateEvent<RoomType>

Emitted when a player has their player nameplate updated.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerSetNameplateEvent

Implements

Index

Properties

Accessors

alteredNameplateId

Constructors

constructor

Methods

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

Readonly oldNameplateId

oldNameplateId: 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

alteredNameplateId

get alteredNameplateId(): string

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

Returns string

Constructors

constructor

new PlayerSetNameplateEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | SetNameplateMessage, oldNameplateId: string, newNameplateId: string): PlayerSetNameplateEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/SetNameplate.ts:19
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | SetNameplateMessage
- oldNameplateId: string
- newNameplateId: string
Returns PlayerSetNameplateEvent<RoomType>

Methods

revert

revert(): void

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

Returns void

setNameplate

setNameplate(nameplate: string): void

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

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

Generated using TypeDoc