AI Core
API başvurusuLib: server

Karakterler, yüklü olsun olmasın

characters modülü: ai-core üzerinden her karakteri bul, oku ve değiştir - para, meslek, çete, metadata, ad, oynama süresi - TypeScript'te Promise, Lua'da düz bekleme ile.

TypeScript
import { characters } from "@aicore8/lib/server";
Lua
-- shared_script '@ai-lib/init.lua' sonrasında aiLib.characters

characters, lib'in ai-core'un kayıtlı karakter export'larına açılan kapısıdır. Var olma sebebi şu: o export'lar bir callback ile cevap verir; lib her birini TypeScript'te Promise'e, Lua'da düz beklemeye çevirir, böylece kodun yukarıdan aşağıya okunur.

  • Bir karakter karakter id'si (charId, bir sayı) ile adlandırılır. citizenid'den çevirmek için characters.idOf.
  • Yüklü bir karakter bellekten cevap verir (canlı para, canlı üyelikler); kayıtlı olan, ai-core onu tutarken veritabanından okunur, yani bir yazmanın ortasında yüklenemez.
  • Her yazma ActionResult döner: { ok: true } ya da bir ai-core dil anahtarıyla { ok: false, error }.
  • Buradaki her fonksiyon bekler. Lua'da bu, onu bir thread içinden çağırmak demektir; bkz. Bekleyen fonksiyonlar.

Bir işlemin konusu olan oyuncu için kısa yol genelde doğrudan ai-core'dur: GetCharacter, money, jobs. characters'ı hedef çevrimdışı olabileceğinde ya da bütün bir karaktere birden ihtiyacın olduğunda kullan.

characters

characters.idOf

Bir citizenid'nin arkasındaki karakter id'si.

Taraf: Server · Bekler: evet

İmza
characters.idOf(citizenid: string): Promise<number | null>

Lua karşılığı yok: ai-core'un GetCharIdByCitizenId export'unu çağır ve callback'ini bekle.

Parametreler

Prop

Type

Dönüş değeri

Promise<number | null>: karakter id'si ya da o citizenid'ye sahip karakter yoksa / silinmişse null.

Örnek

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

/** Sürücü çevrimiçi olsun olmasın çalışan bir ceza. */
export async function fine(citizenid: string, amount: number): Promise<boolean> {
  const charId = await characters.idOf(citizenid);
  if (charId === null) return false;
  return (await characters.removeMoney(charId, "bank", amount, "Hız cezası")).ok;
}

characters.get

ai-core'un bir karakter hakkında tuttuğu her şeyle tek bir karakter: bilgileri, hesap başına parası, meslekleri, çeteleri, metadata'sı, kayıtlı konumu, son kaydı ve yüklüyse server id'si.

Taraf: Server · Bekler: evet

İmza
characters.get(charId: number): Promise<OfflineCharacter | null>
Lua
local character = aiLib.characters.get(charId) -- tablo ya da nil

Parametreler

Prop

Type

Dönüş değeri

