AI Core
Dokumentacja APILib: serwer

Prace i służby

Alerty policyjne, więzienie, rekordy MDT, medycy, wskrzeszanie i leczenie, stres, głód i pragnienie, definicje prac i gangów, prime time.

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

jobs i definitions to samo ai-core: prace i gangi postaci oraz definicje prac serwera. Wszystko inne tutaj idzie przez jedną z warstw ai-core, gdzie odpowiada skrypt, który serwer ma do tego zadania (system zgłoszeń, więzienie, MDT, skrypt śmierci, HUD). Twój skrypt działa dalej, gdy właściciel go wymieni. Dopóki żaden taki skrypt nie działa, te wywołania cicho zawodzą (false, 0, null).

jobs

jobs to własne prace i gangi wczytanego gracza przez ai-core: postać może mieć kilka prac, jest na służbie w co najwyżej jednej i działa dla jednego gangu naraz. Czytanie wielu graczy naraz to lustro liba (online); zmiana postaci, która nie jest połączona, to characters.

jobs.current

Praca, którą inne skrypty widzą jako "tę" pracę gracza: ta, w której jest na służbie, inaczej ostatnia, w której był, inaczej pierwsza, którą ma, inaczej praca bezrobotnego.

Strona: Serwer · Czeka: nie

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

Zwraca

JobMembership ({ job, grade }) albo null, gdy gracz nie ma wczytanej postaci.

Przykład

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

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

jobs.list

Każda praca, którą gracz ma.

Strona: Serwer · Czeka: nie

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

Zwraca

Tablicę JobMembership. Pustą, gdy gracz nie ma wczytanej postaci albo nie ma żadnej pracy.

jobs.duty and jobs.setDuty

W której pracy gracz jest na służbie i wejście albo wyjście ze służby. Wiele skryptów sprawdza służbę, nie przynależność: funkcjonariusz po służbie to cywil.

Strona: Serwer · Czeka: nie

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

Parametry

Prop

Type

Zwraca

jobs.duty: nazwa pracy albo null po służbie (lub bez postaci). jobs.setDuty: true, gdy zmiana się udała, false przy pracy, której gracz nie ma.

jobs.set

Dodaje graczowi pracę albo zmienia stopień pracy, którą już ma. Obowiązują reguły panelu: ile prac może mieć postać i czy druga jest w ogóle dozwolona.

Strona: Serwer · Czeka: nie

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

Parametry

Prop

Type

Zwraca

boolean: true, gdy gracz ma potem tę pracę w tym stopniu. false bez wczytanej postaci, przy nieznanej pracy, nieznanym stopniu albo limicie prac z panelu.

Przykład

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

export function hire(source: number, job: string): void {
  if (!jobs.set(source, job, 0)) return notify(source, "Nie udało się zatrudnić", "error");
  notify(source, `Witaj w ${job}`, "success");
}

jobs.remove

Zabiera pracę. Postać bez prac liczy się jako bezrobotna: sama praca bezrobotnego nigdy nie jest zapisywana.

Strona: Serwer · Czeka: nie

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

Zwraca

boolean: true, gdy praca została zabrana, false, gdy gracz jej nie miał (albo nie ma wczytanej postaci).

jobs.unemployed

Nazwa pracy, którą ma postać bez pracy, ustawiona w panelu. Nigdy nie zakładaj "unemployed": serwer może nazwać ją dowolnie.

Strona: Serwer · Czeka: nie

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

Zwraca

string: nazwa pracy z panelu.

jobs.onDutyCount

Ilu graczy jest teraz na służbie w danej pracy - liczba, której zwykle chce dispatch albo brama pracy.

Strona: Serwer · Czeka: nie

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

Zwraca

number: ilu połączonych graczy jest na służbie w tej pracy, 0 gdy nikt.

jobs.gangs

Każdy gang gracza.

Strona: Serwer · Czeka: nie

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

Zwraca

Tablicę GangMembership, pustą gdy w żadnym nie jest.

jobs.activeGang and jobs.setActiveGang

Postać może być w kilku gangach, ale działa dla jednego naraz: to gang aktywny, i właśnie jego powinien czytać skrypt terenów albo narkotyków.

Strona: Serwer · Czeka: nie

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

Zwraca

