Server Reference

On This Page

A complete reference for all functions that can be called for the HighNoon server.

init

async

Initializes a new server instance with the provided options.

const { data, error } = await server.init();

Where the return is in the form of:

data: {
    server: string
} | error: string

createRoom

async

Create a new room

const { data, error } = await server.createRoom(room);

Where the return is in the form of:

data: {
    room: string,
} | error: string

getConnectedClients

Returns the number of clients connected to the room.

const { data } = await server.getConnectedClients();

Where the return is in the form of:

data: {
    clients: {
        userId: string,
        socketId: string
    }[],
    count: number
}

broadcast

Broadcasts a message to all clients that have established WebRTC connections with the server. This function should be used for gameplay information that needs to be transmitted to all clients. This function does not have a return.

server.broadcast(message);

send

Sends a message to a specific client using the WebRTC link. This function should be used for information that needs to be transmitted quickly, or with many packets. This will return a success or error depending on if the specified client was found.

const { data, error } = server.send(userId, message);

Where the return is in the form of:

{
    data: {
        success: boolean
    } | null,
    error: string | null
}

relay

Sends a message to all clients connected to the server. This function utilises the WebSocket link to send information, so it should be used for information that does not need to be send quickly, but that must arrive.

server.relay(message);

relayTo

This function sends a message to a specific client using the WebSocket link. This function should be used for information that does not need to be send quickly, but that must arrive.

const { data, error } = server.relayTo(userId, message);

Where the return is in the form of:

{
    data: {
        success: boolean
    } | null,
    error: string | null
}

kickClient

Kicks a client from the server. This function should be used to remove a client from the server, and should be used with caution.

server.kickClient(userId);

on

listener

The on listener can be used to listen to events emitted by the server. These are listed below, with their respective payloads.

server.on("listener", () =>{})

Events

clientConnected

Emitted when a client connects to the server.

Payload:

{
    meta: {
        roomId: string,
        initalized: boolean,
        connectedToRoom: boolean
    },
    userId: string
}

packet

Emitted when a message is received from any connected client.

Payload:

{
    meta: {
        roomId: string,
        initalized: boolean,
        connectedToRoom: boolean
    },
    from :{
        userId: string,
        socketId: string
    },
    payload: any
}

relay

Emitted when the server receives a message from the client via the WebSocket link.

Payload:

{
    meta: {
        userId: string,
        socketId: string,
        roomId: string
    },
    to: string,
    payload: any
}