Groups
GetGroupLeader
---@param groupId number
---@return number Group leader's source id
exports.yseries:GetGroupLeader(groupId)
IsGroupLeader
---@param groupId number
---@param playerSrc number
---@return number true or false if the source player is group leader
exports.yseries:IsGroupLeader(groupId, playerSrc)
GetGroupMembers
---@param groupId number
---@return table Returns a table of group members(source ids and character names)
exports.yseries:GetGroupMembers(groupId)
FindGroupByMember
---@param playerSrc number
---@return number Finds a group by player source id
exports.yseries:FindGroupByMember(playerSrc)
GetJobStatus
---@param groupId number
---@return string Gets a group's job status
exports.yseries:GetJobStatus(groupId)
SetJobStatus
---@param groupId number
---@param status string
exports.yseries:SetJobStatus(groupId, status)
GetGroupMembersCount
---@param groupId number
---@return number Gets a group's current members count
exports.yseries:GetGroupMembersCount(groupId)
CreateBlipForGroup
---@param groupId number
---@param name string
---@param data table
exports.yseries:CreateBlipForGroup(groupId, name, data)
RemoveBlipForGroup
---@param groupId number
---@param name string
exports.yseries:RemoveBlipForGroup(groupId, name)
SendGroupEvent
---@param groupId number
---@param event string
---@param args table
exports.yseries:SendGroupEvent(groupId, event, args)
SetGroupData
---@param groupId number
---@param key string
---@param data table
exports.yseries:SetGroupData(groupId, key, data)
GetGroupData
---@param groupId number
---@param key string
---@return table Gets group data
exports.yseries:GetGroupData(groupId, key)
DestroyGroupData
---@param groupId number
---@param key string
exports.yseries:DestroyGroupData(groupId, key)
NotifyGroup
---Sends a Phone notification to every group member. Timeout is optional(default is 3000ms).
---@param groupId number
---@param message string
---@param timeout number
exports.yseries:NotifyGroup(groupId, message, timeout)
Last updated