jobs.activeGang: nazwa gangu albo null, gdy żaden nie jest aktywny. jobs.setActiveGang: true, gdy zmiana się udała, false przy gangu, w którym gracz nie jest (null czyści go).

jobs.setGang and jobs.removeGang

Dodaje, zmienia stopień albo zabiera gang gracza.

Strona: Serwer · Czeka: nie

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

Zwraca

boolean, jak przy pracach: false bez wczytanej postaci, przy nieznanym gangu albo nieznanym stopniu.

dispatch

dispatch.alert

Wysyła alert policyjny (albo innej pracy). System alertów pokazuje go członkom jobs na służbie, domyślnie pracom policyjnym.

Strona: Serwer · Czeka: nie

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

DispatchAlert

Prop

Type

Typ to DispatchAlert.

Zwracana wartość

boolean: true, gdy wysłano. false, gdy nie działa żaden system alertów albo alert jest nieprawidłowy.

Przykład

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

Wyroki więzienia przez ai-core, niezależnie od tego, jaki skrypt więzienia działa.

prison.jail

Wysyła wczytanego gracza do więzienia.

Strona: Serwer · Czeka: nie

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

Prop

Type

Zwraca true, gdy uwięziono, false, dopóki nie działa żadne więzienie.

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

prison.release

Wypuszcza uwięzionego gracza.

Strona: Serwer · Czeka: nie

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

Zwraca true, gdy wypuszczono, false, gdy nie jest uwięziony albo nie działa żadne więzienie.

prison.release(target);

prison.timeLeft

Strona: Serwer · Czeka: nie

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

Zwraca minuty pozostałego wyroku, 0, gdy jest wolny.

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

mdt

Rekordy policyjnego MDT (mandaty, nakazy, aresztowania, więzienie) przez warstwę MDT ai-core. Nic nie jest zapisywane, dopóki nie działa żadne MDT.

mdt.record

Zapisuje rekord w policyjnym MDT.

Strona: Serwer · Czeka: nie

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

MdtRecord

Prop

Type

Typ to MdtRecord.

Zwraca true, gdy zapisano, false, gdy nie działa żadne MDT albo nie przyjmuje takiego rekordu.

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

mdt.provider

Strona: Serwer · Czeka: nie

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

Zwraca MDT, do którego trafiają rekordy, albo null.

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

ems

Medycy przez warstwę EMS ai-core: własne liczenie i wezwania pomocy skryptu EMS, a w przeciwnym razie liczby służby i alerty ai-core.

ems.available

Ilu medyków może przyjąć wezwanie.

Strona: Serwer · Czeka: nie

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

Prop

Type

Zwraca liczbę medyków na służbie w jobs, bez zajętych, gdy skrypt dispatchu ich zna.

// Pozwól graczom odrodzić się w szpitalu tylko wtedy, gdy żaden medyk nie może przyjechać.
const canRespawn = ems.available(["ambulance"]) === 0;

ems.distress

Wysyła wezwanie pomocy dla gracza do medyków z call.jobs.

Strona: Serwer · Czeka: nie

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

Prop

Type

Typ to DistressCall.

Zwraca true, gdy coś przyjęło wezwanie, w przeciwnym razie false.

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

ems.provider

Strona: Serwer · Czeka: nie

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

Zwraca źródło EMS, którego używa warstwa, "ai-core" dla własnych liczb służby.

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

medical

Wskrzeszanie, leczenie i stan powalenia przez warstwę medyczną ai-core, niezależnie od tego, jaki skrypt śmierci albo karetki działa. Brak odpowiednika w Lua: wywołaj eksporty ai-core RevivePlayer, HealPlayer, IsPlayerDead.

medical.revive

Stawia powalonego gracza na nogi tam, gdzie leży.

Strona: Serwer · Czeka: nie

Sygnatura
medical.revive(source: number): boolean

Zwraca true, gdy wskrzeszono, false, gdy nie jest powalony albo nie działa żaden skrypt śmierci.

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

medical.heal

Daje pełne zdrowie graczowi, który nie jest powalony.

Strona: Serwer · Czeka: nie

Sygnatura
medical.heal(source: number): boolean

Zwraca true, gdy wyleczono, false, gdy nie działa żaden skrypt śmierci.

