Работы и службы
Полицейские оповещения, тюрьма, записи MDT, медики, реанимация и лечение, стресс, голод и жажда, определения работ и банд, прайм-тайм.
import { jobs, dispatch, prison, mdt, ems, medical, stress, needs, definitions, isPrimeTime } from "@aicore8/lib/server";jobs и definitions - это сам ai-core: работы и банды персонажа и определения работ сервера. Всё остальное здесь идёт через один из слоёв ai-core, где отвечает скрипт, который сервер держит для этой задачи (система вызовов, тюрьма, MDT, скрипт смерти, HUD). Ваш скрипт продолжит работать, когда владелец его заменит. Пока такого скрипта нет, эти вызовы тихо не срабатывают (false, 0, null).
jobs
jobs - это собственные работы и банды загруженного игрока через ai-core: у персонажа может быть несколько работ, на смене он не больше чем в одной, и действует за одну банду. Читать многих игроков сразу - это зеркало библиотеки (online); менять персонажа, который не подключён, - это characters.
jobs.current
Работа, которую другие скрипты видят как «ту» работу игрока: та, на смене которой он есть, иначе последняя, где он был на смене, иначе первая, что у него есть, иначе работа безработного.
Сторона: Сервер · Ждёт: нет
jobs.current(source: number): JobMembership | nulllocal current = aiLib.jobs.current(source)Возвращает
JobMembership ({ job, grade }) или null, когда у игрока нет загруженного персонажа.
Пример
import { jobs } from "@aicore8/lib/server";
export function isOfficer(source: number): boolean {
return jobs.current(source)?.job === "police";
}jobs.list
Каждая работа, которая есть у игрока.
Сторона: Сервер · Ждёт: нет
jobs.list(source: number): JobMembership[]local list = aiLib.jobs.list(source)Возвращает
Массив JobMembership. Пустой, когда у игрока нет загруженного персонажа или нет ни одной работы.
jobs.duty and jobs.setDuty
В какой работе игрок на смене, и выход на смену или с неё. Многие скрипты проверяют смену, а не принадлежность: офицер не на смене - гражданский.
Сторона: Сервер · Ждёт: нет
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)Параметры
Prop
Type
Возвращает
jobs.duty: название работы или null вне смены (либо без персонажа). jobs.setDuty: true, когда изменение прошло, false для работы, которой у игрока нет.
jobs.set
Добавляет игроку работу или меняет грейд работы, которая у него уже есть. Действуют правила панели: сколько работ может быть у персонажа и разрешена ли вторая вообще.
Сторона: Сервер · Ждёт: нет
jobs.set(source: number, job: string, grade: number): booleanlocal ok = aiLib.jobs.set(source, job, grade)Параметры
Prop
Type
Возвращает
boolean: true, когда после этого у игрока есть эта работа в этом грейде. false без загруженного персонажа, при неизвестной работе, неизвестном грейде либо лимите работ из панели.
Пример
import { jobs, notify } from "@aicore8/lib/server";
export function hire(source: number, job: string): void {
if (!jobs.set(source, job, 0)) return notify(source, "Не удалось принять на работу", "error");
notify(source, `Добро пожаловать в ${job}`, "success");
}jobs.remove
Забирает работу. Персонаж без работ считается безработным: сама работа безработного никогда не сохраняется.
Сторона: Сервер · Ждёт: нет
jobs.remove(source: number, job: string): booleanlocal ok = aiLib.jobs.remove(source, job)Возвращает
boolean: true, когда работа забрана, false, когда у игрока её не было (либо нет загруженного персонажа).
jobs.unemployed
Название работы, которая есть у персонажа без работы, как задано в панели. Никогда не считайте, что это "unemployed": сервер может назвать её как угодно.
Сторона: Сервер · Ждёт: нет
jobs.unemployed(): stringlocal name = aiLib.jobs.unemployed()Возвращает
string: название работы из панели.
jobs.onDutyCount
Сколько игроков сейчас на смене в работе - число, которое обычно нужно диспетчеру или проверке на входе.
Сторона: Сервер · Ждёт: нет
jobs.onDutyCount(job: string): numberlocal count = aiLib.jobs.onDutyCount(job)Возвращает
number: сколько подключённых игроков на смене в этой работе, 0 если никого.
jobs.gangs
Каждая банда игрока.
Сторона: Сервер · Ждёт: нет
jobs.gangs(source: number): GangMembership[]local list = aiLib.jobs.gangs(source)Возвращает
Массив GangMembership, пустой, если он ни в одной.
jobs.activeGang and jobs.setActiveGang
Персонаж может быть в нескольких бандах, но действует за одну: это активная банда, и именно её должен читать скрипт территорий или наркотиков.
Сторона: Сервер · Ждёт: нет
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)Возвращает
jobs.activeGang: название банды или null, если активной нет. jobs.setActiveGang: true, когда изменение прошло, false для банды, в которой игрока нет (null очищает её).
jobs.setGang and jobs.removeGang
Добавляет, меняет грейд или забирает банду игрока.
Сторона: Сервер · Ждёт: нет
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)Возвращает
boolean, как и у работ: false без загруженного персонажа, при неизвестной банде или неизвестном грейде.
dispatch
dispatch.alert
Отправляет оповещение полиции (или другой работе). Система оповещений показывает его членам jobs на дежурстве, по умолчанию полицейским работам.
Сторона: Сервер · Ждёт: нет
dispatch.alert(alert: DispatchAlert): booleanlocal ok = aiLib.dispatch.alert(alert)DispatchAlert
Prop
Type
Тип: DispatchAlert.
Возвращает
boolean: true, если отправлено. false, если не запущена система оповещений или оповещение неверное.
Пример
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
Тюремные сроки через ai-core, какой бы скрипт тюрьмы ни был запущен.
prison.jail
Отправляет загруженного игрока в тюрьму.
Сторона: Сервер · Ждёт: нет
prison.jail(source: number, minutes: number, by?: number): booleanlocal ok = aiLib.prison.jail(source, minutes, by)Prop
Type
Возвращает true, если посажен, false, пока не запущена тюрьма.
if (!prison.jail(target, 15, officer)) return fail("NO_PRISON");prison.release
Выпускает заключённого игрока.
Сторона: Сервер · Ждёт: нет
prison.release(source: number): booleanlocal ok = aiLib.prison.release(source)Возвращает true, если освобождён, false, если игрок не в тюрьме или тюрьма не запущена.
prison.release(target);prison.timeLeft
Сторона: Сервер · Ждёт: нет
prison.timeLeft(source: number): numberlocal minutes = aiLib.prison.timeLeft(source)Возвращает оставшиеся минуты срока, 0, если игрок на свободе.
if (prison.timeLeft(source) > 0) return fail("IN_PRISON");mdt
Полицейские записи MDT (штрафы, ордера, аресты, тюрьма) через слой MDT ai-core. Пока MDT не запущен, ничего не записывается.
mdt.record
Записывает запись в полицейский MDT.
Сторона: Сервер · Ждёт: нет
mdt.record(record: MdtRecord): booleanlocal ok = aiLib.mdt.record(record)MdtRecord
Prop
Type
Тип: MdtRecord.
Возвращает true, если записано, false, если MDT не запущен или не принимает такую запись.
if (prison.jail(target, 20, officer)) mdt.record({ kind: "jail", target, by: officer, title: "Armed robbery", minutes: 20 });mdt.provider
Сторона: Сервер · Ждёт: нет
mdt.provider(): string | nulllocal name = aiLib.mdt.provider()Возвращает MDT, в который уходят записи, или null.
if (!mdt.provider()) console.log("no MDT: records are skipped");ems
Медики через слой EMS ai-core: собственный подсчёт и вызовы бедствия скрипта EMS, иначе подсчёт дежурных и оповещения ai-core.
ems.available
Сколько медиков свободно, чтобы принять вызов.
Сторона: Сервер · Ждёт: нет
ems.available(jobs: string[]): numberlocal count = aiLib.ems.available(jobs)Prop
Type
Возвращает число медиков на дежурстве в jobs, не считая занятых, если скрипт диспетчера о них знает.
// Разрешаем игрокам возрождаться в больнице, только если ни один медик не может приехать.
const canRespawn = ems.available(["ambulance"]) === 0;ems.distress
Отправляет вызов бедствия для игрока медикам из call.jobs.
Сторона: Сервер · Ждёт: нет
ems.distress(source: number, call: DistressCall): booleanlocal ok = aiLib.ems.distress(source, call)Prop
Type
Тип: DistressCall.
Возвращает true, если вызов кто-то принял, иначе false.
if (!ems.distress(source, { jobs: ["ambulance"], message: "Unconscious" })) return fail("NO_MEDICS");ems.provider
Сторона: Сервер · Ждёт: нет
ems.provider(): string | nulllocal name = aiLib.ems.provider()Возвращает источник EMS, который использует слой, "ai-core" для собственного подсчёта дежурных.
console.log(`medics through ${ems.provider()}`);medical
Реанимация, лечение и состояние без сознания через медицинский слой ai-core, какой бы скрипт смерти или скорой помощи ни был запущен. Lua-аналога нет: вызывайте экспорты ai-core RevivePlayer, HealPlayer, IsPlayerDead.
medical.revive
Поднимает игрока без сознания там, где он лежит.
Сторона: Сервер · Ждёт: нет
medical.revive(source: number): booleanВозвращает true, если реанимирован, false, если игрок не без сознания или не запущен скрипт смерти.
if (!medical.revive(target)) return fail("NOT_DOWN");medical.heal
Полностью восстанавливает здоровье игроку, который не лежит без сознания.
Сторона: Сервер · Ждёт: нет
medical.heal(source: number): booleanВозвращает true, если вылечен, false, если не запущен скрипт смерти.
medical.heal(source);medical.isDead
Лежит ли игрок без сознания.
Сторона: Сервер · Ждёт: нет
medical.isDead(source: number): booleanВозвращает true, если без сознания; false без скрипта смерти. Используйте вместо чтения здоровья педа.
if (medical.isDead(source)) return fail("YOU_ARE_DOWN");medical.provider
Сторона: Сервер · Ждёт: нет
medical.provider(): string | nullВозвращает скрипт смерти, который отвечает (ai-death...), или null, если никакой не запущен.
console.log(`deaths through ${medical.provider() ?? "nothing"}`);stress
Стресс игроков (от 0 до 100) через слой стресса ai-core, какой бы HUD его ни хранил.
stress.gain
Добавляет очки стресса.
Сторона: Сервер · Ждёт: нет
stress.gain(source: number, amount: number): booleanlocal ok = aiLib.stress.gain(source, amount)Prop
Type
Возвращает true, если добавлено, false, если не запущен HUD со стрессом.
stress.gain(source, 5); // после перестрелкиstress.relieve
Убирает очки стресса.
Сторона: Сервер · Ждёт: нет
stress.relieve(source: number, amount: number): booleanlocal ok = aiLib.stress.relieve(source, amount)Возвращает true, если убрано, false, если не запущен HUD со стрессом или amount равен 0 или меньше.
inventory.registerUsableItem("cigarette", (source) => {
stress.relieve(source, 10);
});stress.provider
Сторона: Сервер · Ждёт: нет
stress.provider(): string | nulllocal name = aiLib.stress.provider()Возвращает HUD, который хранит стресс, или null.
if (!stress.provider()) console.log("no HUD keeps stress");needs
needs.refill
Полностью восполняет голод и жажду (реанимация администратором, больница) через HUD, который их хранит, а без него через метаданные персонажа ai-core.
Сторона: Сервер · Ждёт: нет
needs.refill(source: number): booleanLua-аналога нет: вызывайте экспорт ai-core RefillNeeds(source).
Возвращает true, если восполнено, false, если у игрока нет персонажа.
if (medical.revive(target)) needs.refill(target);Определения работ и банд
definitions.job
Определение работы так, как оно задано в панели ai-core. Каждое читается из ai-core один раз и хранится, пока панель его не изменит, поэтому чтение сводится к поиску в памяти.
Сторона: Сервер · Ждёт: нет
definitions.job(name: string): JobDefinition | nulllocal definition = aiLib.definitions.job(name)Возвращает JobDefinition (label, type, defaultDuty, listed?, grades) или null, если такой работы нет.
const label = definitions.job("police")?.label ?? "police";definitions.gang
Сторона: Сервер · Ждёт: нет
definitions.gang(name: string): GangDefinition | nulllocal definition = aiLib.definitions.gang(name)Возвращает GangDefinition (label, grades) или null.
const gang = definitions.gang("ballas");
if (!gang) return fail("UNKNOWN_GANG");definitions.registerJob and definitions.removeJob
Работа, которую приносит ваш скрипт, без добавления владельцем в панель: работа вызывающего ресурса, исчезает, когда ресурс останавливается, и никогда не пишется в файл панели.
Сторона: Сервер · Ждёт: нет
definitions.registerJob(name: string, definition: JobDefinition): CharacterResult
definitions.removeJob(name: string): booleanlocal result = aiLib.definitions.registerJob(name, definition)
local ok = aiLib.definitions.removeJob(name)Параметры
Prop
Type
Возвращает
registerJob отвечает ActionResult: { ok: true } или { ok: false, error } с языковым ключом, когда в панели уже есть работа с таким названием либо её зарегистрировал другой ресурс - панель владельца всегда выигрывает. removeJob отвечает true только для работы, которую зарегистрировал этот ресурс.
Пример
import { definitions } from "@aicore8/lib/server";
// Один раз при запуске: работа существует, пока работает этот ресурс.
const result = definitions.registerJob("garbage", {
label: "Garbage",
type: "job",
defaultDuty: true,
grades: [{ label: "Driver", salary: 60, boss: false }],
});
if (!result.ok) console.log(`работа не зарегистрирована: ${result.error}`);Работа, которую владелец сервера должен уметь править, относится к панели, а не сюда. Регистрируйте её, когда работа - часть вашего скрипта и без него ничего не значит.
definitions.registerGang and definitions.removeGang
То же для банд.
Сторона: Сервер · Ждёт: нет
definitions.registerGang(name: string, definition: GangDefinition): CharacterResult
definitions.removeGang(name: string): booleanlocal result = aiLib.definitions.registerGang(name, definition)
local ok = aiLib.definitions.removeGang(name)Возвращает
Как и у работ: ActionResult для регистрации, boolean для удаления.
Прайм-тайм
isPrimeTime
Идёт ли прайм-тайм для работы, по настройке прайм-тайма ai-core. Часы берутся из tgiann-policealert, пока он запущен, иначе из часов, заданных в панели ai-core.
Сторона: Сервер · Ждёт: нет
isPrimeTime(job?: string): booleanLua-аналога нет: вызывайте экспорт ai-core IsPrimeTime(job).
Prop
Type
Возвращает true во время прайм-тайма.
if (!isPrimeTime("police")) return fail("BANK_CLOSED_FOR_HEISTS");