Jobs and services

import { dispatch, prison, mdt, ems, medical, stress, needs, definitions, isPrimeTime } from "@aicore-fivem/lib/server";

Each object here goes through one of ai-core's layers: the script the server runs for that job (an alert system, a prison, an MDT, a death script, a HUD) answers. Your script keeps working when the owner swaps it. While no such script runs, calls fail quietly (false, 0, null).

dispatchCopy Anchor Link

dispatch.alertCopy Anchor Link

Sends a police (or other job) alert. The alert system shows it to the on-duty members of jobs, default the police jobs.

Side: Server · Waits: no

dispatch.alert(alert: DispatchAlert): boolean

local ok = aiLib.dispatch.alert(alert)

DispatchAlertCopy Anchor Link

The type is DispatchAlert.

ReturnsCopy Anchor Link

boolean: true when sent. false when no alert system runs or the alert is invalid.

ExampleCopy Anchor Link

import { dispatch, coordsOf, createLocale } from "@aicore-fivem/lib/server";

const Locale = createLocale();

function storeRobbed(source: number, store: string) {
  dispatch.alert({
    code: "10-90",
    title: Locale("ALERT_STORE_ROBBERY"),
    message: store,
    coords: coordsOf(source),
    source,
    icon: "store",
    priority: "high",
  });
}

prisonCopy Anchor Link

Jail sentences through ai-core, whatever prison script runs.

prison.jailCopy Anchor Link

Sends a loaded player to prison.

Side: Server · Waits: no

prison.jail(source: number, minutes: number, by?: number): boolean

local ok = aiLib.prison.jail(source, minutes, by)

Returns true when jailed, false while no prison runs.

if (!prison.jail(target, 15, officer)) return fail("NO_PRISON");

prison.releaseCopy Anchor Link

Lets a jailed player out.

Side: Server · Waits: no

prison.release(source: number): boolean

local ok = aiLib.prison.release(source)

Returns true when released, false when not jailed or no prison runs.

prison.release(target);

prison.timeLeftCopy Anchor Link

Side: Server · Waits: no

prison.timeLeft(source: number): number

local minutes = aiLib.prison.timeLeft(source)

Returns the minutes of sentence left, 0 when free.

if (prison.timeLeft(source) > 0) return fail("IN_PRISON");

mdtCopy Anchor Link

Police MDT records (fines, warrants, arrests, jail) through ai-core's MDT layer. Nothing is written while no MDT runs.

mdt.recordCopy Anchor Link

Writes a record into the police MDT.

Side: Server · Waits: no

mdt.record(record: MdtRecord): boolean

local ok = aiLib.mdt.record(record)

MdtRecordCopy Anchor Link

The type is MdtRecord.

Returns true when written, false when no MDT runs or it takes no such record.

if (prison.jail(target, 20, officer)) mdt.record({ kind: "jail", target, by: officer, title: "Armed robbery", minutes: 20 });

mdt.providerCopy Anchor Link

Side: Server · Waits: no

mdt.provider(): string | null

local name = aiLib.mdt.provider()

Returns the MDT that records go to, or null.

if (!mdt.provider()) console.log("no MDT: records are skipped");

emsCopy Anchor Link

Medics through ai-core's EMS layer: an EMS script's own count and distress calls, else ai-core's duty counts and alerts.

ems.availableCopy Anchor Link

How many medics are free to take a call.

Side: Server · Waits: no

ems.available(jobs: string[]): number

local count = aiLib.ems.available(jobs)

Returns the number of medics on duty in jobs, leaving out busy ones when a dispatch script knows them.

// Let players respawn at the hospital only when no medic can come.
const canRespawn = ems.available(["ambulance"]) === 0;

ems.distressCopy Anchor Link

Sends a distress call for a player to the medics of call.jobs.

Side: Server · Waits: no

ems.distress(source: number, call: DistressCall): boolean

local ok = aiLib.ems.distress(source, call)

The type is DistressCall.

Returns true when something took the call, false otherwise.

if (!ems.distress(source, { jobs: ["ambulance"], message: "Unconscious" })) return fail("NO_MEDICS");

ems.providerCopy Anchor Link

