AI Core
Referencia de la APILib: servidor

Trabajos y servicios

Alertas policiales, prisión, registros del MDT, médicos, revivir y curar, estrés, hambre y sed, definiciones de trabajos y bandas, horas punta.

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

jobs y definitions son ai-core en sí: los trabajos y bandas de un personaje, y las definiciones de trabajos del servidor. Todo lo demás de aquí pasa por una de las capas de ai-core, donde responde el script que el servidor usa para esa tarea (un sistema de avisos, una cárcel, un MDT, un script de muerte, un HUD). Tu script sigue funcionando cuando el propietario lo cambia. Mientras no corra ninguno, esas llamadas fallan en silencio (false, 0, null).

jobs

jobs son los trabajos y bandas propios de un jugador cargado a través de ai-core: un personaje puede tener varios trabajos, está de servicio en uno como máximo, y actúa por una banda a la vez. Leer muchos jugadores a la vez es el espejo de la lib (online); cambiar un personaje no conectado es characters.

jobs.current

El trabajo que los demás scripts ven como "el" trabajo de un jugador: el que tiene de servicio, si no el último en el que estuvo de servicio, si no el primero que tiene, si no el trabajo de desempleado.

Lado: Servidor · Espera: no

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

Devuelve

Un JobMembership ({ job, grade }), o null cuando el jugador no tiene personaje cargado.

Ejemplo

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

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

jobs.list

Todos los trabajos que tiene el jugador.

Lado: Servidor · Espera: no

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

Devuelve

Un array de JobMembership. Vacío cuando el jugador no tiene personaje cargado o no tiene ningún trabajo.

jobs.duty and jobs.setDuty

En qué trabajo está de servicio el jugador, y entrar o salir de servicio. Muchos scripts comprueban el servicio en vez de la pertenencia: un agente fuera de servicio es un civil.

Lado: Servidor · Espera: no

Firma
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)

Parámetros

Prop

Type

Devuelve

jobs.duty: el nombre del trabajo, o null fuera de servicio (o sin personaje). jobs.setDuty: true cuando el cambio se hizo, false para un trabajo que el jugador no tiene.

jobs.set

Añade un trabajo al jugador, o cambia el grado de uno que ya tiene. Se aplican las reglas del panel: cuántos trabajos puede tener un personaje y si se permite un segundo.

Lado: Servidor · Espera: no

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

Parámetros

Prop

Type

Devuelve

boolean: true cuando el jugador tiene después ese trabajo en ese grado. false sin personaje cargado, con un trabajo desconocido, un grado desconocido, o al topar con el límite de trabajos del panel.

Ejemplo

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

export function hire(source: number, job: string): void {
  if (!jobs.set(source, job, 0)) return notify(source, "No se pudo contratar", "error");
  notify(source, `Bienvenido a ${job}`, "success");
}

jobs.remove

Quita un trabajo. Un personaje sin trabajos cuenta como desempleado: el trabajo de desempleado nunca se guarda.

Lado: Servidor · Espera: no

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

Devuelve

boolean: true cuando el trabajo se quitó, false cuando el jugador no lo tenía (o no tiene personaje cargado).

jobs.unemployed

El nombre del trabajo que tiene un personaje sin trabajo, como está definido en el panel. Nunca asumas "unemployed": un servidor puede llamarlo como quiera.

Lado: Servidor · Espera: no

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

Devuelve

string: el nombre del trabajo según el panel.

jobs.onDutyCount

Cuántos jugadores están de servicio en un trabajo ahora mismo - el número que normalmente quiere un dispatch o una puerta de trabajo.

Lado: Servidor · Espera: no

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

Devuelve

number: cuántos jugadores conectados están de servicio en ese trabajo, 0 si ninguno.

jobs.gangs

Todas las bandas del jugador.

Lado: Servidor · Espera: no

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

Devuelve

Un array de GangMembership, vacío si no está en ninguna.

jobs.activeGang and jobs.setActiveGang

