Function Reference

The following pages cover the functions available within the framework. The framework relies heavily on our utility library boii_utils, you are encourage to read the documentation for this resource as well.

Accessing Functions

To access framework functions you have a couple of options.

Get Object

You can add the following into your resources to access the entire boii function library.

This should be added into both server side and client if you are working with both sides, or placed into a shared location to allow both sides to have access.

local boii = exports.boii_core:get()

Example

--- Retrieve the functions
local boii = exports.boii_core:get()

--- Using a function
local player = boii.get_player(source)

Exports

Each function also includes an export to allow for use of indivual functions without needing to get the core object.

Example

exports.boii_core:get_player(source)