API

To use the target resource your have two options, you can either import the target object and access functions this way, or you can use individual exports.

Accessing Target Functions

Importing Target Object

Import all the target functions into your client side files using the following:

local target = exports.boii_target:get_target()

Once the above line has been added you can then use the following functions within your resource:

target.add_circle_zone({...})
target.add_box_zone({...})
target.add_sphere_zone({...})
target.add_entity_zone({...})
target.add_model({...})

Individual Exports

If you only wish to use one or two of the target functions or you simple prefer to use exports you can instead use the following directly:

exports.boii_target:add_circle_zone({ options })
exports.boii_target:add_box_zone({ options })
exports.boii_target:add_sphere_zone({ options })
exports.boii_target:add_model({ models }, { options })
exports.boii_target:add_entity_zone({ entities }, { options })
exports.boii_target:add_player(bone_index, { options })
exports.boii_target:add_vehicle(bone_index, { options })

Usage Examples

Below you can view some useage examples.

add_circle_zone

target.add_circle_zone({
    id = "test_circle_zone",
    icon = "fa-solid fa-circle",
    coords = vector3(-254.09, -971.48, 31.22),
    radius = 2.0,
    distance = 2.0,
    debug = true,
    sprite = false,
    actions = {
        {
            label = "Test Circle Zone",
            icon = "fa-solid fa-circle",
            action_type = "client",
            action = "test_circle_action",
            params = {},
            can_interact = function(player) return true end,
        }
    }
})

add_box_zone

target.add_box_zone({
    id = "test_box_zone",
    icon = "fa-solid fa-square",
    coords = vector3(-241.74, -990.81, 29.29),
    width = 3,
    height = 3,
    depth = 3,
    heading = 45,
    distance = 2.0,
    debug = true,
    sprite = false,
    actions = {
        {
            label = "Test Box Zone",
            icon = "fa-solid fa-square",
            action_type = "client",
            action = "test_box_action",
            params = {},
            can_interact = function(player) return true end,
        }
    }
})

add_sphere_zone

target.add_sphere_zone({
    id = "test_sphere_zone",
    icon = "fa-solid fa-globe",
    coords = vector3(-261.38, -978.18, 31.22),
    radius = 2.0,
    distance = 2.0,
    debug = true,
    sprite = false,
    actions = {
        {
            label = "Test Sphere Zone",
            icon = "fa-solid fa-globe",
            action_type = "client",
            action = "test_sphere_action",
            params = {},
            can_interact = function(player) return true end
        }
    }
})

add_model

local function test_add_model()
    local models = {'a_m_m_business_01'}
    for _, model in ipairs(models) do
        local ped_data = {
            base_data = {
                model = model,
                coords = vector4(-249.07, -1001.14, 29.15, 337.32),
                scenario = 'WORLD_HUMAN_AA_COFFEE',
                networked = false
            }
        }
        local test_ped = utils.peds.create_ped(ped_data)
        testing_peds[#testing_peds + 1] = test_ped
    end
    target.add_model(models, {
        id = "test_model",
        icon = "fa-solid fa-coffee",
        coords = vector4(-249.07, -1001.14, 29.15, 337.32),
        distance = 2.5,
        actions = {
            {
                label = "Test Model",
                icon = "fa-solid fa-coffee",
                action_type = "client",
                action = "your_event_name",
                params = {},
                can_interact = function(entity)
                    return not IsPedAPlayer(entity) and IsEntityDead(entity)
                end
            },
        },
    })
end
test_add_model()

add_entity_zone

local function test_entity_zone()
    local vehicle_data = {
        model = 'adder', -- Example model
        coords = vector4(-242.23, -1004.29, 28.98, 159.01),
        is_network = true,
        net_mission_entity = true,
    }
    local vehicle = utils.vehicles.spawn_vehicle(vehicle_data)
    testing_ents[#testing_ents + 1] = vehicle
    if DoesEntityExist(vehicle) then
        target.add_entity_zone({vehicle}, {
            id = "test_vehicle_zone",
            icon = "fa-solid fa-car",
            distance = 2.5,
            debug = true,
            sprite = false,
            actions = {
                {
                    label = "Test Entity Zone",
                    icon = "fa-solid fa-car",
                    action_type = "client",
                    action = "your_event_name_for_vehicle",
                    params = {},
                    can_interact = function(entity)
                        return entity == vehicle 
                    end
                },
            }
        })
    end
end
test_entity_zone()

add_player

target.add_player('SKEL_Spine_Chest', {
    id = 'pawnshop_give_order',
    bone = 'SKEL_Spine_Chest',
    icon = 'fa-solid fa-box',
    distance = 1.0,
    actions = {
        {
            label = 'Give Order',
            icon = 'fa-solid fa-hand-holding-usd',
            action_type = 'server',
            action = 'boii_pawnshop:sv:validate_trade',
            params = {},
            can_interact = function(entity)
                return IsPedAPlayer(entity)
            end
        }
    }
})

add_vehicle

target.add_vehicle(['door_dside_f'] = {
    id = 'vehicle_door_dside_f',
    bone = 'door_dside_f',
    icon = 'fa-solid fa-door-open',
    distance = 0.6,
    actions = { 
        {
            label = 'Toggle Drivers Door',
            icon = 'fa-solid fa-door-closed',
            action_type = 'client',
            action = 'boii_target:cl:toggle_vehicle_door',  
            params = { door_index = 0 },
            can_interact = function(vehicle)
                return true
            end
        }
    }
})