Registry

Client Events

boii:player_joined

Use the following as a handler to trigger code on the player when they have successfully loaded into the server.

on('boii:player_joined', (player_data) => {
    const first_name = player_data.identity.first_name
    console.log(`Client: ${first_name} was loaded client-side.`);
});

Server Functions

get_user

Use the following to retrieve the user object from boii_utils for a given source.

const user = exports.boii_core.get_user(source)

get_players

Use the following to retrieve all players in the player registry.

const players = exports.boii_core.get_players()

get_player

Use the following to retrieve a player from the registry by given source.

const player = exports.boii_core.get_player(source)

create_player

Use the following to create the player class for the players character by their unique id and character id.

const unique_id = get_user(source).unique_id // Utilising get_user
const char_id = 1 // Example data

exports.boii_core.create_player(source, unique_id, char_id)

Server Events

boii:player_joined

Use the following as a handler to trigger code on the player when they have successfully loaded into the server.

on('boii:player_joined', (player) => {
    const first_name = player.data.identity.first_name
    console.log(`Server: ${first_name} was loaded server-side.`);
});