Class PlayerSetHatEvent<RoomType>

Emitted when a player has their player hat updated.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerSetHatEvent

Implements

Index

Properties

Accessors

alteredHatId

Constructors

constructor

Methods

Properties

Static eventName

eventName: "player.sethat" = ...

eventName

eventName: "player.sethat" = ...

Readonly message

message: undefined | SetHatMessage

The message that this event originated from.

Readonly newHatId

newHatId: string

Readonly oldHatId

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

alteredHatId

get alteredHatId(): string

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

Returns string

Constructors

constructor

new PlayerSetHatEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | SetHatMessage, oldHatId: string, newHatId: string): PlayerSetHatEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/SetHat.ts:19
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | SetHatMessage
- oldHatId: string
- newHatId: string
Returns PlayerSetHatEvent<RoomType>

Methods

revert

revert(): void

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

Returns void

setHat

setHat(hatId: string): void

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

Parameters
- hatId: string
  
  The hat to set.
Returns void

Generated using TypeDoc