Prison

Jail calls go through ai-core, never through a prison script's own exports or events (ai-prison included). ai-core forwards each call to the first prison script running: ai-prison, qb-prison, rcore_prison, xt-prison, then tgiann-policejob. While none runs, every call answers false or 0.

JailPlayerCopy Anchor Link

Sends a player to prison for a number of minutes.

Side: Server · Waits: no · Lib: prison.jail

JailPlayer(source: number, minutes: number, by?: number): boolean

local jailed = exports['ai-core']:JailPlayer(target, 20, source)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean: true when the prison script took the player. false when minutes is not above 0, source is not a number, no prison script runs or it refused.

ExampleCopy Anchor Link

import { addCommand, resourceExport } from "@aicore-fivem/lib/server";

const core = resourceExport("ai-core");

addCommand("jail", {
  help: "Jails a player",
  params: [{ name: "id", type: "playerId" }, { name: "minutes", type: "number" }],
  restricted: "ai.job.police",
}, (source, args) => {
  if (core.GetDutyJob(source) !== "police") return;
  core.JailPlayer(args.id, args.minutes, source);
});

ReleasePlayerCopy Anchor Link

Lets a player out of prison.

Side: Server · Waits: no · Lib: prison.release

ReleasePlayer(source: number): boolean

local released = exports['ai-core']:ReleasePlayer(target)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean: true when the prison script released the player. false when the prison script did not release them (for example, they were not in prison), source is not a number or no prison script runs.

ExampleCopy Anchor Link

import { addCommand, resourceExport } from "@aicore-fivem/lib/server";

const core = resourceExport("ai-core");

addCommand("unjail", { help: "Releases a player", params: [{ name: "id", type: "playerId" }], restricted: true }, (_source, args) => {
  console.log(core.ReleasePlayer(args.id) ? "released" : "not in prison");
});

GetJailTimeCopy Anchor Link

How long a player still has to serve.

Side: Server · Waits: no · Lib: prison.timeLeft

GetJailTime(source: number): number

local minutes = exports['ai-core']:GetJailTime(source)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

number: minutes left. 0 when the player is not in prison, source is not a number or no prison script runs.

ExampleCopy Anchor Link

import { onClientCallback, resourceExport } from "@aicore-fivem/lib/server";
import { fail } from "@aicore-fivem/lib/shared";

const core = resourceExport("ai-core");

// Prisoners cannot use the phone booth.
onClientCallback("myscript:phoneBooth", (source) =>
  core.GetJailTime(source) > 0 ? fail("IN_PRISON") : { ok: true },
);