Exports

These are the exports for the resource.

Server exports

Departments

GetDepartment(id)

Returns the department object for id.

local dept = exports.pickle_policejob:GetDepartment("lspd")
print(dept.label)

GetDepartmentPermission(id, permission)

Returns the value of a named permission on a department.

local canArrest = exports.pickle_policejob:GetDepartmentPermission("lspd", "arrest")

GetDepartmentMember(id, source)

Returns the department member record for a player.

local member = exports.pickle_policejob:GetDepartmentMember("lspd", source)
if member then print(member.rank) end

GetDepartmentRank(id, rankId)

Returns the rank object for rankId within a department.

local rank = exports.pickle_policejob:GetDepartmentRank("lspd", "sergeant")

GetDepartmentEntity(id, entityId)

Returns a stored entity (location/asset) for a department.

local entity = exports.pickle_policejob:GetDepartmentEntity("lspd", "armory_1")

GetPlayerDepartment(source)

Returns the player's current department object.

local dept = exports.pickle_policejob:GetPlayerDepartment(source)

GetPlayerDepartmentJob(source)

Returns the framework job tied to the player's department.

local job = exports.pickle_policejob:GetPlayerDepartmentJob(source)

GetIdentifierDepartment(identifier)

Looks up a department by player identifier (offline-safe).

local dept = exports.pickle_policejob:GetIdentifierDepartment("char1:abc123")

IsPlayerOnDuty(source)

Returns true if the player is on duty.

if exports.pickle_policejob:IsPlayerOnDuty(source) then
    -- on-duty officer logic
end

SetPlayerDuty(source, onDuty, report)

Sets duty state. Pass report = true to log to Discord.

exports.pickle_policejob:SetPlayerDuty(source, true, true)

IsPlayerDepartmentLeader(source)

Returns true if the player holds a leader rank.

if exports.pickle_policejob:IsPlayerDepartmentLeader(source) then
    -- leader-only menu
end

DoesPlayerHaveEntityPermission(source, id, entityId, onDutyRequired)

Permission check against a department entity.

local allowed = exports.pickle_policejob:DoesPlayerHaveEntityPermission(source, "lspd", "armory_1", true)

GetTotalCopsOnline()

Returns total on-duty officers across all departments.

local count = exports.pickle_policejob:GetTotalCopsOnline()
if count < 2 then return end -- gate robberies behind a minimum

---

Department money

AddDepartmentMoney(id, amount)

Adds funds to a department's balance.

exports.pickle_policejob:AddDepartmentMoney("lspd", 1000)

RemoveDepartmentMoney(id, amount)

Removes funds from a department's balance.

exports.pickle_policejob:RemoveDepartmentMoney("lspd", 500)

GetDepartmentMoney(id)

Returns the department's current balance.

local balance = exports.pickle_policejob:GetDepartmentMoney("lspd")

AddDepartmentTransaction(id, source, transactionType, amount, reason)

Records a transaction against a department.

exports.pickle_policejob:AddDepartmentTransaction("lspd", source, "expense", 500, "Equipment purchase")

---

Evidence / files

AddEvidence(coords, evidenceType, data)

Spawns an evidence record at the given coords.

exports.pickle_policejob:AddEvidence(vector3(123.4, 567.8, 90.1), "shellcasing", {
    weapon = "WEAPON_PISTOL",
    shooter = "char1:abc123",
})

CreateFile(source, file)

Creates a case file.

exports.pickle_policejob:CreateFile(source, {
    title = "Robbery on Vinewood",
    content = "<p>Suspect fled north...</p>",
})

UpdateFile(source, id, file)

Updates an existing case file.

exports.pickle_policejob:UpdateFile(source, fileId, { content = "<p>Updated notes...</p>" })

DeleteFile(source, id)

Deletes a case file.

exports.pickle_policejob:DeleteFile(source, fileId)

---

Player forensics / medical

GetPlayerEvidence(source, isCreatingFile)

Returns aggregated evidence/identifiers for a player.

local evidence = exports.pickle_policejob:GetPlayerEvidence(source, true)

GetPlayerDNA(source)

Returns the player's DNA record.

local dna = exports.pickle_policejob:GetPlayerDNA(targetSrc)

GetPlayerBAC(source)

Returns the player's blood alcohol content.

local bac = exports.pickle_policejob:GetPlayerBAC(targetSrc)
if bac and bac > 0.08 then print("Over the limit") end

GetPlayerBloodTest(source)

Returns the player's blood test result.

local blood = exports.pickle_policejob:GetPlayerBloodTest(targetSrc)

GetPlayerGSR(source)

Returns the player's gunshot residue result.

local gsr = exports.pickle_policejob:GetPlayerGSR(targetSrc)

---

Client exports

Duty / department state

IsPlayerOnDuty()

Returns the local player's duty state.

if not exports.pickle_policejob:IsPlayerOnDuty() then return end

GetCurrentDepartment()

Returns the local player's current department object (or nil).

local dept = exports.pickle_policejob:GetCurrentDepartment()

GetLocalDepartments()

Returns the table of departments synced to this client.

local departments = exports.pickle_policejob:GetLocalDepartments()
for id, dept in pairs(departments) do print(id, dept.label) end

---

Actions / handcuffs

IsHandcuffed()

Returns true if the local player is handcuffed.

if exports.pickle_policejob:IsHandcuffed() then return end

UncuffPlayer()

Uncuffs the local player.

exports.pickle_policejob:UncuffPlayer()