Server Functions

This page will explain all exported functions from the SonoranCAD Core that can be used on the server side

CadIsPlayerLinked

Checks if a specific CAD API ID exists by sending a request to the API and executing a callback with the result.

exports.sonorancad.CadIsPlayerLinked(apiId, callback)

Parameter

Type

Description

apiId

string

The CAD API ID to check. If empty or nil, the function assumes the ID does not exist.

callback

function

A function executed after the check completes. Receives a single parameter: exists (boolean).

-- Example: Checking if a CAD API ID exists
local function onApiIdCheck(exists)
    if exists then
        print("API ID exists!")
    else
        print("API ID does not exist.")
    end
end

exports.sonorancad.CadIsPlayerLinked("123456", onApiIdCheck)  -- Output depends on API response
exports.sonorancad.CadIsPlayerLinked("", onApiIdCheck)        -- Output: "API ID does not exist."

GetPluginConfig

Provides access to a specific plugin's configuration using the plugin name.

exports.sonorancad.GetPluginConfig(submoduleName)

Parameter

Type

Description

submoduleName

string

The name of the submodule whose configuration is to be retrieved.

-- Example: Retrieving a plugin's configuration
local pluginConfig = exports.sonorancad.GetPluginConfig("callcommands")

if pluginConfig then
    print("Plugin Config:", json.encode(pluginConfig))
else
    print("Plugin not found or no configuration available.")
end

GetUnitByPlayerId

Retrieves the unit information associated with a player based on their identifiers.

exports.sonorancad.GetUnitByPlayerId(player)

Parameter

Type

Description

player

PlayerSource

The player ID for whom the associated unit is being retrieved.

-- Example: Getting the unit associated with a player
local unit = GetUnitByPlayerId(1)

if unit then
    print("Unit found:", json.encode(unit))
else
    print("No unit associated with this player.")
end

GetUnitCache

Returns the global UnitCache table containing unit data.

exports.sonorancad.GetUnitCache()

None

-- Example: Retrieving and inspecting the UnitCache
local unitCache = exports.sonorancad.GetUnitCache()

if next(unitCache) then
    print("UnitCache contains data:", json.encode(unitCache))
else
    print("UnitCache is empty or uninitialized.")
end

registerEndpoints

Registers API endpoints for use with the sonorancad resource.

exports.sonorancad.registerEndpoints()

None

addBlip

Adds a new blip to the map using the SonoranCAD integration.

exports.sonorancad.addBlip(coords, colorHex, subType, toolTip, icon, dataTable, cb)

Parameter

Type

Description

coords

vec2 (table)

A table containing x and y coordinates for the blip location.

colorHex

string

The hexadecimal color code (e.g., "#FF0000") for the blip.

subType

string

The subtype of the blip (e.g., police, fire, etc.).

toolTop

string

The tooltip text that appears when hovering over the blip.

icon

string

The icon for the blip (e.g., a specific image or identifier for visual context).

dataTable

table

Additional data associated with the blip, stored in a custom table.

cb

function

(Optional) A callback function executed with the API response.

-- Example: Adding a new blip to the map
exports.sonorancad.addBlip(
    { x = 123.45, y = 678.90 },
    "#FF0000",
    "police",
    "Police Station",
    "police-icon",
    { info = "Main Headquarters" },
    function(response)
        if response.success then
            print("Blip successfully added!")
        else
            print("Failed to add blip:", response.error)
        end
    end
)

addBlips

Adds multiple blips to the map using the SonoranCAD integration.

exports.sonorancad.addBlips(blips, cb)

Parameter

Type

Description

blips

table

A table containing multiple blip data objects to be added. (See addBlip for blip structure)

cb

function

(Optional) A callback function executed with the API response.

-- Example: Adding multiple blips to the map
local blips = {
    {
        blip = {
            id = -1,
            subType = "police",
            coordinates = { x = 123.45, y = 678.90 },
            icon = "police-icon",
            color = "#FF0000",
            tooltip = "Police Station",
            data = { info = "Main Headquarters" }
        }
    },
    {
        blip = {
            id = -1,
            subType = "fire",
            coordinates = { x = 321.65, y = 987.10 },
            icon = "fire-icon",
            color = "#FFA500",
            tooltip = "Fire Department",
            data = { info = "Fire HQ" }
        }
    }
}

exports.sonorancad.addBlips(blips, function(response)
    if response.success then
        print("Blips successfully added!")
    else
        print("Failed to add blips:", response.error)
    end
end)

