AI Core
Referência da APILib: servidor

Empregos e serviços

Alertas da polícia, prisão, registros do MDT, médicos, reviver e curar, estresse, fome e sede, definições de empregos e gangues, horário nobre.

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

O jobs e o definitions são o próprio ai-core: os empregos e gangues de uma personagem, e as definições de empregos do servidor. Tudo o mais aqui passa por uma das camadas do ai-core, onde responde o script que o servidor usa para essa tarefa (um sistema de alertas, uma prisão, um MDT, um script de morte, um HUD). O seu script continua a funcionar quando o proprietário o troca. Enquanto nenhum desses scripts correr, essas chamadas falham em silêncio (false, 0, null).

jobs

jobs são os empregos e gangues próprios de um jogador carregado através do ai-core: uma personagem pode ter vários empregos, está de serviço em no máximo um, e age por uma gangue de cada vez. Ler muitos jogadores de uma vez é o espelho da lib (online); alterar uma personagem não ligada é characters.

jobs.current

O emprego que os outros scripts veem como "o" emprego de um jogador: aquele em que está de serviço, senão o último em que esteve, senão o primeiro que tem, senão o emprego de desempregado.

Lado: Servidor · Espera: não

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

Retorno

Um JobMembership ({ job, grade }), ou null quando o jogador não tem personagem carregada.

Exemplo

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

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

jobs.list

Todos os empregos que o jogador tem.

Lado: Servidor · Espera: não

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

Retorno

Um array de JobMembership. Vazio quando o jogador não tem personagem carregada ou não tem nenhum emprego.

jobs.duty and jobs.setDuty

Em que emprego o jogador está de serviço, e entrar ou sair de serviço. Muitos scripts verificam o serviço em vez da pertença: um agente fora de serviço é um civil.

Lado: Servidor · Espera: não

Assinatura
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

Retorno

jobs.duty: o nome do emprego, ou null fora de serviço (ou sem personagem). jobs.setDuty: true quando a alteração foi feita, false para um emprego que o jogador não tem.

jobs.set

Acrescenta um emprego ao jogador, ou altera o grau de um que já tem. Aplicam-se as regras do painel: quantos empregos uma personagem pode ter e se um segundo é permitido.

Lado: Servidor · Espera: não

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

Parâmetros

Prop

Type

Retorno

boolean: true quando o jogador fica com esse emprego nesse grau. false sem personagem carregada, com um emprego desconhecido, um grau desconhecido, ou ao bater no limite de empregos do painel.

Exemplo

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

export function hire(source: number, job: string): void {
  if (!jobs.set(source, job, 0)) return notify(source, "Não foi possível contratar", "error");
  notify(source, `Bem-vindo a ${job}`, "success");
}

jobs.remove

Retira um emprego. Uma personagem sem empregos conta como desempregada: o emprego de desempregado nunca é guardado.

Lado: Servidor · Espera: não

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

Retorno

boolean: true quando o emprego foi retirado, false quando o jogador não o tinha (ou não tem personagem carregada).

jobs.unemployed

O nome do emprego que uma personagem sem emprego tem, tal como está definido no painel. Nunca assuma "unemployed": um servidor pode chamar-lhe o que quiser.

Lado: Servidor · Espera: não

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

Retorno

string: o nome do emprego segundo o painel.

jobs.onDutyCount

Quantos jogadores estão de serviço num emprego agora - o número que um dispatch ou uma porta de emprego normalmente quer.

Lado: Servidor · Espera: não

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

Retorno

number: quantos jogadores ligados estão de serviço nesse emprego, 0 se nenhum.

jobs.gangs

Todas as gangues do jogador.

Lado: Servidor · Espera: não

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

Retorno

Um array de GangMembership, vazio se não estiver em nenhuma.

jobs.activeGang and jobs.setActiveGang

Uma personagem pode estar em várias gangues mas age por uma de cada vez: essa é a gangue ativa, e é a que um script de território ou de droga deve ler.

Lado: Servidor · Espera: não

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

Retorno

jobs.activeGang: o nome da gangue, ou null se nenhuma está ativa. jobs.setActiveGang: true quando a alteração foi feita, false para uma gangue em que o jogador não está (null limpa-a).

jobs.setGang and jobs.removeGang

Acrescenta, muda o grau ou retira uma gangue do jogador.

Lado: Servidor · Espera: não

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

Retorno

boolean, como nas chamadas de emprego: false sem personagem carregada, com uma gangue desconhecida ou um grau desconhecido.

dispatch

dispatch.alert

Envia um alerta da polícia (ou de outro emprego). O sistema de alertas o mostra aos membros em serviço de jobs, por padrão os empregos de polícia.

Lado: Servidor · Espera: não

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

DispatchAlert

Prop

Type

O tipo é DispatchAlert.

Retorno

boolean: true quando enviado. false quando nenhum sistema de alertas está rodando ou o alerta é inválido.

Exemplo

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

Penas de prisão pelo ai-core, qualquer que seja o script de prisão rodando.

prison.jail

Manda um jogador carregado para a prisão.

Lado: Servidor · Espera: não

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

Prop

Type

Retorno true quando preso, false enquanto nenhuma prisão está rodando.

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

prison.release

Solta um jogador preso.

Lado: Servidor · Espera: não

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

Retorno true quando solto, false quando não está preso ou nenhuma prisão está rodando.

prison.release(target);

prison.timeLeft

Lado: Servidor · Espera: não

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

Retorno os minutos de pena restantes, 0 quando livre.

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

mdt

Registros do MDT da polícia (multas, mandados, prisões, cadeia) pela camada de MDT do ai-core. Nada é escrito enquanto nenhum MDT está rodando.

mdt.record

