Class PlayerSetHostEvent<RoomType>

Emitted when a player becomes the host of the room.

This event contains a setHost method that does not do anything in SkeldJS as the host of the room is decided by the server, making it impossible to alter the host as a client.

A server implementation may implement this by overriding the functions in Hostable responsible for updating the host.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSetHostEvent

Implements

Properties

eventName eventName player room

Accessors

alteredHost

Constructors

constructor

Methods

setHost

Properties

Static eventName

eventName: "player.sethost"

eventName

eventName: "player.sethost"

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

alteredHost

  • get alteredHost(): PlayerData<RoomType>

  • The altered player that will be made host instead, if changed.

    Returns PlayerData<RoomType>

Constructors

constructor

  • Type Parameters

    Parameters

    Returns PlayerSetHostEvent<RoomType>

Methods

setHost

  • Change the player that was made host.

    Parameters

    • player: PlayerData<RoomType>

      The player to make host.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc