Class RoomSelectHostEvent

Emitted when the room selects the next host in the room.

Can be used to change the default host selection, especially combined with the isActingHost and isJoining flags.

Hierarchy

  • CancelableEvent
    • RoomSelectHostEvent

Properties

eventName: "room.selecthost" = ...
canceled: boolean
eventName: "room.selecthost" = ...
isActingHost: boolean

Whether or not this is for an acting host (in server-as-a-host).

isJoining: boolean

Whether or not this player is being selected because they just joined and no one else is the host.

room: Room
selected: Connection

The host that is to be selected as host.

Accessors

Methods

  • Returns void

Constructors

  • Parameters

    • room: Room
    • isActingHost: boolean

      Whether or not this is for an acting host (in server-as-a-host).

    • isJoining: boolean

      Whether or not this player is being selected because they just joined and no one else is the host.

    • selected: Connection

      The host that is to be selected as host.

    Returns RoomSelectHostEvent

Generated using TypeDoc