Class PlayerSetRoleEvent<RoomType>

Emitted when a player has their player role updated.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSetRoleEvent

Implements

Properties

eventName eventName message newRole oldRole player room

Accessors

alteredRole

Constructors

constructor

Methods

revert setRole

Properties

Static eventName

eventName: "player.setrole"

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: typeof BaseRole

The role that the player had before, if any.

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

alteredRole

  • get alteredRole(): typeof BaseRole

  • The altered role that the player will have set instead, if changed.

    Returns typeof BaseRole

Constructors

constructor

Methods

revert

  • Revert the player's role back to their old role.

    Returns void

setRole

  • Change the role that the player had set, or completely remove it altogether.

    Parameters

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc