AI Core
Référence de l’APILib : serveur

Métiers et services

Alertes police, prison, dossiers MDT, médecins, réanimation et soins, stress, faim et soif, définitions des métiers et des gangs, heures de pointe.

TypeScript
import { jobs, dispatch, prison, mdt, ems, medical, stress, needs, definitions, isPrimeTime } from "@aicore8/lib/server";

jobs et definitions sont ai-core lui-même : les métiers et gangs d'un personnage, et les définitions de métiers du serveur. Tout le reste ici passe par une des couches d'ai-core, où répond le script que le serveur fait tourner pour cette tâche (un système d'alertes, une prison, un MDT, un script de mort, un HUD). Votre script continue de fonctionner quand le propriétaire le remplace. Tant qu'aucun script de ce genre ne tourne, ces appels échouent silencieusement (false, 0, null).

jobs

jobs, ce sont les métiers et gangs d'un joueur chargé via ai-core : un personnage peut avoir plusieurs métiers, est en service dans un seul au plus, et agit pour un gang à la fois. Lire beaucoup de joueurs d'un coup, c'est le miroir de la lib (online) ; modifier un personnage non connecté, c'est characters.

jobs.current

Le métier que les autres scripts voient comme « le » métier d'un joueur : celui où il est en service, sinon le dernier où il l'était, sinon le premier qu'il a, sinon le métier de chômeur.

Côté : serveur · Attend : non

Signature
jobs.current(source: number): JobMembership | null
Lua
local current = aiLib.jobs.current(source)

Retour

Un JobMembership ({ job, grade }), ou null quand le joueur n'a pas de personnage chargé.

Exemple

import { jobs } from "@aicore8/lib/server";

export function isOfficer(source: number): boolean {
  return jobs.current(source)?.job === "police";
}

jobs.list

Tous les métiers du joueur.

Côté : serveur · Attend : non

Signature
jobs.list(source: number): JobMembership[]
Lua
local list = aiLib.jobs.list(source)

Retour

Un tableau de JobMembership. Vide quand le joueur n'a pas de personnage chargé ou n'a aucun métier.

jobs.duty and jobs.setDuty

Dans quel métier le joueur est en service, et prendre ou quitter le service. Beaucoup de scripts vérifient le service plutôt que l'appartenance : un policier hors service est un civil.

Côté : serveur · Attend : non

Signature
jobs.duty(source: number): string | null
jobs.setDuty(source: number, job: string | null): boolean
Lua
local onDutyIn = aiLib.jobs.duty(source)
local ok = aiLib.jobs.setDuty(source, job)

Paramètres

Prop

Type

Retour

jobs.duty : le nom du métier, ou null hors service (ou sans personnage). jobs.setDuty : true quand le changement a eu lieu, false pour un métier que le joueur n'a pas.

jobs.set

Ajoute un métier au joueur, ou change le grade d'un métier qu'il a déjà. Les règles du panneau s'appliquent : combien de métiers un personnage peut avoir et si un second est permis.

Côté : serveur · Attend : non

Signature
jobs.set(source: number, job: string, grade: number): boolean
Lua
local ok = aiLib.jobs.set(source, job, grade)

Paramètres

Prop

Type

Retour

boolean : true quand le joueur a ensuite ce métier à ce grade. false sans personnage chargé, pour un métier inconnu, un grade inconnu, ou la limite de métiers du panneau.

Exemple

import { jobs, notify } from "@aicore8/lib/server";

export function hire(source: number, job: string): void {
  if (!jobs.set(source, job, 0)) return notify(source, "Embauche impossible", "error");
  notify(source, `Bienvenue chez ${job}`, "success");
}

jobs.remove

Retire un métier. Un personnage sans métier compte comme sans emploi : le métier de chômeur lui-même n'est jamais stocké.

Côté : serveur · Attend : non

Signature
jobs.remove(source: number, job: string): boolean
Lua
local ok = aiLib.jobs.remove(source, job)

Retour

boolean : true quand le métier a été retiré, false quand le joueur ne l'avait pas (ou n'a pas de personnage chargé).