Un personaje puede estar en varias bandas pero actúa por una a la vez: esa es la banda activa, y es la que debería leer un script de territorio o de drogas.

Lado: Servidor · Espera: no

Firma
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)

Devuelve

jobs.activeGang: el nombre de la banda, o null si ninguna está activa. jobs.setActiveGang: true cuando el cambio se hizo, false para una banda en la que el jugador no está (null la borra).

jobs.setGang and jobs.removeGang

Añade, cambia el grado o quita una banda del jugador.

Lado: Servidor · Espera: no

Firma
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)

Devuelve

boolean, como en las llamadas de trabajo: false sin personaje cargado, con una banda desconocida o un grado desconocido.

dispatch

dispatch.alert

Envía una alerta a la policía (o a otro trabajo). El sistema de alertas la muestra a los miembros de servicio de jobs, por defecto los trabajos de policía.

Lado: Servidor · Espera: no

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

DispatchAlert

Prop

Type

El tipo es DispatchAlert.

Devuelve

boolean: true cuando se envió. false cuando no hay sistema de alertas en marcha o la alerta no es válida.

Ejemplo

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

Condenas de prisión a través de ai-core, sea cual sea el script de prisión que funcione.

prison.jail

Envía a prisión a un jugador cargado.

Lado: Servidor · Espera: no

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

Prop

Type

Devuelve true cuando se encarceló, false mientras no haya prisión en marcha.

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

prison.release

Deja salir a un jugador encarcelado.

Lado: Servidor · Espera: no

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

Devuelve true cuando se liberó, false cuando no está encarcelado o no hay prisión en marcha.

prison.release(target);

prison.timeLeft

Lado: Servidor · Espera: no

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

Devuelve los minutos de condena que quedan, 0 cuando está libre.

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

mdt

Registros policiales del MDT (multas, órdenes de búsqueda, arrestos, cárcel) a través de la capa de MDT de ai-core. No se escribe nada mientras no haya MDT en marcha.

mdt.record

Escribe un registro en el MDT policial.

Lado: Servidor · Espera: no

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

MdtRecord

Prop

Type

El tipo es MdtRecord.

Devuelve true cuando se escribió, false cuando no hay MDT en marcha o este no acepta ese tipo de registro.

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

mdt.provider

Lado: Servidor · Espera: no

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

Devuelve el MDT al que van los registros, o null.

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

ems

Médicos a través de la capa de EMS de ai-core: el recuento y las llamadas de auxilio propios de un script de EMS, o si no, los recuentos de servicio y las alertas de ai-core.

ems.available

Cuántos médicos están libres para atender una llamada.

Lado: Servidor · Espera: no

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

Prop

Type

Devuelve el número de médicos de servicio en jobs, dejando fuera a los ocupados cuando un script de dispatch los conoce.

// Deja a los jugadores reaparecer en el hospital solo cuando ningún médico puede venir.
const canRespawn = ems.available(["ambulance"]) === 0;

ems.distress

Envía una llamada de auxilio para un jugador a los médicos de call.jobs.

Lado: Servidor · Espera: no

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

Prop

Type

El tipo es DistressCall.

Devuelve true cuando algo aceptó la llamada, false en caso contrario.

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

ems.provider

Lado: Servidor · Espera: no

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

Devuelve la fuente de EMS que usa la capa, "ai-core" para sus propios recuentos de servicio.

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

medical

Revivir, curar y el estado de derribado a través de la capa médica de ai-core, sea cual sea el script de muerte o de ambulancia que funcione. Sin equivalente en Lua: llama a los exports de ai-core RevivePlayer, HealPlayer, IsPlayerDead.

medical.revive

Levanta a un jugador derribado donde está tendido.

Lado: Servidor · Espera: no

Firma
medical.revive(source: number): boolean

Devuelve true cuando se revivió, false cuando no está derribado o no hay script de muerte en marcha.

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

medical.heal

Da la salud completa a un jugador que no está derribado.

Lado: Servidor · Espera: no

Firma
medical.heal(source: number): boolean

