Util

Group Util exports & events

Server

    -- Gets all active groups.
    ---@return table : { groupId = number, groupName = string, groupMembers = table }
    exports.groups:GetGroups()
 
    -- Add a player to a group.
    ---@param groupId number
    ---@param source number
    ---@return boolean : success
    exports.groups:AddPlayer(groupID, source)
 
    -- Remove a player from a group.
    ---@param groupId number
    ---@param playerId number
    ---@return boolean : success
    exports.groups:RemovePlayer(groupID, playerId)
 
    -- Get a groups members.
    ---@param groupId number
    ---@return table <groupMembers> : { name: string, id : number, license: string, citizenid: string, groupOwner: boolean }
    exports.groups:GetMembers(groupID)
 
    -- Get the number of players in a group.
    ---@param groupId number
    ---@return number : memberCount
    exports.groups:MemberCount(groupID)
 
    -- Set the state of a group.
    ---@param groupId number
    ---@param state string
    exports.groups:SetState(groupID, state)
 
    -- Get the state of a group.
    ---@param groupId number
    ---@return string : state
    exports.groups:GetState(groupID)
 
    -- Get the owner of a group.
    ---@param groupId number
    ---@return number : ownerId
    exports.groups:GetOwner(groupID)
 
    -- Check if player is owner of a group.
    ---@param playerId number
    ---@return boolean : isOwner
    exports.groups:IsOwner(playerId)
 
    -- Get the group of a player.
    ---@param playerId number
    ---@return number | bool : groupId | false
    exports.groups:GetGroup(playerId)
 
    -- Get a players groupId.
    ---@param playerId number
    ---@return number : groupId
    exports.groups:GetGroupID(playerId)
 
    -- Set a groups type.
    ---@param groupId number
    ---@param typeName string
    exports.groups:SetType(groupId, typeName)
 
    -- Get a groups type.
    ---@param groupId number
    ---@return string : typeName
    exports.groups:GetType(groupId)
 
    -- Get a list of groups by type.
    ---@param typeName string
    ---@return table : { groupId = number, groupName = string, groupMembers = table }
    exports.groups:GetGroupsByType(typeName)
 
    -- Trigger an event for all groups of a type.
    ---@param typeName string
    ---@param eventName string
    ---@param data table
    exports.groups:TriggerEventByType(groupType, event, data)
 
    -- Notify all members of a group.
    ---@param groupId number
    ---@param data table
    exports.groups:Notify(groupId, data)

Client