Class PlayerSetRoleEvent<RoomType>

Emitted when a player has their player role updated.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

CancelableEvent
- PlayerSetRoleEvent

Implements

Index

Constructors

Properties

canceled eventName message newRole oldRole player room eventName

Accessors

Methods

Constructors

constructor

new PlayerSetRoleEvent<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    player: Player<RoomType>,
    message: undefined | SetRoleMessage,
    oldRole: undefined | typeof BaseRole,
    newRole: typeof BaseRole,
): PlayerSetRoleEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- player: Player<RoomType>
- message: undefined | SetRoleMessage
- oldRole: undefined | typeof BaseRole
  The role that the player had before, if any.
- newRole: typeof BaseRole
  The new role that the player has, if any.
Returns PlayerSetRoleEvent<RoomType>
Overrides CancelableEvent.constructor
- Defined in packages/core/lib/events/player/SetRole.ts:19

Properties

canceled

canceled: boolean

eventName

eventName: "player.setrole" = ...

`Readonly`message

message: undefined | SetRoleMessage

The message that this event originated from.

`Readonly`newRole

newRole: typeof BaseRole

The new role that the player has, if any.

`Readonly`oldRole

oldRole: undefined | typeof BaseRole

The role that the player had before, if any.

`Readonly`player

player: Player<RoomType>

The player that this event is for.

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "player.setrole" = ...

Accessors

alteredRole

get alteredRole(): typeof BaseRole
The altered role that the player will have set instead, if changed.

Returns typeof BaseRole
- Defined in packages/core/lib/events/player/SetRole.ts:40

Methods

cancel

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

setRole

setRole(roleCtr: typeof BaseRole): void
Change the role that the player had set, or completely remove it altogether.
Parameters
- roleCtr: typeof BaseRole
Returns void
- Defined in packages/core/lib/events/player/SetRole.ts:48