Server Exports
Server Exports
Below are all the useful exports that you can use in other resources, be sure to read their descriptions.
getSociety
Get all the information about the registered company/gang
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@return table or nil
local society = exports['vms_bossmenu']:getSociety(jobName)
getSocietyTransactions
Get a list of all transactions from the company
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@return table or nil
local societyTransactions = exports['vms_bossmenu']:getSocietyTransactions(jobName)
addTransaction
Register a new transaction
---@param {src: playerId}:
---@param {jobNameFrom: string}:
---@param {jobNameTo: string | nil}:
---@param {type: string}: 'withdraw' / 'deposit' / 'transfer_outgoing' / 'transfer_incoming' / 'tax_payment' / 'payout'
---@param {amount: number}
---@param {title: string | nil}
---@param {cb: function | nil}
exports['vms_bossmenu']:addTransaction(src, jobNameFrom, jobNameTo, type, amount, title, cb)
getMoney
Get company/gang balance
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@return number
local money = exports['vms_bossmenu']:getMoney(jobName)
setMoney
Set the balance of the company/gang account
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@param {amount: number}
---@param {cb: function | nil}
exports['vms_bossmenu']:setMoney(jobName, amount, cb)
addMoney
Add money to the business/gang account
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@param {amount: number}
---@param {cb: function | nil}
exports['vms_bossmenu']:addMoney(jobName, amount, cb)
removeMoney
Remove money from the business/gang account
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@param {amount: number}
---@param {cb: function | nil}
exports['vms_bossmenu']:removeMoney(jobName, amount, cb)
getEmployees
Get information on all employees of a job
---@param {jobName: string}: Registered job name, e.g. 'police' / 'ambulance'
---@return table
local employees = exports['vms_bossmenu']:getEmployees(jobName)
getEmployeesCount
Get the number of employees of a given job
---@param {jobName: string}: Registered job name, e.g. 'police' / 'ambulance'
local employeesCount = exports['vms_bossmenu']:getEmployeesCount(jobName)
getGangMembers
Get information on all gang members
---@param {gangName: string}: Registered gang name, e.g. 'vagos' / 'ballas'
---@return table
local members = exports['vms_bossmenu']:getGangMembers(gangName)
getGangMembersCount
Get the number of gang members
---@param {gangName: string}: Registered gang name, e.g. 'vagos' / 'ballas'
---@return number
local membersCount = exports['vms_bossmenu']:getGangMembersCount(gangName)
getClothings
Get information on all job/gang outfits
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@param {withOutfit: boolean}
---@return table
local clothingList = exports['vms_bossmenu']:getClothings(jobName, withOutfit)
getClothing
Get information about a specific outfit from job/gang
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@param {id: number}
---@return table
local clothing = exports['vms_bossmenu']:getClothing(jobName, id)
getPlayerBadge
Get a player's badge number from a specific job
---@param {identifier: number | string}: Player ID or Player Identifier
---@param {jobName: string}: Job name, e.g. 'police'
exports['vms_bossmenu']:getPlayerBadge(identifier, jobName, function(badge)
print('Badge ID:', badge)
end)
getPlayerBadges
Get all player badge numbers
---@param {identifier: number | string}: Player ID or Player Identifier
---@return table
local badges = exports['vms_bossmenu']:getPlayerBadges(identifier)
setPlayerBadge
Set the player a new badge number
---@param {identifier: number | string}: Player ID or Player Identifier
---@param {jobName: string}: Job name, e.g. 'police'
---@param {badgeNumber: number}
exports['vms_bossmenu']:setPlayerBadge(identifier, jobName, badgeNumber)
sendAnnouncement
Send a message to the job/gang
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@param {text: string}: Message
---@param {type: string}: Name of the sender, configurable in config.translation.lua
exports['vms_bossmenu']:sendAnnouncement(jobName, text, type)
getGradePermissions
Get permissions information for grade specific jobs or gangs
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@param {grade: number}: Grade ID
---@param {getValues: boolean}:
---@return boolean, table | string
local access, perms = exports['vms_bossmenu']:getGradePermissions(jobName, grade, getValues)
havePermission
Check if a certain grade of job/gang has permissions for a certain action
---@param {jobName: string}: Registered job or gang name, e.g. 'police' / 'ballas'
---@param {grade: number}: Grade ID
---@param {action: string}: permission name (List of permissions in #Explanation)
---@return boolean
local access = exports['vms_bossmenu']:havePermission(jobName, grade, action)
Last updated
Was this helpful?