Escreve um registro no MDT da polícia.

Lado: Servidor · Espera: não

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

MdtRecord

Prop

Type

O tipo é MdtRecord.

Retorno true quando escrito, false quando nenhum MDT está rodando ou ele não aceita esse 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: não

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

Retorno o MDT para onde os registros vão, ou null.

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

ems

Médicos pela camada de EMS do ai-core: a contagem e os chamados de socorro próprios de um script de EMS, senão as contagens de serviço e os alertas do ai-core.

ems.available

Quantos médicos estão livres para atender um chamado.

Lado: Servidor · Espera: não

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

Prop

Type

Retorno o número de médicos em serviço em jobs, deixando de fora os ocupados quando um script de dispatch os conhece.

// Deixe os jogadores renascerem no hospital só quando nenhum médico pode vir.
const canRespawn = ems.available(["ambulance"]) === 0;

ems.distress

Envia um chamado de socorro de um jogador aos médicos de call.jobs.

Lado: Servidor · Espera: não

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

Prop

Type

O tipo é DistressCall.

Retorno true quando algo aceitou o chamado, false caso contrário.

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

ems.provider

Lado: Servidor · Espera: não

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

Retorno a fonte de EMS que a camada usa, "ai-core" para as próprias contagens de serviço.

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

medical

Reviver, curar e o estado de caído pela camada médica do ai-core, qualquer que seja o script de morte ou de ambulância rodando. Sem equivalente em Lua: chame os exports do ai-core RevivePlayer, HealPlayer, IsPlayerDead.

medical.revive

Levanta um jogador caído onde ele está.

Lado: Servidor · Espera: não

Signature
medical.revive(source: number): boolean

Retorno true quando revivido, false quando não está caído ou nenhum script de morte está rodando.

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

medical.heal

Dá vida cheia a um jogador que não está caído.

Lado: Servidor · Espera: não

Signature
medical.heal(source: number): boolean

Retorno true quando curado, false quando nenhum script de morte está rodando.

medical.heal(source);

medical.isDead

Se o jogador está caído.

Lado: Servidor · Espera: não

Signature
medical.isDead(source: number): boolean

Retorno true quando caído; false sem um script de morte. Use em vez de ler a vida do ped.

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

medical.provider

Lado: Servidor · Espera: não

Signature
medical.provider(): string | null

Retorno o script de morte que responde (ai-death...), ou null quando nenhum está rodando.

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

stress

O estresse dos jogadores (0 a 100) pela camada de estresse do ai-core, qualquer que seja o HUD que o guarda.

stress.gain

Adiciona pontos de estresse.

Lado: Servidor · Espera: não

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

Prop

Type

Retorno true quando adicionado, false quando nenhum HUD com estresse está rodando.

stress.gain(source, 5); // depois de um tiroteio

stress.relieve

Tira pontos de estresse.

Lado: Servidor · Espera: não

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

Retorno true quando tirado, false quando nenhum HUD com estresse está rodando ou amount é 0 ou menos.

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

stress.provider

Lado: Servidor · Espera: não

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

Retorno o HUD que guarda o estresse, ou null.

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

needs

needs.refill

Enche a fome e a sede ao máximo (revive de admin, hospital), pelo HUD que as guarda, ou pela metadata de personagem do ai-core quando não há um.

Lado: Servidor · Espera: não

Signature
needs.refill(source: number): boolean

Sem equivalente em Lua: chame o export do ai-core RefillNeeds(source).

Retorno true quando reabastecido, false quando o jogador não tem personagem.

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

Definições de empregos e gangues

definitions.job

A definição de um emprego como configurada no painel do ai-core. Cada uma é lida uma vez do ai-core e mantida até o painel mudá-la, então uma leitura é uma consulta em memória.

Lado: Servidor · Espera: não

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

Retorno JobDefinition (label, type, defaultDuty, listed?, grades), ou null quando esse emprego não existe.

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

definitions.gang

Lado: Servidor · Espera: não

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

Retorno GangDefinition (label, grades), ou null.

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

definitions.registerJob and definitions.removeJob

Um emprego que o seu script traz sem o proprietário o acrescentar no painel: um emprego do resource que chama, que desaparece quando o resource para e nunca é escrito no ficheiro do painel.

Lado: Servidor · Espera: não

Assinatura
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

Retorno

O registerJob responde ActionResult: { ok: true }, ou { ok: false, error } com uma chave de idioma quando o painel já tem um emprego com esse nome ou outro resource o registou - o painel do proprietário ganha sempre. O removeJob responde true só para um emprego que este resource registou.

Exemplo

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

// Uma vez no arranque: o emprego existe enquanto este resource correr.
const result = definitions.registerJob("garbage", {
  label: "Garbage",
  type: "job",
  defaultDuty: true,
  grades: [{ label: "Driver", salary: 60, boss: false }],
});
if (!result.ok) console.log(`emprego não registado: ${result.error}`);

Um emprego que o proprietário do servidor deva poder editar pertence ao painel, não aqui. Registe um quando o emprego faz parte do seu script e não significa nada sem ele.

definitions.registerGang and definitions.removeGang

O mesmo para gangues.

Lado: Servidor · Espera: não

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

Retorno

Como nos empregos: ActionResult para o registo, boolean para a remoção.

Horário nobre

isPrimeTime

Se é horário nobre para um emprego, pela configuração de horário nobre do ai-core. As horas vêm do tgiann-policealert enquanto ele está rodando, senão das horas definidas no painel do ai-core.

Lado: Servidor · Espera: não

Signature
isPrimeTime(job?: string): boolean

Sem equivalente em Lua: chame o export do ai-core IsPrimeTime(job).

Prop

Type

Retorno true durante o horário nobre.

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

Nesta página