Class MeetingHudClearVoteEvent<RoomType>

Emitted when a player's vote is cleared.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- MeetingHudClearVoteEvent

Implements

Index

Constructors

Properties

eventName meetinghud message player room eventName

Constructors

constructor

new MeetingHudClearVoteEvent<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    meetinghud: MeetingHud<RoomType>,
    message: undefined | ClearVoteMessage,
    player: Player<RoomType>,
): MeetingHudClearVoteEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- meetinghud: MeetingHud<RoomType>
- message: undefined | ClearVoteMessage
- player: Player<RoomType>
  The player that had their vote cleared.
Returns MeetingHudClearVoteEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/meetinghud/ClearVote.ts:17

Properties

eventName

eventName: "meeting.clearvote" = ...

`Readonly`meetinghud

meetinghud: MeetingHud<RoomType>

The meeting handler that this event is for.

`Readonly`message

message: undefined | ClearVoteMessage

The message that this event originated from.

`Readonly`player

player: Player<RoomType>

The player that had their vote cleared.

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "meeting.clearvote" = ...