removeBlip

Removes one or more blips from the map using the SonoranCAD integration.

exports.sonorancad.removeBlip(ids, cb)

Parameter

Type

Description

ids

table

A table containing the IDs of the blips to be removed.

cb

function

(Optional) A callback function executed with the API response.

-- Example: Removing blips by their IDs
local blipIds = { 101, 102, 103 }

exports.sonorancad.removeBlip(blipIds, function(response)
    if response.success then
        print("Blips successfully removed!")
    else
        print("Failed to remove blips:", response.error)
    end
end)

modifyBlipd

Modifies an existing blip's data on the map using the SonoranCAD integration.

exports.sonorancad.modifyBlipd(blipId, dataTable)

Parameter

Type

Description

blipId

number

The unique ID of the blip to be modified.

dataTable

table

A table containing the new data for the blip. See addBlip for blip data structure

-- Example: Modifying an existing blip's data
local blipId = 101
local newData = {
    color = "#00FF00",
    tooltip = "Updated Tooltip",
    coordinates = { x = 200.0, y = 300.0 }
}

exports.sonorancad.modifyBlipd(blipId, newData)
print("Blip modification request sent.")

getBlips

Fetches the list of all active blips from the SonoranCAD system.

exports.sonorancad.getBlips(cb)

Parameter

Type

Description

cb

function

(Optional) A callback function executed with the API response containing the blips.

-- Example: Fetching all active blips
exports.sonorancad.getBlips(function(response)
    if response.success then
        print("Active Blips:", json.encode(response.data))
    else
        print("Failed to fetch blips:", response.error)
    end
end)

removeWithSubtype

Removes all blips of a specific subtype from the map using the SonoranCAD system.

exports.sonorancad.removeWithSubtype(subType, cb)

Parameter

Type

Description

subType

string

The subtype of the blips to be removed (e.g., police, fire, etc.).

cb

function

(Optional) A callback function executed with the API response containing the blips.

-- Example: Removing all police blips
exports.sonorancad.removeWithSubtype("police", function(response)
    if response.success then
        print("Police blips successfully removed!")
    else
        print("Failed to remove blips:", response.error)
    end
end)

call911

The call911 function facilitates the creation of a 911 emergency call within the SonoranCAD system by sending a structured API request.

exports.sonorancad.call911(caller, location, description, postal, plate, cb, coords, customMeta, deleteAfter)

Parameter

Type

Description

caller

string

Name of the individual initiating the call.

location

string

Description of the call's location (e.g., street address).

description

string

Detailed information about the emergency situation.

postal

string

Postal code corresponding to the call's location.

plate

string

(Optional) License plate number associated with the call, if applicable.

cb

function

(Optional) Callback function to handle the API response.

coords

table

A table containing the X and Y coordinates of the emergency call's location, typically sourced from in-game player or vehicle position. This is used to place the call accurately on the live map in CAD systems or dispatch plugins.

customMeta

table

A flexible table for including any custom metadata relevant to the emergency call.

deleteAfter

int

Number of minutes to automatically remove the call from CAD after

-- Example: Initiating a 911 call
exports.sonorancad.call911(
    "Jane Doe",
    "1234 Elm Street",
    "There is a fire in the building.",
    "56789",
    nil,
    function(response)
        if response.success then
            print("911 call successfully placed.")
        else
            print("Failed to place 911 call:", response.error)
        end
    end,
    { x = 84.49, y = 953.593 },
    {
        someMetaData = "yes this is metadata"
    } 
)

addTempBlipData

Temporarily modifies a blip's data in the SonoranCAD system and then reverts it back to its original data after a specified duration.

exports.sonorancad.addTempBlipData(blipId, blipData, waitSeconds, returnToData)

Parameter

Type

Description

blipId

number

The unique ID of the blip to modify.

blipData

table

A table containing the temporary data to apply to the blip. See addBlip for blip data structure

waitSeconds

number

The duration in seconds for which the temporary data will be applied.

returnToData

table

A table containing the original data to revert the blip to after the duration expires. See addBlip for blip data structure

-- Example: Temporarily modifying a blip's color and tooltip
local tempData = {
    color = "#FF0000",
    tooltip = "Temporary Alert"
}

local originalData = {
    color = "#00FF00",
    tooltip = "Original Tooltip"
}

exports.sonorancad.addTempBlipData(101, tempData, 10, originalData)
print("Blip temporarily modified; it will revert in 10 seconds.")