Devuelve true cuando se curó, false cuando no hay script de muerte en marcha.

medical.heal(source);

medical.isDead

Si el jugador está derribado.

Lado: Servidor · Espera: no

Firma
medical.isDead(source: number): boolean

Devuelve true cuando está derribado; false sin script de muerte. Úsalo en lugar de leer la salud del ped.

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

medical.provider

Lado: Servidor · Espera: no

Firma
medical.provider(): string | null

Devuelve el script de muerte que responde (ai-death...), o null cuando no hay ninguno en marcha.

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

stress

El estrés de los jugadores (de 0 a 100) a través de la capa de estrés de ai-core, sea cual sea el HUD que lo lleve.

stress.gain

Añade puntos de estrés.

Lado: Servidor · Espera: no

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

Prop

Type

Devuelve true cuando se añadieron, false cuando no hay un HUD con estrés en marcha.

stress.gain(source, 5); // después de un tiroteo

stress.relieve

Quita puntos de estrés.

Lado: Servidor · Espera: no

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

Devuelve true cuando se quitaron, false cuando no hay un HUD con estrés en marcha o amount es 0 o menos.

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

stress.provider

Lado: Servidor · Espera: no

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

Devuelve el HUD que lleva el estrés, o null.

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

needs

needs.refill

Llena por completo el hambre y la sed (revivir de admin, hospital), a través del HUD que las lleva, o de los metadatos del personaje de ai-core si no hay ninguno.

Lado: Servidor · Espera: no

Firma
needs.refill(source: number): boolean

Sin equivalente en Lua: llama al export de ai-core RefillNeeds(source).

Devuelve true cuando se rellenaron, false cuando el jugador no tiene personaje.

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

Definiciones de trabajos y bandas

definitions.job

La definición de un trabajo tal como está en el panel de ai-core. Cada una se lee una vez de ai-core y se guarda hasta que el panel la cambia, así que una lectura es una consulta en memoria.

Lado: Servidor · Espera: no

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

Devuelve JobDefinition (label, type, defaultDuty, listed?, grades), o null cuando no existe ese trabajo.

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

definitions.gang

Lado: Servidor · Espera: no

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

Devuelve GangDefinition (label, grades), o null.

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

definitions.registerJob and definitions.removeJob

Un trabajo que trae tu script sin que el propietario lo añada en el panel: un trabajo del resource que llama, que desaparece cuando el resource para y nunca se escribe en el archivo del panel.

Lado: Servidor · Espera: no

Firma
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)

Parámetros

Prop

Type

Devuelve

registerJob responde ActionResult: { ok: true }, o { ok: false, error } con una clave de idioma cuando el panel ya tiene un trabajo con ese nombre o otro resource lo registró - el panel del propietario siempre gana. removeJob responde true solo para un trabajo que registró este resource.

Ejemplo

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

// Una vez al arrancar: el trabajo existe mientras este resource corra.
const result = definitions.registerJob("garbage", {
  label: "Garbage",
  type: "job",
  defaultDuty: true,
  grades: [{ label: "Driver", salary: 60, boss: false }],
});
if (!result.ok) console.log(`trabajo no registrado: ${result.error}`);

Un trabajo que el propietario del servidor deba poder editar pertenece al panel, no aquí. Registra uno cuando el trabajo es parte de tu script y no significa nada sin él.

definitions.registerGang and definitions.removeGang

Lo mismo para bandas.

Lado: Servidor · Espera: no

Firma
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)

Devuelve

Como con los trabajos: ActionResult para el registro, boolean para quitarlo.

Horas punta

isPrimeTime

Si es hora punta para un trabajo, según el ajuste de horas punta de ai-core. Las horas vienen de tgiann-policealert mientras está en marcha, o si no, de las horas fijadas en el panel de ai-core.

Lado: Servidor · Espera: no

Firma
isPrimeTime(job?: string): boolean

Sin equivalente en Lua: llama al export de ai-core IsPrimeTime(job).

Prop

Type

Devuelve true durante las horas punta.

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

En esta página