Connection checks
Add checks every connecting player must pass (whitelists, bans), and declare that your script replaces another one.
Every connecting player passes one gate in ai-core. ai-core's own checks come first: the player needs a FiveM account, and no unneeded script may run next to the script that replaces it (when the panel's Refuse players while both run is on). Then come the checks other resources add with AddConnectionCheck, in the order they were added. The first refusal wins.
AddConnectionCheck
Adds a check every connecting player must pass. Use it for a whitelist, a ban list or a maintenance mode.
Side: Server · Waits: no (the check itself must answer at once) · Lib: none
AddConnectionCheck(
id: string,
check: (source: number, identifiers: Record<string, string>) => string | null | undefined,
): voidexports['ai-core']:AddConnectionCheck('myscript:whitelist', function(source, identifiers) end)Parameters
Prop
Type
identifiers holds each identifier type with its value without the prefix: identifiers.license is abc123..., not license:abc123.... Types the player does not have are missing.
Returns
Nothing. Without a text id or a function the call does nothing. The check is removed when your resource stops.
Example
import { resourceExport } from "@aicore-fivem/lib/server";
import { Locale } from "common";
const core = resourceExport("ai-core");
const allowed = new Set<string>(); // filled from your database at start
core.AddConnectionCheck("myscript:whitelist", (_source, identifiers) => {
const fivem = identifiers.fivem;
return fivem && allowed.has(fivem) ? null : Locale("CONNECT_NOT_WHITELISTED");
});The check runs while the player connects and must answer at once: no database query, no await, no Wait. Keep what you check in memory (load it at start, update it when it changes). A check that throws is logged and skipped, so it never locks everyone out.
RegisterReplacement
Declares that one script makes others unneeded (your script does the same job as theirs). While both are installed, ai-core warns in the console and names the folder to delete; while both are started and the panel's Refuse players while both run is on, nobody can join.
Side: Server · Waits: no · Lib: none
RegisterReplacement(remove: string | string[], keep?: string): voidexports['ai-core']:RegisterReplacement({ 'qb-banking', 'okokBanking' })Parameters
Prop
Type
Returns
Nothing. The rule is removed when the calling resource stops. ai-core checks for clashes again a second after any resource starts or stops.
Example
import { resourceExport } from "@aicore-fivem/lib/server";
const core = resourceExport("ai-core");
// Our banking script does what these do; running both would double the bank screens.
core.RegisterReplacement(["qb-banking", "okokBanking"]);A resource you cannot change (an escrowed script) can declare the same with a line in its fxmanifest.lua: ai_replaces 'qb-banking'.
GetConflicts
Every clash found now: a script installed next to a script that replaces it.
Side: Server · Waits: no · Lib: none
GetConflicts(): { keep: string; remove: string; running: boolean; from: string }[]local conflicts = exports['ai-core']:GetConflicts() -- list of tablesParameters
None.
Returns
A list, one entry per clash:
Prop
Type
An empty list when there is no clash.
Example
import { addCommand, resourceExport } from "@aicore-fivem/lib/server";
const core = resourceExport("ai-core");
addCommand("conflicts", { help: "Lists scripts to remove", restricted: true }, () => {
for (const c of core.GetConflicts())
console.log(`${c.keep} replaces ${c.remove}${c.running ? " (both started!)" : ""} [${c.from}]`);
});