medical.heal(source);

medical.isDead

Czy gracz jest powalony.

Strona: Serwer · Czeka: nie

Sygnatura
medical.isDead(source: number): boolean

Zwraca true, gdy jest powalony; false bez skryptu śmierci. Używaj go zamiast czytać zdrowie peda.

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

medical.provider

Strona: Serwer · Czeka: nie

Sygnatura
medical.provider(): string | null

Zwraca skrypt śmierci, który odpowiada (ai-death...), albo null, gdy żaden nie działa.

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

stress

Stres graczy (od 0 do 100) przez warstwę stresu ai-core, niezależnie od tego, jaki HUD go prowadzi.

stress.gain

Dodaje punkty stresu.

Strona: Serwer · Czeka: nie

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

Prop

Type

Zwraca true, gdy dodano, false, gdy nie działa żaden HUD ze stresem.

stress.gain(source, 5); // po strzelaninie

stress.relieve

Zabiera punkty stresu.

Strona: Serwer · Czeka: nie

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

Zwraca true, gdy zabrano, false, gdy nie działa żaden HUD ze stresem albo amount wynosi 0 lub mniej.

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

stress.provider

Strona: Serwer · Czeka: nie

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

Zwraca HUD, który prowadzi stres, albo null.

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

needs

needs.refill

Wypełnia głód i pragnienie do pełna (wskrzeszenie przez administratora, szpital) przez HUD, który je prowadzi, a bez niego przez metadane postaci w ai-core.

Strona: Serwer · Czeka: nie

Sygnatura
needs.refill(source: number): boolean

Brak odpowiednika w Lua: wywołaj eksport ai-core RefillNeeds(source).

Zwraca true, gdy wypełniono, false, gdy gracz nie ma postaci.

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

Definicje prac i gangów

definitions.job

Definicja pracy ustawiona w panelu ai-core. Każda jest czytana raz z ai-core i trzymana, dopóki panel jej nie zmieni, więc odczyt to wyszukanie w pamięci.

Strona: Serwer · Czeka: nie

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

Zwraca JobDefinition (label, type, defaultDuty, listed?, grades) albo null, gdy taka praca nie istnieje.

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

definitions.gang

Strona: Serwer · Czeka: nie

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

Zwraca GangDefinition (label, grades) albo null.

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

definitions.registerJob and definitions.removeJob

Praca, którą przynosi Twój skrypt, bez dodawania jej przez właściciela w panelu: praca wołającego resource, znika gdy resource się zatrzyma i nigdy nie jest zapisywana do pliku panelu.

Strona: Serwer · Czeka: nie

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

Parametry

Prop

Type

Zwraca

registerJob odpowiada ActionResult: { ok: true } albo { ok: false, error } z kluczem językowym, gdy panel ma już pracę o tej nazwie albo zarejestrował ją inny resource - panel właściciela zawsze wygrywa. removeJob odpowiada true tylko dla pracy, którą zarejestrował ten resource.

Przykład

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

// Raz przy starcie: praca istnieje, dopóki ten resource działa.
const result = definitions.registerJob("garbage", {
  label: "Garbage",
  type: "job",
  defaultDuty: true,
  grades: [{ label: "Driver", salary: 60, boss: false }],
});
if (!result.ok) console.log(`praca nie zarejestrowana: ${result.error}`);

Praca, którą właściciel serwera ma móc edytować, należy do panelu, nie tutaj. Rejestruj wtedy, gdy praca jest częścią Twojego skryptu i bez niego nic nie znaczy.

definitions.registerGang and definitions.removeGang

To samo dla gangów.

Strona: Serwer · Czeka: nie

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

Zwraca

Jak przy pracach: ActionResult dla rejestracji, boolean dla usunięcia.

Prime time

isPrimeTime

Czy dla pracy trwa prime time, według ustawienia prime time w ai-core. Godziny pochodzą z tgiann-policealert, gdy działa, a w przeciwnym razie z godzin ustawionych w panelu ai-core.

Strona: Serwer · Czeka: nie

Sygnatura
isPrimeTime(job?: string): boolean

Brak odpowiednika w Lua: wywołaj eksport ai-core IsPrimeTime(job).

Prop

Type

Zwraca true w czasie prime time.

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

Na tej stronie