/opencreator

/createsociety [job] [useBlip] [blip] [maxSize] [useDirect] [label]

/societyaddrank [job]

/societyaddrank [job]

-- Creates a new society at the player's current coordinates.
-- Args (all required):
--  job (string)                -- internal job name
--  useBlip ("true"|"false")   -- enable blip
--  blipSprite (number)         -- blip sprite id
--  maxStorageSize (number)     -- maximum storage size
--  useDirectPayment ("true"|"false") -- direct payment mode
--  placementRange (number)     -- allowed distance for placing storage/wardrobe
--  label (string...)           -- society label (remaining args concatenated)
-- Example:
-- /createsociety brewery true 189 500 true 25 Brewery Company

-- Adds a new rank to the specified society (default template) or initializes defaults if first time.
-- Arg: job (string)
-- Example: /addrank brewery

-- Toggles company blip color between DARK_RED and LIGHT_GREEN for your society.

-- Places the society storage access point at your current position (if within placementRange).

-- Places the society wardrobe access point at your current position.

-- Initiates bill creation flow via UI callbacks.

-- Toggles your duty status (on/off). No arguments.

-- Sends a hire offer to target player. On accept, assigns them your job grade 0.
-- Arg: targetId (int)
-- Example: /hireplayer 27

-- Force-sets job and grade for target player.
-- Args:
--  targetId (int)
--  job (string)
--  jobgrade (int)
-- Example: /setjob 12 brewer 2

-- Opens the society creation UI (NUI) for authorized users.

-- Opens UI listing active bell station calls.

-- Checks a player's duty status and shows a notification.
-- Arg: targetId (int)
-- Example: /checkdutystatus 42

-- Resets (unlocks) the menu lock for specified source.

-- Prints salaries for all ranks of the job.

-- Sets salary/loan for a specific job grade.

-- Broadcasts client initialization event to all players.

--@info Server-side
--@param society table -- { job = string, grades = { { salary=number, isBoss=boolean }, ... } }
exports.brew_society:generateJobRanks({
  job = "police",
  grades = {
    { salary = 0, isBoss = false },
    { salary = 2, isBoss = false },
    { salary = 5, isBoss = true },
  }
}) -- generates the job ranks in database for the specified job

--@info Server-side
--@param society string -- The society name to create the shop for
--@param slots int -- The number of slots the shop will have
--@param name string -- The name of the shop that will be displayed
--@param coords string -- The coordinates of the shop as {x, y, z}
--@param rank int -- The rank to manage the shop
--@param blip string -- "true" or "false" if the blip should be displayed
exports.brew_society:insertIntoSocietyShops(society, slots, name, coords, rank, blip)

--@info Server-side
--@param job string -- Society/job name
--@param ledger number -- Starting ledger amount
--@param storageLimit number -- Initial storage limit
--@param storageCoords string|json -- Storage access coords (JSON string)
--@param wardrobeCoords string|json -- Wardrobe access coords (JSON string)
--@param daily number -- Daily payout toggle (0/1)
exports.brew_society:insertIntoSociety("police", 0, 100, json.encode({x=1,y=2,z=3}), json.encode({x=4,y=5,z=6}), 0)

--@info Server-side
--@param job string -- Society/job name
--@param jobgrade integer -- Grade index
--@param loan number -- Salary/loan amount
exports.brew_society:setLoanForJob("police", 2, 10)

--@info Server-side
--@param source integer -- The source ID of the user
--@return boolean -- true if on duty, false otherwise (defaults to false)
exports.brew_society:getUserDuty(source)
-- alias (case variant):
exports.brew_society:GetUserDuty(source)

--@info Server-side
--@param source integer -- The source ID of the user
--@param duty boolean -- New duty state
exports.brew_society:setUserDutyStatus(source, true)
-- alias (case variant):
exports.brew_society:SetUserDutyStatus(source, true)

--@info Server-side
--@param society string -- Society name
--@return table|boolean -- { lock = boolean, _source = number|nil } or false
exports.brew_society:GetMenuLock("police")

--@info Server-side
--@param source integer -- Player source
exports.brew_society:ResetMenuLockServer(source)

--@info Server-side
--@return table -- Societies data keyed by job name
exports.brew_society:GenerateSocietySettings()

--@info Server-side
--@param sender integer -- Sender source
--@param receiver integer -- Receiver source
--@param amount number -- Bill amount
--@param description string -- Description
exports.brew_society:CreateBill(sender, receiver, 100, "Service fee")

--@info Server-side
--@param source integer -- Caller source (for feedback)
--@param society string -- Society name
--@param gradeSettings table?|nil -- Optional complete rank definition
exports.brew_society:AddRank(source, "police", { job="police", jobgrade=4, jobLabel="Sergeant", salary=5, isBoss=false })

--@info Server-side
-- Note: Export exists in this build, but no implementation is provided.
-- Prefer the NUI/callback path `brew_society:Callback:createSocietyFromNui`.

--@info Server-side
--@param job string -- Society/job name
--@param money number -- Amount to add (negative subtracts)
exports.brew_society:AddToLedger("police", -500)

--@info Server-side
--@param job string -- Society/job name
--@return number -- Current ledger balance (0 if missing)
exports.brew_society:GetLedeger("police")

--@info Server-side
--@param job string -- Society/job name
--@param amount number -- Transaction amount (negative or positive)
--@param description string -- Description text
--@return boolean -- true on success
exports.brew_society:AddTransaction("police", -100, "Storage upgrade fee")

--@info Client-side
-- Note: Get duty status of local player that triggers it.
exports.brew_society:getPlayerDutyStatus()