jobs.unemployed

Le nom du métier d'un personnage sans métier, tel qu'il est défini dans le panneau. Ne supposez jamais "unemployed" : un serveur peut l'appeler autrement.

Côté : serveur · Attend : non

Signature
jobs.unemployed(): string
Lua
local name = aiLib.jobs.unemployed()

Retour

string : le nom du métier venant du panneau.

jobs.onDutyCount

Combien de joueurs sont en service dans un métier en ce moment - le nombre qu'un dispatch ou une porte de métier veut en général.

Côté : serveur · Attend : non

Signature
jobs.onDutyCount(job: string): number
Lua
local count = aiLib.jobs.onDutyCount(job)

Retour

number : combien de joueurs connectés sont en service dans ce métier, 0 si personne.

jobs.gangs

Tous les gangs du joueur.

Côté : serveur · Attend : non

Signature
jobs.gangs(source: number): GangMembership[]
Lua
local list = aiLib.jobs.gangs(source)

Retour

Un tableau de GangMembership, vide s'il n'est dans aucun.

jobs.activeGang and jobs.setActiveGang

Un personnage peut être dans plusieurs gangs mais n'agit que pour un à la fois : c'est le gang actif, et c'est celui qu'un script de territoire ou de drogue doit lire.

Côté : serveur · Attend : non

Signature
jobs.activeGang(source: number): string | null
jobs.setActiveGang(source: number, gang: string | null): boolean
Lua
local active = aiLib.jobs.activeGang(source)
local ok = aiLib.jobs.setActiveGang(source, gang)

Retour

jobs.activeGang : le nom du gang, ou null si aucun n'est actif. jobs.setActiveGang : true quand le changement a eu lieu, false pour un gang dans lequel le joueur n'est pas (null l'efface).

jobs.setGang and jobs.removeGang

Ajoute, regrade ou retire un gang du joueur.

Côté : serveur · Attend : non

Signature
jobs.setGang(source: number, gang: string, grade: number): boolean
jobs.removeGang(source: number, gang: string): boolean
Lua
local ok = aiLib.jobs.setGang(source, gang, grade)
local ok = aiLib.jobs.removeGang(source, gang)

Retour

boolean, comme pour les métiers : false sans personnage chargé, pour un gang inconnu ou un grade inconnu.

dispatch

dispatch.alert

Envoie une alerte police (ou d’un autre métier). Le système d’alertes l’affiche aux membres en service de jobs, par défaut les métiers de police.

Côté : serveur · Attend : non

Signature
dispatch.alert(alert: DispatchAlert): boolean
Lua
local ok = aiLib.dispatch.alert(alert)

DispatchAlert

Prop

Type

Le type est DispatchAlert.

Retour

boolean : true quand elle est envoyée. false quand aucun système d’alertes ne tourne ou que l’alerte est invalide.

Exemple

import { dispatch, coordsOf, createLocale } from "@aicore8/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",
  });
}

prison

Les peines de prison via ai-core, quel que soit le script de prison qui tourne.

prison.jail

Envoie un joueur chargé en prison.

Côté : serveur · Attend : non

Signature
prison.jail(source: number, minutes: number, by?: number): boolean
Lua
local ok = aiLib.prison.jail(source, minutes, by)

Prop

Type

Retour true quand il est emprisonné, false tant qu’aucune prison ne tourne.

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

prison.release

Libère un joueur emprisonné.

Côté : serveur · Attend : non

Signature
prison.release(source: number): boolean
Lua
local ok = aiLib.prison.release(source)

Retour true quand il est libéré, false quand il n’est pas emprisonné ou qu’aucune prison ne tourne.

prison.release(target);

prison.timeLeft

Côté : serveur · Attend : non

Signature
prison.timeLeft(source: number): number
Lua
local minutes = aiLib.prison.timeLeft(source)

Retour les minutes de peine restantes, 0 quand il est libre.

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

