All resources

rsg-mdt — Developer Docs#

Dependencies#

  • rsg-core — callbacks, notify, locales (@rsg-core/shared/locale.lua)
  • rsg-target — fines payment NPC interaction
  • oxmysql — database
  • No ox_lib. The fines payment NPC menu and confirm dialogs are NUI (web/components/FinesClerk.tsx).

ox_lib migration (v2.1.0)#

Was (ox_lib)Now
@ox_lib/init.lua + shared/locale.lua (lib.loadJson)@rsg-core/shared/locale.lua, setr rsg:locale <lang>
lib.notifyRSGCore.Functions.Notify
lib.callback.register (server)RegisterCallback(name, fn) → RSGCore.Functions.CreateCallback (see shared/callbacks.lua)
lib.callback.register (client)RegisterClientCallback(name, fn) → RSGCore.Functions.CreateClientCallback
lib.callback.awaitRSGCore.Functions.AwaitCallback(name, nil, ...)
lib.callback(name, false, cb, ...)RSGCore.Functions.TriggerCallback(name, cb, ...)
lib.addKeybindraw-key thread using Config.Settings.keybind (virtual-key code, default 0x76 = F7)
exports.ox_targetexports['rsg-target']

shared/callbacks.lua lets handlers keep return value style; the bridge forwards returns to cb(). | lib.registerContext/showContext/alertDialog | NUI fines clerk (v2.2.0) |

shared/locale.lua is no longer loaded and can be deleted.

Callbacks#

