Jobs und Dienste
Polizeialarme, Gefängnis, MDT-Einträge, Sanitäter, Wiederbeleben und Heilen, Stress, Hunger und Durst, Job- und Gang-Definitionen, Prime Time.
import { jobs, dispatch, prison, mdt, ems, medical, stress, needs, definitions, isPrimeTime } from "@aicore8/lib/server";jobs und definitions sind ai-core selbst: die Jobs und Gangs eines Charakters und die Job-Definitionen des Servers. Alles andere hier geht über einen von ai-cores Layern, wo das Script antwortet, das der Server für diese Aufgabe fährt (ein Alarmsystem, ein Gefängnis, ein MDT, ein Death-Script, ein HUD). Dein Script läuft weiter, wenn der Besitzer es tauscht. Solange kein solches Script läuft, scheitern diese Aufrufe still (false, 0, null).
jobs
jobs sind die eigenen Jobs und Gangs eines geladenen Spielers über ai-core: ein Charakter kann mehrere Jobs halten, ist in höchstens einem im Dienst und handelt für eine Gang zur Zeit. Viele Spieler auf einmal zu lesen ist der Spiegel der Lib (online); einen Charakter zu ändern, der nicht verbunden ist, ist characters.
jobs.current
Der Job, den andere Scripts als "den" Job eines Spielers sehen: der, in dem er im Dienst ist, sonst der, in dem er zuletzt im Dienst war, sonst der erste, den er hält, sonst der Arbeitslosen-Job.
Seite: Server · Wartet: nein
jobs.current(source: number): JobMembership | nulllocal current = aiLib.jobs.current(source)Rückgabe
Ein JobMembership ({ job, grade }), oder null, wenn der Spieler keinen geladenen Charakter hat.
Beispiel
import { jobs } from "@aicore8/lib/server";
export function isOfficer(source: number): boolean {
return jobs.current(source)?.job === "police";
}jobs.list
Jeder Job, den der Spieler hält.
Seite: Server · Wartet: nein
jobs.list(source: number): JobMembership[]local list = aiLib.jobs.list(source)Rückgabe
Ein Array von JobMembership. Leer, wenn der Spieler keinen geladenen Charakter hat oder nichts hält.
jobs.duty and jobs.setDuty
In welchem Job der Spieler im Dienst ist, und in den Dienst gehen oder aus ihm heraus. Viele Scripts prüfen den Dienst statt der Mitgliedschaft: ein Beamter außer Dienst ist ein Zivilist.
Seite: Server · Wartet: nein
jobs.duty(source: number): string | null
jobs.setDuty(source: number, job: string | null): booleanlocal onDutyIn = aiLib.jobs.duty(source)
local ok = aiLib.jobs.setDuty(source, job)Parameter
Prop
Type
Rückgabe
jobs.duty: der Jobname, oder null, wenn außer Dienst (oder kein Charakter). jobs.setDuty: true, wenn die Änderung gemacht wurde, false bei einem Job, den der Spieler nicht hält.
jobs.set
Gibt dem Spieler einen Job oder ändert den Grade eines Jobs, den er schon hält. Die Regeln des Panels gelten: wie viele Jobs ein Charakter halten darf und ob ein zweiter überhaupt erlaubt ist.
Seite: Server · Wartet: nein
jobs.set(source: number, job: string, grade: number): booleanlocal ok = aiLib.jobs.set(source, job, grade)Parameter
Prop
Type
Rückgabe
boolean: true, wenn der Spieler den Job danach in diesem Grade hält. false ohne geladenen Charakter, bei einem unbekannten Job, einem unbekannten Grade, oder beim Joblimit des Panels.
Beispiel
import { jobs, notify } from "@aicore8/lib/server";
export function hire(source: number, job: string): void {
if (!jobs.set(source, job, 0)) return notify(source, "Einstellung nicht möglich", "error");
notify(source, `Willkommen bei ${job}`, "success");
}jobs.remove
Nimmt einen Job weg. Ein Charakter ohne Jobs gilt als arbeitslos: der Arbeitslosen-Job selbst wird nie gespeichert.
Seite: Server · Wartet: nein
jobs.remove(source: number, job: string): booleanlocal ok = aiLib.jobs.remove(source, job)Rückgabe
boolean: true, wenn der Job weggenommen wurde, false, wenn der Spieler ihn nicht hielt (oder keinen geladenen Charakter hat).
jobs.unemployed
Der Jobname, den ein Charakter ohne Job hat, wie im Panel gesetzt. Nimm nie "unemployed" an: ein Server kann ihn beliebig nennen.
Seite: Server · Wartet: nein
jobs.unemployed(): stringlocal name = aiLib.jobs.unemployed()Rückgabe
string: der Jobname aus dem Panel.
jobs.onDutyCount
Wie viele Spieler gerade in einem Job im Dienst sind - die Zahl, die ein Dispatch oder ein Job-Gate meist will.
Seite: Server · Wartet: nein
jobs.onDutyCount(job: string): numberlocal count = aiLib.jobs.onDutyCount(job)Rückgabe
number: wie viele verbundene Spieler in diesem Job im Dienst sind, 0 wenn niemand.
jobs.gangs
Jede Gang, in der der Spieler ist.
Seite: Server · Wartet: nein
jobs.gangs(source: number): GangMembership[]local list = aiLib.jobs.gangs(source)Rückgabe
Ein Array von GangMembership, leer wenn in keiner.
jobs.activeGang and jobs.setActiveGang
Ein Charakter kann in mehreren Gangs sein, handelt aber für eine zur Zeit: das ist die aktive Gang, und die sollte ein Turf- oder Drogen-Script lesen.
Seite: Server · Wartet: nein
jobs.activeGang(source: number): string | null
jobs.setActiveGang(source: number, gang: string | null): booleanlocal active = aiLib.jobs.activeGang(source)
local ok = aiLib.jobs.setActiveGang(source, gang)Rückgabe
jobs.activeGang: der Gangname, oder null, wenn keine aktiv ist. jobs.setActiveGang: true, wenn die Änderung gemacht wurde, false bei einer Gang, in der der Spieler nicht ist (null löscht sie).
jobs.setGang and jobs.removeGang
Gibt dem Spieler eine Gang, ändert ihren Grade oder nimmt sie weg.
Seite: Server · Wartet: nein
jobs.setGang(source: number, gang: string, grade: number): boolean
jobs.removeGang(source: number, gang: string): booleanlocal ok = aiLib.jobs.setGang(source, gang, grade)
local ok = aiLib.jobs.removeGang(source, gang)Rückgabe
boolean, wie bei den Job-Aufrufen: false ohne geladenen Charakter, bei einer unbekannten Gang oder einem unbekannten Grade.
dispatch
dispatch.alert
Sendet einen Alarm an die Polizei (oder einen anderen Job). Das Alarmsystem zeigt ihn den Mitgliedern von jobs im Dienst, standardmäßig den Polizei-Jobs.
Seite: Server · Wartet: nein
dispatch.alert(alert: DispatchAlert): booleanlocal ok = aiLib.dispatch.alert(alert)DispatchAlert
Prop
Type
Der Typ ist DispatchAlert.
Rückgabewert
boolean: true, wenn gesendet. false, wenn kein Alarmsystem läuft oder der Alarm ungültig ist.
Beispiel
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
Haftstrafen über ai-core, egal welches Gefängnis-Skript läuft.
prison.jail
Schickt einen geladenen Spieler ins Gefängnis.
Seite: Server · Wartet: nein
prison.jail(source: number, minutes: number, by?: number): booleanlocal ok = aiLib.prison.jail(source, minutes, by)Prop
Type
Rückgabewert: true, wenn eingesperrt, false, solange kein Gefängnis läuft.
if (!prison.jail(target, 15, officer)) return fail("NO_PRISON");prison.release
Lässt einen eingesperrten Spieler frei.
Seite: Server · Wartet: nein
prison.release(source: number): booleanlocal ok = aiLib.prison.release(source)Rückgabewert: true, wenn freigelassen, false, wenn nicht eingesperrt oder kein Gefängnis läuft.
prison.release(target);prison.timeLeft
Seite: Server · Wartet: nein
prison.timeLeft(source: number): numberlocal minutes = aiLib.prison.timeLeft(source)Rückgabewert: die verbleibenden Strafminuten, 0, wenn frei.
if (prison.timeLeft(source) > 0) return fail("IN_PRISON");mdt
Polizei-MDT-Einträge (Bußgelder, Haftbefehle, Festnahmen, Haft) über die MDT-Ebene von ai-core. Solange kein MDT läuft, wird nichts geschrieben.
mdt.record
Schreibt einen Eintrag ins Polizei-MDT.
Seite: Server · Wartet: nein
mdt.record(record: MdtRecord): booleanlocal ok = aiLib.mdt.record(record)MdtRecord
Prop
Type
Der Typ ist MdtRecord.
Rückgabewert: true, wenn geschrieben, false, wenn kein MDT läuft oder es keinen solchen Eintrag annimmt.
if (prison.jail(target, 20, officer)) mdt.record({ kind: "jail", target, by: officer, title: "Armed robbery", minutes: 20 });mdt.provider
Seite: Server · Wartet: nein
mdt.provider(): string | nulllocal name = aiLib.mdt.provider()Rückgabewert: das MDT, an das Einträge gehen, oder null.
if (!mdt.provider()) console.log("no MDT: records are skipped");ems
Sanitäter über die EMS-Ebene von ai-core: die eigene Zählung und die Notrufe eines EMS-Skripts, sonst die Dienstzählungen und Alarme von ai-core.
ems.available
Wie viele Sanitäter frei sind, um einen Einsatz zu übernehmen.
Seite: Server · Wartet: nein
ems.available(jobs: string[]): numberlocal count = aiLib.ems.available(jobs)Prop
Type
Rückgabewert: die Anzahl der Sanitäter im Dienst in jobs, ohne beschäftigte, wenn ein Dispatch-Skript sie kennt.
// Spieler nur dann im Krankenhaus respawnen lassen, wenn kein Sanitäter kommen kann.
const canRespawn = ems.available(["ambulance"]) === 0;ems.distress
Sendet einen Notruf für einen Spieler an die Sanitäter von call.jobs.
Seite: Server · Wartet: nein
ems.distress(source: number, call: DistressCall): booleanlocal ok = aiLib.ems.distress(source, call)Prop
Type
Der Typ ist DistressCall.
Rückgabewert: true, wenn etwas den Notruf angenommen hat, sonst false.
if (!ems.distress(source, { jobs: ["ambulance"], message: "Unconscious" })) return fail("NO_MEDICS");ems.provider
Seite: Server · Wartet: nein
ems.provider(): string | nulllocal name = aiLib.ems.provider()Rückgabewert: die EMS-Quelle, die die Ebene nutzt, "ai-core" für die eigenen Dienstzählungen.
console.log(`medics through ${ems.provider()}`);medical
Wiederbeleben, Heilen und der Bewusstlos-Zustand über die Medical-Ebene von ai-core, egal welches Death- oder Ambulance-Skript läuft. Kein Lua-Zwilling: Rufe die Exports RevivePlayer, HealPlayer, IsPlayerDead von ai-core auf.
medical.revive
Bringt einen bewusstlosen Spieler dort wieder auf die Beine, wo er liegt.
Seite: Server · Wartet: nein
medical.revive(source: number): booleanRückgabewert: true, wenn wiederbelebt, false, wenn nicht bewusstlos oder kein Death-Skript läuft.
if (!medical.revive(target)) return fail("NOT_DOWN");medical.heal
Gibt einem Spieler, der nicht bewusstlos ist, volle Gesundheit.
Seite: Server · Wartet: nein
medical.heal(source: number): booleanRückgabewert: true, wenn geheilt, false, wenn kein Death-Skript läuft.
medical.heal(source);medical.isDead
Ob der Spieler bewusstlos ist.
Seite: Server · Wartet: nein
medical.isDead(source: number): booleanRückgabewert: true, wenn bewusstlos; false ohne Death-Skript. Nutze es, statt die Gesundheit des Peds zu lesen.
if (medical.isDead(source)) return fail("YOU_ARE_DOWN");medical.provider
Seite: Server · Wartet: nein
medical.provider(): string | nullRückgabewert: das Death-Skript, das antwortet (ai-death...), oder null, wenn keins läuft.
console.log(`deaths through ${medical.provider() ?? "nothing"}`);stress
Der Stress der Spieler (0 bis 100) über die Stress-Ebene von ai-core, egal welches HUD ihn führt.
stress.gain
Fügt Stresspunkte hinzu.
Seite: Server · Wartet: nein
stress.gain(source: number, amount: number): booleanlocal ok = aiLib.stress.gain(source, amount)Prop
Type
Rückgabewert: true, wenn hinzugefügt, false, wenn kein HUD mit Stress läuft.
stress.gain(source, 5); // nach einer Schießereistress.relieve
Nimmt Stresspunkte weg.
Seite: Server · Wartet: nein
stress.relieve(source: number, amount: number): booleanlocal ok = aiLib.stress.relieve(source, amount)Rückgabewert: true, wenn weggenommen, false, wenn kein HUD mit Stress läuft oder amount 0 oder weniger ist.
inventory.registerUsableItem("cigarette", (source) => {
stress.relieve(source, 10);
});stress.provider
Seite: Server · Wartet: nein
stress.provider(): string | nulllocal name = aiLib.stress.provider()Rückgabewert: das HUD, das den Stress führt, oder null.
if (!stress.provider()) console.log("no HUD keeps stress");needs
needs.refill
Füllt Hunger und Durst ganz auf (Admin-Revive, Krankenhaus), über das HUD, das sie führt, oder ohne eines über die Charakter-Metadaten von ai-core.
Seite: Server · Wartet: nein
needs.refill(source: number): booleanKein Lua-Zwilling: Rufe den Export RefillNeeds(source) von ai-core auf.
Rückgabewert: true, wenn aufgefüllt, false, wenn der Spieler keinen Charakter hat.
if (medical.revive(target)) needs.refill(target);Job- und Gang-Definitionen
definitions.job
Die Definition eines Jobs, wie sie im Panel von ai-core eingestellt ist. Jede wird einmal aus ai-core gelesen und behalten, bis das Panel sie ändert, daher ist ein Lesezugriff ein Nachschlagen im Speicher.
Seite: Server · Wartet: nein
definitions.job(name: string): JobDefinition | nulllocal definition = aiLib.definitions.job(name)Rückgabewert: JobDefinition (label, type, defaultDuty, listed?, grades), oder null, wenn es keinen solchen Job gibt.
const label = definitions.job("police")?.label ?? "police";definitions.gang
Seite: Server · Wartet: nein
definitions.gang(name: string): GangDefinition | nulllocal definition = aiLib.definitions.gang(name)Rückgabewert: GangDefinition (label, grades), oder null.
const gang = definitions.gang("ballas");
if (!gang) return fail("UNKNOWN_GANG");definitions.registerJob and definitions.removeJob
Ein Job, den dein Script mitbringt, ohne dass der Besitzer ihn im Panel anlegt: ein Job der aufrufenden Resource, weg wenn die Resource stoppt, und nie in die Panel-Datei geschrieben.
Seite: Server · Wartet: nein
definitions.registerJob(name: string, definition: JobDefinition): CharacterResult
definitions.removeJob(name: string): booleanlocal result = aiLib.definitions.registerJob(name, definition)
local ok = aiLib.definitions.removeJob(name)Parameter
Prop
Type
Rückgabe
registerJob antwortet ActionResult: { ok: true }, oder { ok: false, error } mit einem Lang-Key, wenn das Panel schon einen Job dieses Namens hat oder eine andere Resource ihn registriert hat - das Panel des Besitzers gewinnt immer. removeJob antwortet nur bei einem Job true, den diese Resource registriert hat.
Beispiel
import { definitions } from "@aicore8/lib/server";
// Einmal beim Start: der Job existiert, solange diese Resource läuft.
const result = definitions.registerJob("garbage", {
label: "Garbage",
type: "job",
defaultDuty: true,
grades: [{ label: "Driver", salary: 60, boss: false }],
});
if (!result.ok) console.log(`Job nicht registriert: ${result.error}`);Ein Job, den der Serverbesitzer bearbeiten können soll, gehört ins Panel, nicht hierher. Registriere einen, wenn der Job Teil deines Scripts ist und ohne es nichts bedeutet.
definitions.registerGang and definitions.removeGang
Dasselbe für Gangs.
Seite: Server · Wartet: nein
definitions.registerGang(name: string, definition: GangDefinition): CharacterResult
definitions.removeGang(name: string): booleanlocal result = aiLib.definitions.registerGang(name, definition)
local ok = aiLib.definitions.removeGang(name)Rückgabe
Wie bei Jobs: ActionResult für die Registrierung, boolean für das Entfernen.
Prime Time
isPrimeTime
Ob für einen Job gerade Prime Time ist, nach der Prime-Time-Einstellung von ai-core. Die Uhrzeiten kommen von tgiann-policealert, solange es läuft, sonst aus den Uhrzeiten im Panel von ai-core.
Seite: Server · Wartet: nein
isPrimeTime(job?: string): booleanKein Lua-Zwilling: Rufe den Export IsPrimeTime(job) von ai-core auf.
Prop
Type
Rückgabewert: true während der Prime Time.
if (!isPrimeTime("police")) return fail("BANK_CLOSED_FOR_HEISTS");Geld und Banking
money.transfer zwischen zwei Konten, das Banking-Skript über ai-core und Rechnungen über das jeweils laufende Rechnungs-Skript.
Welt
Zeit und Wetter über das jeweils laufende Wetter-Skript, Routing-Buckets aus dem Allokator von ai-core, Türschlösser und die Spawnpunkte gespeicherter Charaktere.