mdt

Les dossiers du MDT de police (amendes, mandats, arrestations, prison) via la couche MDT d’ai-core. Rien n’est écrit tant qu’aucun MDT ne tourne.

mdt.record

Écrit un dossier dans le MDT de police.

Côté : serveur · Attend : non

Signature
mdt.record(record: MdtRecord): boolean
Lua
local ok = aiLib.mdt.record(record)

MdtRecord

Prop

Type

Le type est MdtRecord.

Retour true quand il est écrit, false quand aucun MDT ne tourne ou qu’il n’accepte pas ce type de dossier.

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

mdt.provider

Côté : serveur · Attend : non

Signature
mdt.provider(): string | null
Lua
local name = aiLib.mdt.provider()

Retour le MDT vers lequel vont les dossiers, ou null.

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

ems

Les médecins via la couche EMS d’ai-core : le décompte et les appels de détresse propres à un script EMS, sinon les décomptes de service et les alertes d’ai-core.

ems.available

Combien de médecins sont libres pour prendre un appel.

Côté : serveur · Attend : non

Signature
ems.available(jobs: string[]): number
Lua
local count = aiLib.ems.available(jobs)

Prop

Type

Retour le nombre de médecins en service dans jobs, sans compter ceux qui sont occupés quand un script de dispatch les connaît.

// Laisser les joueurs réapparaître à l’hôpital seulement quand aucun médecin ne peut venir.
const canRespawn = ems.available(["ambulance"]) === 0;

ems.distress

Envoie un appel de détresse pour un joueur aux médecins de call.jobs.

Côté : serveur · Attend : non

Signature
ems.distress(source: number, call: DistressCall): boolean
Lua
local ok = aiLib.ems.distress(source, call)

Prop

Type

Le type est DistressCall.

Retour true quand quelque chose a pris l’appel, false sinon.

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

ems.provider

Côté : serveur · Attend : non

Signature
ems.provider(): string | null
Lua
local name = aiLib.ems.provider()

Retour la source EMS utilisée par la couche, "ai-core" pour ses propres décomptes de service.

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

medical

La réanimation, les soins et l’état à terre via la couche médicale d’ai-core, quel que soit le script de mort ou d’ambulance qui tourne. Pas d’équivalent Lua : appelez les exports d’ai-core RevivePlayer, HealPlayer, IsPlayerDead.

medical.revive

Relève un joueur à terre là où il se trouve.

Côté : serveur · Attend : non

Signature
medical.revive(source: number): boolean

Retour true quand il est réanimé, false quand il n’est pas à terre ou qu’aucun script de mort ne tourne.

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

medical.heal

Rend toute sa santé à un joueur qui n’est pas à terre.

Côté : serveur · Attend : non

Signature
medical.heal(source: number): boolean

Retour true quand il est soigné, false quand aucun script de mort ne tourne.

medical.heal(source);

medical.isDead

Indique si le joueur est à terre.

Côté : serveur · Attend : non

Signature
medical.isDead(source: number): boolean

Retour true quand il est à terre ; false sans script de mort. Utilisez-la au lieu de lire la santé du ped.

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

medical.provider

Côté : serveur · Attend : non

Signature
medical.provider(): string | null

Retour le script de mort qui répond (ai-death...), ou null quand aucun ne tourne.

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

stress

Le stress des joueurs (de 0 à 100) via la couche stress d’ai-core, quel que soit le HUD qui le gère.

stress.gain

Ajoute des points de stress.

Côté : serveur · Attend : non

Signature
stress.gain(source: number, amount: number): boolean
Lua
local ok = aiLib.stress.gain(source, amount)

Prop

Type

Retour true quand ils sont ajoutés, false quand aucun HUD avec stress ne tourne.

stress.gain(source, 5); // après une fusillade

stress.relieve

Retire des points de stress.

Côté : serveur · Attend : non

Signature
stress.relieve(source: number, amount: number): boolean
Lua
local ok = aiLib.stress.relieve(source, amount)

