ai-cityhall for developers

ai-cityhall has no exports. Jobs taken at the job center are set with ai-core's job functions, and documents are ordinary inventory items, so another script works with them through AI Core.

Document item metadataCopy Anchor Link

A document (id_card, driver_license, or any item listed under Documents) is one unique item whose metadata carries the holder. The fields are qbx_idcard's, so scripts written for Qbox read them as they are.

Giving a document from another scriptCopy Anchor Link

Using the item shows the card, whoever gave it: ai-cityhall registers every document item as usable. Give the item with the same metadata and it behaves like one bought at the counter.

Side: Server · Waits: no

ExampleCopy Anchor Link

A police script hands a new driver license after a test:

import { inventory, notify, online } from "@aicore-fivem/lib/server";

function giveLicense(source: number): boolean {
  const c = online.character(source);
  if (!c) return false;
  const metadata = {
    name: `${c.firstname} ${c.lastname}`,
    firstname: c.firstname,
    lastname: c.lastname,
    birthdate: c.birthdate,
    sex: c.sex,
    nationality: c.nationality,
    citizenid: c.citizenid,
  };
  if (!inventory.canCarryItem(source, "driver_license", 1, metadata)) {
    notify(source, "No room in your inventory", "error");
    return false;
  }
  return inventory.addItem(source, "driver_license", 1, metadata);
}

MoneyCopy Anchor Link

Documents are paid with ai-core's RemoveMoney from the panel's accounts, ledger reason cityhall:<item> (for example cityhall:id_card).

Private events and callbacksCopy Anchor Link

The script's own contract (resource/common/hall.ts). The server checks the distance to the hall on every call. They may change between versions: do not trigger or listen to them from other resources.