Integrations#

koja-mdt talks to the rest of your server in three ways:

Editable files#

Jail systems#

When an officer processes a suspect (or a judge applies a sentence) the MDT calls Integrations.Jail(target, months, reason, officerSrc, context). It picks an adapter based on Config.Processing.jailSystem:

When no adapter handles the request the MDT fires koja-mdt:server:jailPlayer with target, months, reason, officerSrc and still records the sentence.

{
    resource = 'my-prison',
    jail = function(target, months, reason)
        return exports['my-prison']:Jail(target, months, reason) ~= false
    end,
    release = function(target, identifier, reason)
        return exports['my-prison']:Release(identifier) ~= false
    end,
    isJailed = function(target)
        return exports['my-prison']:IsJailed(target) == true
    end,
},

AddEventHandler('koja-mdt:server:jailPlayer', function(target, months, reason)
    StartSentence(target, months, reason)
end)

AddEventHandler('koja-mdt:server:releasePlayer', function(target, identifier, reason)
    EndSentence(identifier)
end)

function OnSentenceEnded(src, escaped)
    exports['koja-mdt']:ReportRelease(src, escaped and 'escaped' or 'released', { by = 'My Prison' })
end

exports['koja-mdt']:ReportJail(src, months, { reason = reason, facility = 'Bolingbroke', officer = officerSrc })
exports['koja-mdt']:ReportRelease(src, 'released', { by = 'Bolingbroke' })

The record shows the adapter in system. Every 30 seconds the MDT closes records whose time is up (Config.Custody.autoRelease, skipped for systems listed in Config.Custody.trackedSystems), and for adapters with isJailed it also closes records of online inmates the adapter no longer holds.

Fines and money#

Processing, citations paid in game and impound fees all call Integrations.Fine(target, amount, reason, officerSrc). The default implementation:

• takes the money from Config.Processing.fineAccount (default bank), falling back to cash when the account is short;
• allows a negative balance when Config.Processing.allowNegativeBalance = true;
• pays the amount to Config.Processing.fineSociety through Integrations.PaySociety (esx_addonaccount, Renewed-Banking, qb-banking or qb-management).

Replace the function body to use your own banking. It must return true only when the money was taken.

function Integrations.Fine(target, amount, reason, officerSrc)
    if amount <= 0 then return true end
    local ok = exports['my-bank']:Charge(target, amount, reason)
    if ok then exports['my-bank']:AddToSociety('police', amount) end
    return ok == true
end

Medical bills use Integrations.ChargeMedicalBill(target, amount, reason, medicSrc, bill) and Integrations.PayMedicalSociety(amount) (Config.Ems.billing.account and Config.Ems.billing.society). When koja-ambulance is running with billing = 'ambulance' the bill is sent as an ambulance invoice instead.

If your bank charges citizens itself, mark citations paid with the export:

exports['koja-mdt']:PayCitation(citationId, { author = 'Maze Bank' })

Impound and garages#

MDT impounds call Integrations.Impound(plate, data) with Config.Custody.impoundSystem:

Every MDT impound also fires koja-mdt:server:impoundVehicle and every MDT release koja-mdt:server:releaseImpound. To add your garage, add an entry to impoundAdapters:

{
    id = 'my-garage',
    resource = 'my-garage',
    impound = function(plate, data)
        return exports['my-garage']:SetImpounded(plate, true, data.fee) ~= false
    end,
    release = function(plate, data)
        return exports['my-garage']:SetImpounded(plate, false) ~= false
    end,
},

A garage or tow script that impounds on its own reports it, and checks the MDT before handing a car out:

exports['koja-mdt']:ReportImpound(plate, { reason = 'Abandoned', fee = 750, hours = 12, lot = 'davis' })
if exports['koja-mdt']:IsImpounded(plate) then return end

Phones#

function ClientIntegrations.GetPhoneNumber()
    return exports['my-phone']:GetNumber()
end

Other dispatch systems#

exports['koja-mdt']:registerHook('dispatch:create', function(call)
    exports['other-cad']:PushCall({ id = call.id, code = call.code, title = call.title, coords = call.coords })
end)

koja-police and koja-ambulance are detected automatically (Config.Police, Config.Ems.ambulance): their dispatch, duty and billing are linked without code.

Frameworks#

ESX, QBCore and Qbox work out of the box. When KojaLib.Framework is anything else, the MDT uses the Custom table in editable/server/framework.lua. Fill it for your framework:

Bridge.ChargeOffline(identifier, amount, account, reason) is optional: when present, citations can be paid from the web portal while the citizen is offline.

Integrations.CitizenImage(identifier) can return a photo URL for citizens that have no MDT photo (for example from your character creator).

koja-lib#

koja-mdt requires koja-lib and uses it for everything framework specific: player identifiers, jobs and grades (KojaLib.Server.GetPlayerIdentifier, GetJobInfo, GetJobs), money (getMoney, removeMoney), job changes (SetJob, SetOfflineJob), notifications (KojaLib.Server.SendNotify, KojaLib.Client.SendNotify) and Discord webhooks (LogMessage). KojaLib.Framework (esx, qb, custom) selects the bridge. The same helpers are available in the editable files, so a custom adapter does not need to know the framework:

function Integrations.CitizenImage(identifier)
    local src = KojaLib.Server.GetSourceByIdentifier(identifier)
    return src and exports['my-mugshots']:Get(src) or nil
end