API

The following sections outline the full API currently within the utility library.

Each function has a short description on what it would be used for, and a code preview example of how to use.

Here we will cover some quick instructions on how to use the API.

Import Utils Object

One option of accessing utils functions is to leverage exports to import the entire utils object into your project. Doing so will provide access to every utils function. Insert the following line at the top of the file you are working on to gain library access.

--- Get utils object
local utils = exports.boii_utils:get_utils()

--- Using a utils function
utils.blips.create_blip(...)

Direct Exports

Instead of adding the entire library to your project you can use direct exports to the functions.

This removes some additional bloat in cases where only a single or small amount of functions are needed.

--- Direct export
exports.boii_utils:create_blip(...)