Server callbacks are registered in server/*.lua under the rsg-mdt:server:* namespace; client callback rsg-mdt:roleSync:getLocalState in client/roleSync.lua.

Config#

  • Config.Settings.command — chat command (default mdt)
  • Config.Settings.keybind — virtual-key code or nil to disable

Fines clerk NUI#

Client → NUI messages: openFinesClerk, updateFinesClerk, closeFinesClerk with { title, fines = [{ id, amount, timeLeft, overdue }], total, labels } (labels are sent from Lua locales). NUI → client callbacks: finesClerkPay { fineId }, finesClerkPayAll, finesClerkClose. Payment is validated server-side in rsg-mdt:server:payFine (ownership, status, cash).

Push-to-talk#

Config.AllowPushToTalkWhileOpen / Config.PushToTalkControls. Both MDT (client/nui.lua NUI.SetFocus) and the fines clerk route focus through a helper that uses SetNuiFocusKeepInput and a per-frame control whitelist.

Building the UI#

cd web && npm install && npm run build → outputs web/dist.

Locales#

locales/*.json — en, de, el, es, fr, ja, nl, pl, pt-br, ro (required set) plus pt, it, ru, tr. All files share the same 147 keys. Plural suffix arguments (%s after day/hour/second) are English-only; non-English files consume them with %.0s so argument order stays intact.

rsg-economy integration#

Config.Economy = { Enabled, FineRegion }. In rsg-mdt:server:payFine, after the money is removed and the fine marked paid, the server calls exports['rsg-economy']:DepositTreasury(region, totalAmount, 'fine #<id>', citizenid). region is FineRegion or GetRegionAt(player position). A player further than the rsg-economy region radius from every town adds nothing to a treasury. Skipped when rsg-economy is not started.

<!-- BEGIN AUTO-REFERENCE (generated from the code; re-run the generator instead of editing by hand) -->

Technical reference#

Generated from the source of rsg-mdt 3.1.0. Names, arguments and defaults below are read straight from the code.

Dependencies#

rsg-core, rsg-target, oxmysql

Database#

Tables: mdt_records, mdt_warrants, mdt_bolos, mdt_reports, mdt_report_comments, mdt_citizen_profiles, mdt_staff, mdt_roles, mdt_audit_logs, mdt_charge_templates, mdt_issued_charges, mdt_charge_attachments, mdt_fines.

Tables are created automatically on start while Config.AutoDatabase = true (default). Nothing is ever dropped or overwritten. For a manual install set Config.AutoDatabase = false and import sql/mdt.sql once.

-- shared/config.lua
Config.AutoDatabase = true -- false = import the SQL file yourself

Configuration#

OptionDefaultNotes
Config.AutoDatabasetruebuild the database tables automatically on start (set false and import sql/mdt.sql for a manual install)
Config.LawJobstable============================================
Config.Settingstable============================================
Config.IncidentTypestable============================================
Config.Defaultstable============================================
Config.Finestable============================================
Config.Jailtable
Config.AllowPushToTalkWhileOpentrueWhile NUI is open, block game controls but allow push-to-talk.
Config.PushToTalkControlstable
Config.EconomytableA paid fine is deposited into the treasury of the town nearest to the player (rsg-economy GetRegionAt).

Exports#

Server

ExportArgumentsFile
getChargeAttachmentschargeIdserver/chargeAttachments.lua
getReportsWithChargesreportIdserver/chargeAttachments.lua
getChargeTemplates``server/charges.lua
createOrUpdateFine``server/fines.lua
getCitizenFines``server/fines.lua
getUnpaidFines``server/fines.lua
hasAccess``server/main.lua
hasPermission``server/main.lua
getPermissions``server/main.lua
getLawJobs``server/main.lua
getSettings``server/main.lua
getConfigVersion``server/main.lua
reloadConfig``server/main.lua
getPlayerRolesourceserver/roleSync.lua
getAllPlayerRoles``server/roleSync.lua
getValidatedLawJobs``server/roleSync.lua
isLawJobjobNameserver/roleSync.lua
hasPermissionsource, permissionserver/roleSync.lua
isAdminsourceserver/roleSync.lua
forceRefreshRoles``server/roleSync.lua
isStaffMember``server/staff.lua
hasAdminPermission``server/staff.lua
getStaffPermissionscitizenidserver/staff.lua

Client

ExportArgumentsFile
hasUnpaidFines``client/fines.lua
getTotalFinesAmount``client/fines.lua
getPlayerFines``client/fines.lua
hasAccess``client/main.lua
getPermissions``client/main.lua
hasPermission``client/main.lua
getJobLabel``client/main.lua
refreshAccess``client/main.lua
getMyRole``client/roleSync.lua
getAllRoles``client/roleSync.lua
getConfigVersion``client/roleSync.lua
isLawOfficer``client/roleSync.lua
hasRolePermission``client/roleSync.lua
isAdmin``client/roleSync.lua
getJobInfo``client/roleSync.lua
requestRoleSync``client/roleSync.lua
validateLocalState``client/roleSync.lua
attemptLocalOverride``client/roleSync.lua
-- example
local result = exports['rsg-mdt']:getChargeAttachments(chargeId)

Callbacks#

CallbackSideArgumentsFile
rsg-mdt:server:getAvailableReportsForAttachmentserversource, searchQueryserver/chargeAttachments.lua
rsg-mdt:server:attachReportsToChargeserversource, dataserver/chargeAttachments.lua
rsg-mdt:server:removeAttachmentFromChargeserversource, dataserver/chargeAttachments.lua
rsg-mdt:server:getChargeAttachmentsserversource, chargeIdserver/chargeAttachments.lua
rsg-mdt:server:getReportsWithChargesserversource, reportIdserver/chargeAttachments.lua
rsg-mdt:server:getChargeTemplatesserversourceserver/charges.lua
rsg-mdt:server:addChargeTemplateserversource, dataserver/charges.lua
rsg-mdt:server:updateChargeTemplateserversource, dataserver/charges.lua
rsg-mdt:server:deleteChargeTemplateserversource, idserver/charges.lua
rsg-mdt:server:issueChargesserversource, dataserver/charges.lua
rsg-mdt:server:submitChargesserversource, dataserver/charges.lua
rsg-mdt:server:getIssuedChargesserversource, citizenidserver/charges.lua
rsg-mdt:server:getAllIssuedChargesserversource, searchQueryserver/charges.lua
rsg-mdt:server:getChargeDetailsserversource, chargeIdserver/charges.lua
rsg-mdt:server:jailPlayerserversource, dataserver/charges.lua
rsg-mdt:server:getJailConfigserversourceserver/charges.lua
rsg-mdt:server:getCitizenJailTotalsserversource, citizenidserver/charges.lua
rsg-mdt:server:commitChargesserversource, dataserver/charges.lua
rsg-mdt:server:getCitizenFinesserversource, citizenidserver/fines.lua
rsg-mdt:server:getUnpaidFinesserversource, citizenidserver/fines.lua
rsg-mdt:server:payFineserversource, fineIdserver/fines.lua
rsg-mdt:server:getPlayerFinesserversourceserver/fines.lua
rsg-mdt:server:hasUnpaidFinesserversourceserver/fines.lua
rsg-mdt:server:getUnpaidFinesCountserversource, citizenidserver/fines.lua
rsg-mdt:server:getAllUnpaidFinesserversourceserver/fines.lua
rsg-mdt:server:markFineOverdueserversource, fineIdserver/fines.lua
rsg-mdt:server:markFinePaidserversource, fineIdserver/fines.lua
rsg-mdt:server:getAllCitizensserversourceserver/main.lua
rsg-mdt:server:searchCitizensserversource, queryserver/main.lua
rsg-mdt:server:getCitizenserversource, citizenidserver/main.lua
rsg-mdt:server:setProfilePictureserversource, dataserver/main.lua
rsg-mdt:server:getRecordsserversource, citizenidserver/main.lua
rsg-mdt:server:addRecordserversource, dataserver/main.lua
rsg-mdt:server:deleteRecordserversource, recordIdserver/main.lua
rsg-mdt:server:getWarrantsserversourceserver/main.lua
rsg-mdt:server:addWarrantserversource, dataserver/main.lua
rsg-mdt:server:updateWarrantserversource, dataserver/main.lua
rsg-mdt:server:deleteWarrantserversource, warrantIdserver/main.lua
rsg-mdt:server:getBolosserversourceserver/main.lua
rsg-mdt:server:addBoloserversource, dataserver/main.lua
rsg-mdt:server:deleteBoloserversource, boloIdserver/main.lua
rsg-mdt:server:getReportsserversourceserver/main.lua
rsg-mdt:server:getReportserversource, reportIdserver/main.lua
rsg-mdt:server:createReportserversource, dataserver/main.lua
rsg-mdt:server:deleteReportserversource, reportIdserver/main.lua
rsg-mdt:server:getReportCommentsserversource, reportIdserver/main.lua
rsg-mdt:server:addReportCommentserversource, dataserver/main.lua
rsg-mdt:server:getOfficerInfoserversourceserver/main.lua
rsg-mdt:server:getStatsserversourceserver/main.lua
rsg-mdt:server:getIncidentTypesserversourceserver/main.lua
rsg-mdt:roleSync:getRolesserversourceserver/roleSync.lua
rsg-mdt:roleSync:getMyRoleserversourceserver/roleSync.lua
rsg-mdt:roleSync:getConfigVersionserversourceserver/roleSync.lua
rsg-mdt:roleSync:getValidatedJobsserversourceserver/roleSync.lua
rsg-mdt:server:getConfigRolesserversourceserver/roleSync.lua
rsg-mdt:server:getStaffserversourceserver/staff.lua
rsg-mdt:server:getRolesserversourceserver/staff.lua
rsg-mdt:server:addStaffserversource, dataserver/staff.lua
rsg-mdt:server:removeStaffserversource, citizenidserver/staff.lua
rsg-mdt:server:updateStaffPermissionsserversource, dataserver/staff.lua
rsg-mdt:server:createRoleserversource, dataserver/staff.lua
rsg-mdt:server:updateRoleserversource, dataserver/staff.lua
rsg-mdt:server:deleteRoleserversource, roleNameserver/staff.lua
rsg-mdt:server:getAuditLogsserversource, dataserver/staff.lua
rsg-mdt:server:searchCitizensForStaffserversource, queryserver/staff.lua
rsg-mdt:server:assignLawJobserversource, dataserver/staff.lua
rsg-mdt:server:getLawJobsserversourceserver/staff.lua
rsg-mdt:server:getJobGradesserversource, jobNameserver/staff.lua
rsg-mdt:server:searchPlayersForJobserversource, queryserver/staff.lua
rsg-mdt:server:updateOfficerDepartmentserversource, dataserver/staff.lua
rsg-mdt:server:getOfficersserversourceserver/staff.lua
rsg-mdt:server:getJobPlayerCountsserversourceserver/staff.lua
rsg-mdt:server:syncStaffFromJobsserversource, filterJobserver/staff.lua
-- client side
RSGCore.Functions.TriggerCallback('rsg-mdt:server:getAvailableReportsForAttachment', function(result)
    -- use result
end)

Events#

Server events can be fired by any client, so every handler re-validates the player, the arguments and any permission, distance or cooldown on the server. Never add a reward to a handler without those checks.

EventSideArgumentsFile
rsg-mdt:client:updatePlayerFinesclientfinesclient/fines.lua
rsg-mdt:client:finePaidclientdataclient/fines.lua
rsg-mdt:client:finePaymentResultclientdataclient/fines.lua
RSGCore:Client:OnPlayerLoadedclient``client/fines.lua
rsg-mdt:client:fineStatusUpdatedclientdataclient/fines.lua
rsg-mdt:client:playerFinePaidclientdataclient/fines.lua
rsg-mdt:client:accessResultclientdataclient/main.lua
rsg-mdt:client:permissionResultclientdataclient/main.lua
rsg-mdt:client:configUpdatedclientversionclient/main.lua
rsg-mdt:client:notifyclientdataclient/main.lua
rsg-mdt:client:receiveConfigclientdataclient/main.lua
rsg-mdt:client:staffUpdatedclientdataclient/main.lua
rsg-mdt:client:rolesUpdatedclientdataclient/main.lua
RSGCore:Player:SetPlayerDataclientdataclient/main.lua
rsg-mdt:client:jobAssignedclientdataclient/main.lua
rsg-mdt:client:departmentUpdatedclientdataclient/main.lua
rsg-mdt:client:chargesUpdatedclientdataclient/main.lua
rsg-mdt:roleSync:receiveRolesclientdataclient/roleSync.lua
rsg-mdt:roleSync:receiveMyRoleclientroleDataclient/roleSync.lua
rsg-mdt:roleSync:roleUpdatedclientdataclient/roleSync.lua
rsg-mdt:roleSync:forceRefreshclientdataclient/roleSync.lua
rsg-mdt:roleSync:stateMismatchclientdataclient/roleSync.lua
rsg-mdt:roleSync:refreshCompleteclientdataclient/roleSync.lua
rsg-mdt:server:syncPlayerFinesserver``server/fines.lua
rsg-mdt:server:checkAccessserver``server/main.lua
rsg-mdt:server:checkPermissionserverpermissionserver/main.lua
rsg-mdt:server:reloadConfigserver``server/main.lua
rsg-mdt:server:getConfigserver``server/main.lua
rsg-mdt:roleSync:requestRolesserver``server/roleSync.lua
rsg-mdt:roleSync:requestMyRoleserver``server/roleSync.lua
rsg-mdt:roleSync:validateLocalStateserverlocalRoleserver/roleSync.lua
rsg-mdt:roleSync:adminForceRefreshserver``server/roleSync.lua
RSGCore:Server:PlayerLoadedserverPlayerserver/roleSync.lua
RSGCore:Server:OnJobUpdateserverjobserver/roleSync.lua
-- from a client script
TriggerServerEvent('rsg-mdt:server:syncPlayerFines')
-- from a server script
TriggerClientEvent('rsg-mdt:client:updatePlayerFines', source, fines)

Commands#

CommandNotesFile
/mdtclient/main.lua

Locales#

Language files in locales/: de, el, en, es, fr, it, ja, nl, pl, pt, pt-br, ro, ru, tr. Set the language with setr rsg:locale "en".

<!-- END AUTO-REFERENCE -->