⚔️Exports

You can use our provided exports to seamlessly integrate this script into your server.

Server Side exports

--- @param identifier string - The unique player identifier (e.g., identifier/citizenid).
--- @param jobName string - The job name to apply the penalty to.
--- @param reductionPercent number - Percentage to reduce the salary by (default: 0).
--- @param isPaused boolean - Whether to fully pause salary payouts (default: false).
---
--- @return boolean, string - Returns true on success, or false and a localized error message if parameters are missing.
exports["g-adv-paycheck"]:SetSalaryPenalty("char1:abc123", "police", 25, true)


--- Adds money to a player's paycheck based on job and payment type.
--- This function queues the amount to be claimed later from a paycheck system.
---
--- @param src number                         -- The source/player ID.
--- @param job string                         -- The job name associated with the paycheck (e.g., 'police', 'mechanic').
--- @param amount number                      -- The amount to be added to the paycheck.
--- @param payType 'default' | 'society'      -- The type of paycheck: - 'default': goes directly to the player's personal paycheck.  - 'society': added to the job's shared/society paycheck.
--- @param approvalRequired boolean           -- Whether this paycheck requires approval before collection.
exports["g-adv-paycheck"]:AddPaycheck(32, "mechanic", 500, "default", false)


--- Checks if the player's salary is paused for a specific job.
--- @param src number                         -- The source/player ID.
--- @param jobName string                     -- The name of the job.
--- @return boolean                           -- True if the salary is paused, false otherwise.
exports["g-adv-paycheck"]:isSalaryPaused(32, "police")


--- Gets the reduction percentage for a player's job.
--- @param src number                         -- The source/player ID.
--- @param jobName string                     -- The name of the job.
--- @return number                            -- The final amount after applying the reduction.
exports["g-adv-paycheck"]:GetPlayerReductionPercent(32, "ambulance")


-- Accumulation System exports

--- Get the total worked time for a player's job
--- @param src number -- The source/player ID
--- @param jobName string -- The name of the job
--- @return integer -- The total worked time in seconds
exports["g-adv-paycheck"]:GetWorkedTime(32, "mechanic")

--- Check if a player is in the accumulation tracking system for a specific job
--- @param src number -- The source/player ID
--- @param jobName string -- The name of the job
--- @return boolean -- True if the player is in the tracking system, false otherwise
exports["g-adv-paycheck"]:IsPlayerInTracking(32, "police")

Client Side exports

--- Opens the paycheck collection menu 
--- Useful for placing in interaction zones or command bindings.
exports["g-adv-paycheck"]:OpenUserPaycheckMenu()

--- Opens the boss salary management menu (requires boss permissions).
--- Allows boss or high-grade players to manage salaries and employee settings.
exports["g-adv-paycheck"]:OpenPayCheckBoss()