addTempBlipColor

Temporarily changes a blip's color in the SonoranCAD system and reverts it to its original color after a specified duration.

exports.sonorancad.addTempBlipData(blipId, color, waitSeconds, returnToColor)

Parameter

Type

Description

blipId

number

The unique ID of the blip to modify.

color

string

The temporary hexadecimal color code to apply to the blip (e.g., "#FF0000")

waitSeconds

number

The duration in seconds for which the temporary data will be applied.

returnToColor

string

The original hexadecimal color code to revert the blip to after the duration expires

-- Example: Temporarily changing a blip's color to red
local tempColor = "#FF0000"
local originalColor = "#00FF00"

exports.sonorancad.addTempBlipColor(101, tempColor, 10, originalColor)
print("Blip color temporarily changed; it will revert in 10 seconds.")

remove911

Removes an active 911 call from the SonoranCAD system.

exports.sonorancad.remove911(callId)

Parameter

Type

Description

callId

string

The unique ID of the 911 call to be removed.

addCallNote

Adds a note to an existing 911 call in the SonoranCAD system.

exports.sonorancad.addCallNote(callId, note)

Parameter

Type

Description

callId

string

The unique ID of the 911 call to be removed.

note

string

The content of the note to be added, typically describing the caller.

-- Example: Adding a note to an existing 911 call
local callId = "12345"
local note = "Caller reported a fire at the intersection of 5th and Main."

exports.sonorancad.addCallNote(callId, note)
print("Request to add note to 911 call sent.")

setCallPostal

Updates the postal code of an existing 911 call in the SonoranCAD system.

exports.sonorancad.setCallPostal(callId, postal)

Parameter

Type

Description

callId

string

The unique ID of the 911 call to be removed.

postal

string

The new postal code to assign to the 911 call.

-- Example: Updating the postal code of an existing 911 call
local callId = "12345"
local postal = "56789"

exports.sonorancad.setCallPostal(callId, postal)
print("Request to update postal code sent.")

performLookup

Performs a lookup in the SonoranCAD system for information associated with a license plate.

exports.sonorancad.performLookup(plate, cb)

Parameter

Type

Description

plate

string

The license plate number to look up in the SonoranCAD system.

cb

function

(Optional) A callback function executed with the API response.

-- Example: Performing a lookup for a license plate
local plate = "ABC123"

exports.sonorancad.performLookup(plate, function(response)
    if response.success then
        print("Lookup successful:", json.encode(response.data))
    else
        print("Lookup failed:", response.error)
    end
end)

createDispatchCall

Creates a dispatch call in SonoranCAD

exports.sonorancad.createDispatchCall(origin, status, priority, block, address, postal, title, code, primary, trackPrimary, description, notes, metaData, units, cb)

Parameter

Type

Description

origin

number

Source of the dispatch call (see ORIGIN enum in SonoranCAD documentation). Typically 0

status

number

Initial call status (see STATUS enum). Typically 0

priority

number

Call priority: 1 (high), 2 (medium), 3 (low).

block

string

Block or unit number of the incident location.

address

string

Full address or street description of the incident.

postal

string

Postal code corresponding to the call’s location.

title

string

Short title of the dispatch call (e.g., "Traffic Stop").

code

string

CAD signal or code (e.g., "10-39 - Traffic Stop").

primary

number

Identifier of the primary unit assigned to the call.

trackPrimary

boolean

Whether to track the primary unit on the live map.

description

string

Detailed description of the situation.

notes

array

Array of note objects related to the call. Optional.

metaData

array

Custom key-value metadata for internal tracking or display. Optional.

units

array

Array of unit API IDs (e.g., Steam hex IDs) to assign to the call.

cb

function

Callback function to handle the API response.

-- Example: Creating a dispatch call
createDispatchCall(
    0,                              -- origin
    0,                              -- status
    1,                              -- priority (1 = High)
    "123",                          -- block number
    "1234 Elm Street",             -- address
    "56789",                        -- postal
    "Structure Fire",              -- title
    "10-70 - Structure Fire",      -- code
    456,                            -- primary unit ID
    true,                           -- trackPrimary
    "Caller reports flames visible from second floor window.", -- description
    {},                             -- notes (optional)
    { severity = "high", buildingType = "residential" },       -- custom metaData
    { "STEAM:110000112345678" },    -- units (API IDs)
    function(response)
        if response.success then
            print("Dispatch call successfully created.")
        else
            print("Failed to create dispatch call:", response.error)
        end
    end
)

