Class MeetingHudCloseEvent<RoomType>

Emitted when the current meeting closes.

To listen for when a meeting actually ends and when a player gets ejected, see MeetingHudVotingCompleteEvent.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

CancelableEvent
- MeetingHudCloseEvent

Implements

Index

Constructors

Properties

canceled eventName meetinghud message room eventName

Methods

Constructors

constructor

new MeetingHudCloseEvent<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    meetinghud: MeetingHud<RoomType>,
    message: CloseMessage,
): MeetingHudCloseEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- meetinghud: MeetingHud<RoomType>
- message: CloseMessage
Returns MeetingHudCloseEvent<RoomType>
Overrides CancelableEvent.constructor
- Defined in packages/core/lib/events/meetinghud/Close.ts:18

Properties

canceled

canceled: boolean

eventName

eventName: "meeting.close" = ...

`Readonly`meetinghud

meetinghud: MeetingHud<RoomType>

The meeting handler that this event is for.

`Readonly`message

message: CloseMessage

The message that this event originated from.

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "meeting.close" = ...

Methods

cancel

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