Retour true quand ils sont retirés, false quand aucun HUD avec stress ne tourne ou que amount vaut 0 ou moins.

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

stress.provider

Côté : serveur · Attend : non

Signature
stress.provider(): string | null
Lua
local name = aiLib.stress.provider()

Retour le HUD qui gère le stress, ou null.

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

needs

needs.refill

Remplit entièrement la faim et la soif (réanimation par un admin, hôpital), via le HUD qui les gère, ou sans HUD via les métadonnées du personnage dans ai-core.

Côté : serveur · Attend : non

Signature
needs.refill(source: number): boolean

Pas d’équivalent Lua : appelez l’export d’ai-core RefillNeeds(source).

Retour true quand elles sont remplies, false quand le joueur n’a pas de personnage.

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

Définitions des métiers et des gangs

definitions.job

La définition d’un métier telle que réglée dans le panneau d’ai-core. Chacune est lue une fois depuis ai-core et gardée jusqu’à ce que le panneau la modifie, donc une lecture est une simple recherche en mémoire.

Côté : serveur · Attend : non

Signature
definitions.job(name: string): JobDefinition | null
Lua
local definition = aiLib.definitions.job(name)

Retour JobDefinition (label, type, defaultDuty, listed?, grades), ou null quand ce métier n’existe pas.

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

definitions.gang

Côté : serveur · Attend : non

Signature
definitions.gang(name: string): GangDefinition | null
Lua
local definition = aiLib.definitions.gang(name)

Retour GangDefinition (label, grades), ou null.

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

definitions.registerJob and definitions.removeJob

Un métier que votre script apporte sans que le propriétaire l'ajoute dans le panneau : un métier de la resource appelante, perdu quand la resource s'arrête, et jamais écrit dans le fichier du panneau.

Côté : serveur · Attend : non

Signature
definitions.registerJob(name: string, definition: JobDefinition): CharacterResult
definitions.removeJob(name: string): boolean
Lua
local result = aiLib.definitions.registerJob(name, definition)
local ok = aiLib.definitions.removeJob(name)

Paramètres

Prop

Type

Retour

registerJob répond ActionResult : { ok: true }, ou { ok: false, error } avec une clé de langue quand le panneau a déjà un métier de ce nom ou qu'une autre resource l'a enregistré - le panneau du propriétaire gagne toujours. removeJob répond true seulement pour un métier enregistré par cette resource.

Exemple

import { definitions } from "@aicore8/lib/server";

// Une fois au démarrage : le métier existe tant que cette resource tourne.
const result = definitions.registerJob("garbage", {
  label: "Garbage",
  type: "job",
  defaultDuty: true,
  grades: [{ label: "Driver", salary: 60, boss: false }],
});
if (!result.ok) console.log(`métier non enregistré : ${result.error}`);

Un métier que le propriétaire du serveur doit pouvoir modifier appartient au panneau, pas ici. Enregistrez-en un quand le métier fait partie de votre script et ne veut rien dire sans lui.

definitions.registerGang and definitions.removeGang

Pareil pour les gangs.

Côté : serveur · Attend : non

Signature
definitions.registerGang(name: string, definition: GangDefinition): CharacterResult
definitions.removeGang(name: string): boolean
Lua
local result = aiLib.definitions.registerGang(name, definition)
local ok = aiLib.definitions.removeGang(name)

Retour

Comme pour les métiers : ActionResult pour l'enregistrement, boolean pour le retrait.

Heures de pointe

isPrimeTime

Indique si c’est l’heure de pointe pour un métier, d’après le réglage d’heures de pointe d’ai-core. Les heures viennent de tgiann-policealert tant qu’il tourne, sinon des heures réglées dans le panneau d’ai-core.

Côté : serveur · Attend : non

Signature
isPrimeTime(job?: string): boolean

Pas d’équivalent Lua : appelez l’export d’ai-core IsPrimeTime(job).

Prop

Type

Retour true pendant l’heure de pointe.

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

Sur cette page