cadNameLookup

Perform a name lookup in CAD (Requires "Lookups" submodule to be enabled)

This function will not work if you do not have the "Lookups" submodule enabled. The submodule is enabled by default.

exports.sonorancad.cadNameLookup(first, last, mi, callback, autoLookup)

Parameter

Type

Description

first

string

First Name

last

string

Last Name

mi

string

Middle Initial

callback

function

Callback function to handle the API response.

autoLookup

string

API ID of the user to perform a lookup via API ID rather than name

cadPlateLookup

Perform a plate lookup in CAD (Requires "Lookups" submodule to be enabled)

This function will not work if you do not have the "Lookups" submodule enabled. The submodule is enabled by default.

exports.sonorancad.cadPlateLookup(plate, basicFlag, callback, autoLookup)

Parameter

Type

Description

plate

string

Plate number to lookup

basicFlag

null

Depreciated parameter, can be set to nil

callback

function

Callback function to handle the API response.

autoLookup

string

API ID of the user to perform a lookup via API ID rather than name

getAllWarrantsAndBolos

Retrieve all active and inactive warrants and bolos with pagination support

exports.sonorancad.getAllWarrantsAndBolos(options, cb)

Parameter

Type

Description

options

table

Options for pagination and filtering. If omitted, defaults are used (Optional)

options.pageSize / options.limit

number

Page size per API request. Default 100

options.offset

number

Starting offset for pagination. Default 0

options.maxPages / options.pageLimit / options.pages

number

Max number of pages to fetch before stopping (caps total results). Default: no cap

options.statuses / options.status

table | string | number

Status filter(s). Defaults to {0, 1} (open + closed). Accepts numeric values or strings: "open", "active", "closed", "inactive", "pending", "approved", "rejected"

options.types

table<number>

Record types to include. Default {2, 3} (Warrant + BOLO)

cb

function

Callback invoked as cb(records, meta) where records is the aggregated list and meta includes paging info or an error.

-- records (array)
{
    {
        id = 12345,
        type = 3, -- BOLO
        name = "BOLO",
        sections = {
            {
                category = 1,
                label = "Flags",
                fields = {
                    { uid = "flags", data = { flags = { "Armed", "Violent" } } }
                }
            },
            {
                category = 0,
                label = "Vehicle Information",
                fields = {
                    { uid = "plate", value = "ABC123" },
                    { uid = "make", value = "Dodge" },
                    { uid = "model", value = "Charger" },
                    { uid = "color", value = "Black" }
                }
            }
        }
    },
    {
        id = 67890,
        type = 2, -- Warrant
        name = "Warrant",
        sections = {
            {
                category = 1,
                label = "Flags",
                fields = {
                    { uid = "flags", data = { flags = { "Felony", "No Bond" } } }
                }
            },
            {
                category = 0,
                label = "Civilian Information",
                fields = {
                    { uid = "first", value = "Jane" },
                    { uid = "last", value = "Doe" },
                    { uid = "dob", value = "01/01/1990" }
                }
            }
        }
    }
}

-- meta
{
    ok = true,
    pages = 2,
    limit = 100,
    offset = 0,
    statuses = { 0, 1 }
}

PreviousShared Functions NextServer Events

Last updated 12 days ago

Was this helpful?

Good night

hashtagCadIsPlayerLinked

hashtagGetPluginConfig

hashtagGetUnitByPlayerId

hashtagGetUnitCache

hashtagregisterEndpoints

hashtagaddBlip

hashtagaddBlips

hashtagremoveBlip

hashtagmodifyBlipd

hashtaggetBlips

hashtagremoveWithSubtype

hashtagcall911

hashtagaddTempBlipData

hashtagaddTempBlipColor

hashtagremove911

hashtagaddCallNote

hashtagsetCallPostal

hashtagperformLookup

hashtagcreateDispatchCall

hashtagcadNameLookup

hashtagcadPlateLookup

hashtaggetAllWarrantsAndBolos

CadIsPlayerLinked

GetPluginConfig

GetUnitByPlayerId

GetUnitCache

registerEndpoints

addBlip

addBlips

removeBlip

modifyBlipd

getBlips

removeWithSubtype

call911

addTempBlipData

addTempBlipColor

remove911

addCallNote

setCallPostal

performLookup

createDispatchCall

cadNameLookup

cadPlateLookup

getAllWarrantsAndBolos