native-api

This module contains documentation for components of the native headless API

Most of this is copied from the official headless host documentation by Mario Carbajal.

Description

This module contains documentation for components of the native headless API

Most of this is copied from the official headless host documentation by Mario Carbajal.

Namespaces


RoomObject

Room object provided by the native API.


PlayerObject

PlayerObject holds information about a player.


RoomConfigObject

Room configuration object.


ScoresObject

Holds information relevant to the current game scores.

Methods


<static> HBInit( roomConfig ) → {external:native-api.RoomObject}

Room initialization function.

Description

Room initialization function.

Use this function to initialize the room, it returns the room object used to control the room.

After calling this function a recaptcha challenge will appear, after passing the recaptcha the room link will appear on the page.

Parameters
Name Type Description
roomConfig external:native-api.RoomConfigObject

Room configuration.

Returns