Bir OfflineCharacter ya da id bilinmiyorsa / karakter silinmişse null (Lua'da nil).

Örnek

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

export async function bankOf(charId: number): Promise<number> {
  const c = await characters.get(charId);
  return c?.money.bank ?? 0;
}

characters.search

Yazılan bir metne göre karakterler, yüklü olsun olmasın: ad başlangıçları ("jane doe" da olur), citizenid, fivem / license / discord id. Sayfa başına 25, en yeni başta.

Taraf: Server · Bekler: evet

İmza
characters.search(text: string, cursor?: number): Promise<CharacterSearchPage>
Lua
local page = aiLib.characters.search(text, cursor)

Parametreler

Prop

Type

Dönüş değeri

Bir CharacterSearchPage: characters (en çok 25) ve next (son sayfada null). Hata durumunda null değil, boş bir sayfa döner.

Örnek

import { characters, onClientCallback } from "@aicore8/lib/server";
import { oneArg, readText } from "@aicore8/lib/shared";

onClientCallback(
  "myscript:people",
  { args: oneArg((v) => readText(v, 64)), rate: { count: 10, windowMs: 10_000 } },
  async (_source, text) => ({ ok: true, ...(await characters.search(text)) }),
);

characters.ofUser

Bir hesabın her karakteri, slot sırasıyla.

Taraf: Server · Bekler: evet

İmza
characters.ofUser(user: number | string): Promise<StoredCharacter[]>
Lua
local list = aiLib.characters.ofUser(user)

Parametreler

Prop

Type

Dönüş değeri

Slot sırasıyla bir StoredCharacter dizisi. Bilinmeyen hesap için boş.

characters.jobMembers and characters.gangMembers

Bir mesleği tutan ya da bir çetede olan herkes, yüklü olsun olmasın - sayfa sayfa, derecesiyle ve bağlıysa server id'siyle.

Taraf: Server · Bekler: evet

İmza
characters.jobMembers(job: string, after?: number, limit?: number): Promise<MembersPage>
characters.gangMembers(gang: string, after?: number, limit?: number): Promise<MembersPage>
Lua
local page = aiLib.characters.jobMembers(job, after, limit)
local page = aiLib.characters.gangMembers(gang, after, limit)

Parametreler

Prop

Type

Dönüş değeri

Bir MembersPage: members ve next (son sayfada null).

Örnek

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

/** Bir mesleğin bütün kadrosu, sayfa sayfa. */
export async function roster(job: string) {
  const all = [];
  let after: number | undefined;
  do {
    const page = await characters.jobMembers(job, after);
    all.push(...page.members);
    after = page.next ?? undefined;
  } while (after !== undefined);
  return all;
}

Bir meslekte bağlı olan oyuncuları saymak bu değildir: o, lib'in aynasıdır - online.jobMembers (export çağrısı yok, veritabanı okuması yok).

characters.hasJobMember

Bir mesleği tutan herhangi biri var mı, yüklü olsun olmasın. Tek satır okunur, yani bir açılış kontrolü için yeterince hafiftir ("bu sunucuda polis teşkilatı var mı?").

Taraf: Server · Bekler: evet

İmza
characters.hasJobMember(job: string): Promise<boolean>
Lua
local anyone = aiLib.characters.hasJobMember(job)

Dönüş değeri

Mesleği tutan en az bir karakter varsa true.

characters.addMoney, characters.removeMoney and characters.setMoney

Bir karakterin parası, yüklü olsun olmasın, defter satırıyla. Yüklü bir karakter canlı cüzdanından geçer, yani oyuncu değişimi anında görür.

Taraf: Server · Bekler: evet

İmza
characters.addMoney(charId: number, account: string, amount: number, reason?: string): Promise<CharacterResult>
characters.removeMoney(charId: number, account: string, amount: number, reason?: string): Promise<CharacterResult>
characters.setMoney(charId: number, account: string, amount: number, reason?: string): Promise<CharacterResult>
Lua
local result = aiLib.characters.addMoney(charId, account, amount, reason)
local result = aiLib.characters.removeMoney(charId, account, amount, reason)
local result = aiLib.characters.setMoney(charId, account, amount, reason)

Parametreler

Prop

Type

Dönüş değeri

{ ok: true } ya da bir dil anahtarıyla { ok: false, error }: bilinmeyen karakter, bilinmeyen hesap, ondalıklı ya da negatif miktar, veya ödemeye yetmeyen bakiye (removeMoney, hesap tipi sıfırın altına inemiyorsa).

Örnek

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

export async function payOut(charId: number, amount: number): Promise<boolean> {
  const result = await characters.addMoney(charId, "bank", amount, "Araç satıldı");
  if (!result.ok) console.log(`ödeme reddedildi: ${result.error}`);
  return result.ok;
}

İki hesap arasında para taşımak tek çağrı ve tek transaction'dır: money.transfer. Kayıtlı bir karakterin defteri ise { owner: "character", id, account } ile money.history.

characters.setJob and characters.removeJob

Bir karakteri işe alır, derecesini değiştirir ya da işten çıkarır; çevrimiçi olsun olmasın. Panelin meslek kuralları geçerlidir ve işsizlik mesleği asla kaydedilmez: son mesleği kaldırmak karakteri işsiz yapar.

Taraf: Server · Bekler: evet

İmza
characters.setJob(charId: number, job: string, grade: number): Promise<CharacterResult>
characters.removeJob(charId: number, job: string): Promise<CharacterResult>
Lua
local result = aiLib.characters.setJob(charId, job, grade)
local result = aiLib.characters.removeJob(charId, job)

Parametreler

Prop

Type

Dönüş değeri

{ ok: true } ya da { ok: false, error }: bilinmeyen karakter, bilinmeyen meslek, bilinmeyen derece ya da panelin "bir karakter kaç meslek tutabilir" sınırı.

Örnek

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

/** Çevrimiçi olsun olmasın bir üyeyi işten çıkar. */
export async function fire(charId: number, job: string): Promise<boolean> {
  return (await characters.removeJob(charId, job)).ok;
}

characters.setGang and characters.removeGang

Çeteler için aynısı.

Taraf: Server · Bekler: evet

İmza
characters.setGang(charId: number, gang: string, grade: number): Promise<CharacterResult>
characters.removeGang(charId: number, gang: string): Promise<CharacterResult>
Lua
local result = aiLib.characters.setGang(charId, gang, grade)
local result = aiLib.characters.removeGang(charId, gang)

Dönüş değeri

Mesleklerde olduğu gibi { ok: true } ya da { ok: false, error }.

characters.setMeta

Bir karakterin tek bir metadata değeri, yüklü olsun olmasın. Yüklü bir karakter bunu kendi oyununda delta olarak alır.

Taraf: Server · Bekler: evet

İmza
characters.setMeta(charId: number, key: string, value: unknown): Promise<CharacterResult>
Lua
local result = aiLib.characters.setMeta(charId, key, value)

Parametreler

Prop

Type

Dönüş değeri

{ ok: true } ya da bilinmeyen karakter veya JSON'un tutamadığı bir değer için { ok: false, error }. Metadata okumak characters.get içindedir; bağlı bir oyuncu için GetMeta.

characters.setInfo

Ad, doğum tarihi, uyruk, cinsiyet ve boy; her biri karakter oluşturma formunun kontrol ettiği gibi kontrol edilir.

Taraf: Server · Bekler: evet

İmza
characters.setInfo(charId: number, patch: CharacterInfoPatch): Promise<CharacterResult>
Lua
local result = aiLib.characters.setInfo(charId, patch)

Parametreler

Prop

Type

Dönüş değeri

{ ok: true } ya da bir dil anahtarıyla { ok: false, error } (oluşturucunun reddedeceği bir ad, YYYY-MM-DD olmayan bir tarih, yüklü karakterde sex).

characters.remove

Bir karakteri siler (yumuşak silme: satır loglar için kalır).

Taraf: Server · Bekler: evet

İmza
characters.remove(charId: number, by?: number | string): Promise<CharacterResult>
Lua
local result = aiLib.characters.remove(charId, by)

Parametreler

Prop

Type

Dönüş değeri

{ ok: true } ya da bilinmeyen karakter veya şu anda yüklü olan bir karakter için { ok: false, error }.

characters.playTime

Bir karakterin oynandığı saniye: kayıtlı toplam artı süren oturum.

Taraf: Server · Bekler: evet

İmza
characters.playTime(target: number | { charId: number }): Promise<number | null>
Lua
local seconds = aiLib.characters.playTime(target)

Parametreler

Prop

Type

Dönüş değeri

Saniye ya da bilinmeyen karakter için null (ya da yüklü karakteri olmayan bir server id için).

characters.save

Bağlı bir oyuncunun konumunu ve metadata'sını hemen yazar ve bekleyen yazmalarını bekler.

Taraf: Server · Bekler: evet

İmza
characters.save(source: number): Promise<boolean>
Lua
local ok = aiLib.characters.save(source)

Dönüş değeri

Her şey yazıldığında true, oyuncunun yüklü karakteri yoksa false. ai-core kendi kendine kaydeder (periyodik, karakter çıkarken, kapanışta): bunu yalnızca yazmanın sıradaki adımından önce olmuş olması gerektiğinde kullan.

Lib'in başka yerlerinde

İstediğinNerede
Kayıtlı bir karakterin doğma noktasıcharacters.setOfflinePosition
Şu anda bağlı olanlar, adları, meslekleri ve görev durumuonline
Yüklü bir oyuncunun meslekleri ve çetelerijobs
Yüklü bir oyuncunun parasımoney
Bir karakterin para defterimoney.history

Bu sayfada