Player Functions

SERVER SIDE ONLY

These functions operate directly on the player's class and are accessible from any codebase using FiveM's exports.

Accounts

get_accounts

Use the following to retrieve all accounts the player holds.

const accounts = exports.boii_core.get_accounts(source)

get_account

Use the following to retrieve a specific account the player holds by given account type.

const general_account = exports.boii_core.get_account(source, 'general')

add_balance

Use the following to add balance to an account the player holds.

// Account type
const account_type = 'general'
// Amount
const payment = 5000

exports.boii_core.add_balance(source, account_type, payment)

remove_balance

Use the following to remove balance from an account the player holds.

// Account type
const account_type = 'general'
// Amount
const fee = 5000

exports.boii_core.remove_balance(source, account_type, fee)

add_account

Use the following to add a new account to the players accounts.

// Account type
const account_type = 'test'
// Account data *optional*
const account_data = {
    balance = 10000
}

exports.boii_core.add_account(source, account_type, account_data)

Accounts must be defined in accounts.json in order to be added.

remove_account

Use the following to remove an account from the players accounts.

// Account type
const account_type = 'test'

exports.boii_core.remove_account(source, account_type) 

Identity

get_full_name

Use the following to retrieve a formatted version of the players full name.

const full_name = exports.boii_core.get_full_name(source)

change_name

Use the following to change a players name.

// First name
const first_name = 'John'
// Middle name *optional*
const middle_name = 'Jacob'
// Last name
const last_name = 'Doe'

exports.boii_core.change_name(source, first_name, middle_name, last_name)

set_profile_picture

Use the following to set a new profile picture for the player.

// Image source
const img_src = 'https://placehold.co/64x64'

exports.boii_core.set_profile_picture(source, img_src)

Inventory

get_inventory

Use the following to retrieve the players inventory.

const inventory = exports.boii_core.get_inventory(source)

get_items

Use the following to get all items in the players inventory.

const items = exports.boii_core.get_items(source)

get_item

Use the following to get an item the player has in their inventory by its ID, slot, or metadata.

// Get an item by its id
const item_by_id = exports.boii_core.get_item(source, 'water')

// Get an item by its slot 
const item_by_slot = exports.boii_core.get_item(source, 1)

// Get an item by its metadata
const item_by_metadata = exports.boii_core.get_item(source, { serial: 123456 })

has_item

Use the following to check if a player has a specified item and quantity.

// Item
const item = 'water'
// Quantity
const quantity = 2

const has_item = exports.boii_core.has_item(source, item, quantity)

add_item

Use the following to add an item to the players inventory.

// Item ID
const item = 'water'
// Quantity
const quantity = 5
// Item metadata *optional*
const metadata = {
    quality: 100
}

exports.boii_core.add_item(source, item, quantity, metadata)

remove_item

Use the following to remove an item from the players inventory by specifying the item id, slot, or metadata.

// Remove by ID
exports.boii_core.remove_item(source, 'weapon_pistol')

// Remove by slot
exports.boii_core.remove_item(source, 1)

// Remove by metadata
exports.boii_core.remove_item(source, {
    serial: 12345
}

update_item_data

Use the following to update the metadata for an item by specifying the item id, slot, or metadata.

// Update by id
exports.boii_core.update_item_data(source, 'weapon_pistol', {
    serial: 123456
})

// Update by slot
exports.boii_core.update_item_data(source, 1, {
    serial: 123456
})

// Update by metadata
exports.boii_core.update_item_data(source, {
    serial: 12345
}, {
    serial: 123456
})

Roles

get_roles

Use the following to retrieve all roles the player holds.

const roles = exports.boii_core.get_roles(source)

get_role

Use the following to retrieve a role the player holds by given role id.

const role = exports.boii_core.get_role(source, 'police')

has_role

Use the following to check the the player has a specified role.

This currently has no way of checking for grade, this will be updated asap.

const has_role  = exports.boii_core.has_role(source, 'police')

add_role

Use the following to add a new role on the player.

// Role ID
const role_id = 'police'
// Role grade
const grade = 2
// Role metadata *optional*
const metadata = {
    callsign: '00-00'
}

exports.boii_core.add_role(source, role_id, grade, metadata)

Only roles that have been defined within roles.json can be added.

remove_role

Use the following to remove a role from the player.

exports.boii_core.remove_role(source, 'police')

Statuses

get_statuses

Use the following to retrieve all statuses for the player.

const statuses = exports.boii_core.get_statuses(source)

get_status

Use the following to retrieve a specific status.

const health = exports.boii_core.get_status(source, 'health')

set_statuses

Use the following to set multiple statuses on the player.

const statuses = {
    health = 100,
    hunger = 20,
    thirst = 5
}

exports.boii_core.set_statuses(source, statuses)

set_status

Use the following to set a single status on the player.

exports.boii_core.set_status(source, 'health', 100)

get_flags

Use the following to retrieve all flags on the player.

const flags = exports.boii_core.get_flags(source)

get_flag

Use the following to retrieve a specific flag on the player.

const dead_flag = exports.boii_core.get_flag(source, 'is_dead')

set_flags

Use the following to set multiple flags on the player.

const flags = {
    is_dead = true,
    is_handcuffed = true
}

exports.boii_core.set_flags(source, flags)

set_flag

Use the following to set a single flag on the player.

exports.boii_core.set_flag(source, 'is_dead', true)

get_effects

Use the following to retrieve all effects the player holds.

const effects = exports.boii_utils.get_effects(source)

get_effect

Use the following to retrieve a effect the player holds by given id.

const effects = exports.boii_utils.get_effect(source, 'stamina')

set_effects

Use the following to multiple effects on the player.

const effects = ['bleeding', 'injured']

exports.boii_core.set_effects(source, effects)

set_effect

Use the following to set a single effect on the player.

exports.boii_core.set_effect(source, 'bleeding') 

Styles

get_style

Use the following to retrieve the players current style data.

const style = exports.boii_core.get_style(source)

set_style

Use the following to set a new style for the player.

const style = {
    barber: {
        hair_colour: 2
    }
}

exports.boii_core.set_style(source, style)

get_outfits

Use the following to retrieve all outfits for the player.

const outfits = exports.boii_core.get_outfits(source)

get_outfit

Use the following to retrieve a specific outfit by given id.

const outfit = exports.boii_core.get_outfit(source, 'outfit1')

add_outfit

Use the following to add a new outfit to the players data.

// Outfit id
const outfit_id = 'outfit1'

// Retrieve players sex
const sex = exports.boii_core.get_data('identity').sex

// Players current style: boii_utils tracks this. Make sure you send the current sex.
const style = exports.boii_utils.get_style(sex)

exports.boii_core.add_outfit(source, outfit_id, style)

remove_outfit

Use the following to remove a saved outfit from the player.

// Outfit id
const outfit_id = 'outfit1'

exports.boii_core.remove_outfit(source, outfit_id)

mark_as_customised

Use the following to mark the player as "has_customised". This allows direct entrance into the server on their next connection, instead of being routed into the character customisation.

const is_customised = exports.boii_core.has_customised(source);

if (!is_customised) {
    // Mark the player's character as customised
    exports.boii_core.mark_as_customised(source);
    console.log('Player has now been marked as customised.');
} else {
    console.log('Player has already customised their character.');
}

This is done automatically when a player first customises their character however if you need to do this for another reason you can.

has_customised

Use the following to check if a player is marked as "has_customised".

const is_customised = exports.boii_core.has_customised(source);

if (is_customised) {
    console.log('The player has customised their character.');
} else {
    console.log('The player has not customised their character.');
}