Framework bridge events

ai-core presents itself as es_extended, qb-core, qbx_core and vrp, so scripts written for those frameworks run without changes. Part of that is firing the framework's own events when something changes in ai-core: a character loads, money moves, a job changes. This page lists every framework event the bridge fires, with the arguments as the bridge sends them, and the framework events it answers.

New code should not use these. Write against ai-core's own events (server, client) and the lib: they carry more (several jobs, gangs, duty) and do not depend on a framework shape. This page is for running and fixing existing ESX / QB / vRP scripts.

QBCore and Qbox: serverCopy Anchor Link

The bridge fires these on the server with TriggerEvent. Qbox scripts listen to the same QBCore names; the bridge fires no Qbox-only event.

QBCore:Server:PlayerLoadedCopy Anchor Link

A character was loaded (from ai-core:playerLoaded).

Side: Server

on("QBCore:Server:PlayerLoaded", (player: { PlayerData: { source: number; citizenid: string } }) => {
  console.log(`${player.PlayerData.citizenid} loaded (src ${player.PlayerData.source})`);
});

QBCore:Server:OnPlayerUnloadCopy Anchor Link

A character was let go: the player left or went back to the character screen (from ai-core:playerUnloaded).

Side: Server

on("QBCore:Server:OnPlayerUnload", (source: number) => console.log(`${source} unloaded`));

QBCore:Server:OnMoneyChangeCopy Anchor Link

An account balance changed (from ai-core:moneyChanged).

Side: Server

on("QBCore:Server:OnMoneyChange", (source: number, account: string, amount: number, action: "add" | "remove", reason: string) => {
  console.log(`${source} ${action} ${amount} ${account} (${reason})`);
});

QBCore:Server:OnJobUpdateCopy Anchor Link

The player's framework job changed: a job added or removed, a grade change, going on or off duty, or a panel edit of that job (from ai-core:jobsChanged, ai-core:dutyChanged, ai-core:definitionsChanged).

Side: Server

on("QBCore:Server:OnJobUpdate", (source: number, job: { name: string; onduty: boolean; grade: { level: number } }) => {
  console.log(`${source}: ${job.name} grade ${job.grade.level}, on duty ${job.onduty}`);
});

QBCore:Server:OnGangUpdateCopy Anchor Link

The player's framework gang changed: the active gang, the gang list, or a panel edit of that gang (from ai-core:gangsChanged, ai-core:activeGangChanged, ai-core:definitionsChanged).

Side: Server

on("QBCore:Server:OnGangUpdate", (source: number, gang: { name: string }) => console.log(`${source}: gang ${gang.name}`));

QBCore and Qbox: clientCopy Anchor Link

Fired on the player's own client with TriggerEvent.

on("QBCore:Client:OnPlayerLoaded", () => console.log("loaded"));
on("QBCore:Client:OnJobUpdate", (job: { name: string }) => console.log(`job: ${job.name}`));
on("QBCore:Client:SetDuty", (onDuty: boolean) => console.log(`on duty: ${onDuty}`));

ESX: serverCopy Anchor Link

esx:playerLoadedCopy Anchor Link

A character was loaded (from ai-core:playerLoaded).

Side: Server

on("esx:playerLoaded", (source: number, xPlayer: { identifier: string }) => {
  console.log(`${xPlayer.identifier} loaded (src ${source})`);
});

esx:playerDroppedCopy Anchor Link

The player left the server (from ai-core:playerUnloaded with reason dropped).

Side: Server

on("esx:playerDropped", (source: number) => console.log(`${source} left`));

esx:playerLogoutCopy Anchor Link

The player went back to the character screen and stays connected (from ai-core:playerUnloaded with reason switch).

Side: Server

on("esx:playerLogout", (source: number) => console.log(`${source} switched character`));

esx:setJobCopy Anchor Link

The player's framework job changed (same moments as QBCore:Server:OnJobUpdate).

Side: Server

on("esx:setJob", (source: number, job: { name: string; grade: number }) => {
  console.log(`${source}: ${job.name} grade ${job.grade}`);
});

ESX: clientCopy Anchor Link

Fired on the player's own client with TriggerEvent.

on("esx:playerLoaded", () => console.log("loaded"));
on("esx:setAccountMoney", (account: { name: string; money: number }) => console.log(`${account.name}: ${account.money}`));

vRPCopy Anchor Link

ai-core's vRP bridge fires vRP's server events. The vRP user_id is ai-core's character id.

vRP:playerJoinCopy Anchor Link

A character was loaded. (vRP fires it on connect; ai-core only knows the id once a character is loaded.)

Side: Server

on("vRP:playerJoin", (userId: number, source: number, name: string) => console.log(`${name} joined as user ${userId} (src ${source})`));

vRP:playerSpawnCopy Anchor Link

The character was put into the world. Fires 2 seconds after ai-core spawned it, like vRP. Only for the spawn of a character load: respawns after death come from the death script and do not fire it.

Side: Server

on("vRP:playerSpawn", (userId: number, source: number, firstSpawn: boolean) => {
  if (firstSpawn) console.log(`user ${userId} spawned (src ${source})`);
});

vRP:playerLeaveCopy Anchor Link

A character was let go: the player left or switched character.

Side: Server

on("vRP:playerLeave", (userId: number, source: number) => console.log(`user ${userId} left (src ${source})`));

vRP:playerJoinGroup and vRP:playerLeaveGroupCopy Anchor Link

The character got or lost a vRP group. Groups are ai-core's jobs, the active gang, the group names the server owner mapped in the panel (tab "vRP scripts"), and extra groups vRP scripts add. Fires for every change, also changes ai-core or another script makes without vRP.

Side: Server

on("vRP:playerJoinGroup", (userId: number, group: string, gtype?: string) => console.log(`user ${userId} joined ${group} (${gtype ?? "group"})`));
on("vRP:playerLeaveGroup", (userId: number, group: string) => console.log(`user ${userId} left ${group}`));

Framework events ai-core answersCopy Anchor Link

Scripts written for a framework send these events expecting the framework to answer. ai-core answers them instead.