↔️Exports

getGroupId

returns the group id of the player

-- Params:
-- identifier, number|string - The identifier of the player by source or citizenid

-- Exemple:
local groupId = exports['zf-groups']:getGroupId(id: 3)

-- Returns:
381

getMembers

returns a table of members inside the group.

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
local groupMembers = exports['zf-groups']:getMembers(groupId, false)

-- Returns:
{
    {
        source = 2,
        citizenid = 'YZO12345',
        name = 'LeZach Dev'
    },
    {
        source = 5,
        citizenid = 'ZKD93103',
        name = 'ZF Labo'
    }
}

getSize

return the group size.

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
local groupSize = exports['zf-groups']:getSize(groupId, false)

-- Returns:
4

getLeader

return the group owner's data

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
local groupLeader = exports['zf-groups']:getLeader(groupId, false)

-- Returns:
{
    source = 2,
    citizenid = 'YZO12345',
    name = 'LeZach Dev'
}

destroyGroup

destroy the specified group

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:destroyGroup(groupId, false)

isLeader

returns if the specified player is the leader/owner of the group

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- identifier, number/string - The source or citizenid of the player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
local isLeader = exports['zf-groups']:isLeader(groupId, 'YZO12345', false)

-- Returns:
true

notifyGroup

send a notification to all the players inside the group. the notifications uses ox_lib data.

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- OxLibNotifyData, table - https://overextended.dev/ox_lib/Modules/Interface/Client/notify#standard
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:notifyGroup(groupId, OxLibNotifyData, false)

leaveGroup

makes the player leave is current group

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- identifier, number/string - The source or citizenid of the leaving player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:leaveGroup(groupId, 2, false)

updateMembers

force the client data to be updated

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:updateMembers(groupId, false)

addTask

add a task to the group tasks

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- OxLibNotifyData, table - https://overextended.dev/ox_lib/Modules/Interface/Client/notify#standard
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
local taskId = exports['zf-groups']:addTask(groupId, {
    title = 'A new task!',
    steps = 1,
    current_step = 0,
    completed = false
}, false)

removeTask

remove a specified task from the group tasks

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- taskId, number - The task id to remove
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:removeTask(groupId, taskId, false)

completeTask

complete the on-going task that the group is currently working on rarely used. more likely to use the nextStep export.

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:completeTask(groupId, false)

nextStep

pass to the next step of the task. if there is no next step, it moves to the next task

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:nextStep(groupId, false)

updateTasks

update all the tasks of the group

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- tasks, table - Table of the updated tasks
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:updateTasks(groupId, tasks, false)

getTasks

returns a table with all the tasks of the group

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
local tasks = exports['zf-groups']:getTasks(groupId, false)

setJob

set the job data for the group

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- jobId, string - The job unique id used for identification
-- label, string - The job label that is shown in the menu
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:setJob(groupId, 'gruppe6', 'Gruppe Sechs', false)

leaveJob

leave the group job

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:leaveJob(groupId, false)

resetJobData

resets the group job data

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:resetJobData(groupId, false)

syncEntity

sync entity data for all group members

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- netId, number - The entity network id
-- data, table - The data to pass on the entity
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:syncEntity(groupId, 123014, {
    busy = true,
}, false)

setBlip

set the group blip

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- data, table - Blip data
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:setBlip(groupId, {
    coords = vec3(0.0, 0.0, 0.0),
    sprite = 325,
    display = 2,
    scale = 0.5,
    color = 12,
    label = 'Somewhere over the rainbow...',
    route = true,
}, false)

removeBlip

remove the group blip

-- Params:
-- groupId, number - The groupId or source of the targeted player.
-- isSource, boolean - If you have passed a player source, set it to true.

-- Exemple:
exports['zf-groups']:removeBlip(groupId, false)