Side: Server · Waits: no

ems.provider(): string | null

local name = aiLib.ems.provider()

Returns the EMS source the layer uses, "ai-core" for its own duty counts.

console.log(`medics through ${ems.provider()}`);

medicalCopy Anchor Link

Revive, heal and the down state through ai-core's medical layer, whatever death or ambulance script runs. No Lua twin: call ai-core's exports RevivePlayer, HealPlayer, IsPlayerDead.

medical.reviveCopy Anchor Link

Gets a downed player up where they lie.

Side: Server · Waits: no

medical.revive(source: number): boolean

Returns true when revived, false when not down or no death script runs.

if (!medical.revive(target)) return fail("NOT_DOWN");

medical.healCopy Anchor Link

Gives full health to a player who is not down.

Side: Server · Waits: no

medical.heal(source: number): boolean

Returns true when healed, false when no death script runs.

medical.heal(source);

medical.isDeadCopy Anchor Link

Whether the player is down.

Side: Server · Waits: no

medical.isDead(source: number): boolean

Returns true when down; false without a death script. Use it instead of reading the ped's health.

if (medical.isDead(source)) return fail("YOU_ARE_DOWN");

medical.providerCopy Anchor Link

Side: Server · Waits: no

medical.provider(): string | null

Returns the death script that answers (ai-death...), or null when none runs.

console.log(`deaths through ${medical.provider() ?? "nothing"}`);

stressCopy Anchor Link

Players' stress (0 to 100) through ai-core's stress layer, whatever HUD keeps it.

stress.gainCopy Anchor Link

Adds stress points.

Side: Server · Waits: no

stress.gain(source: number, amount: number): boolean

local ok = aiLib.stress.gain(source, amount)

Returns true when added, false when no HUD with stress runs.

stress.gain(source, 5); // after a shootout

stress.relieveCopy Anchor Link

Takes stress points away.

Side: Server · Waits: no

stress.relieve(source: number, amount: number): boolean

local ok = aiLib.stress.relieve(source, amount)

Returns true when taken, false when no HUD with stress runs or amount is 0 or less.

inventory.registerUsableItem("cigarette", (source) => {
  stress.relieve(source, 10);
});

stress.providerCopy Anchor Link

Side: Server · Waits: no

stress.provider(): string | null

local name = aiLib.stress.provider()

Returns the HUD that keeps stress, or null.

if (!stress.provider()) console.log("no HUD keeps stress");

needsCopy Anchor Link

needs.refillCopy Anchor Link

Fills hunger and thirst to full (admin revive, hospital), through the HUD that keeps them, or ai-core's character metadata without one.

Side: Server · Waits: no

needs.refill(source: number): boolean

No Lua twin: call ai-core's export RefillNeeds(source).

Returns true when refilled, false when the player has no character.

if (medical.revive(target)) needs.refill(target);

Job and gang definitionsCopy Anchor Link

definitions.jobCopy Anchor Link

A job's definition as set in ai-core's panel. Each one is read once from ai-core and kept until the panel changes it, so a read is a memory lookup.

Side: Server · Waits: no

definitions.job(name: string): JobDefinition | null

No Lua twin: call ai-core's export GetJobDefinition(name).

Returns JobDefinition (label, type, defaultDuty, listed?, grades), or null when no such job exists.

const label = definitions.job("police")?.label ?? "police";

definitions.gangCopy Anchor Link

Side: Server · Waits: no

definitions.gang(name: string): GangDefinition | null

No Lua twin: call ai-core's export GetGangDefinition(name).

Returns GangDefinition (label, grades), or null.

const gang = definitions.gang("ballas");
if (!gang) return fail("UNKNOWN_GANG");

Prime timeCopy Anchor Link

isPrimeTimeCopy Anchor Link

Whether it is prime time for a job, from ai-core's prime time setting. The hours come from tgiann-policealert while it runs, else from the hours set in ai-core's panel.

Side: Server · Waits: no

isPrimeTime(job?: string): boolean

No Lua twin: call ai-core's export IsPrimeTime(job).

Returns true during prime time.

if (!isPrimeTime("police")) return fail("BANK_CLOSED_FOR_HEISTS");