Dokumentacja APILib dla Lua
Każda funkcja aiLib
Pełna lista składowych aiLib: strona, czy wywołanie czeka, i strona dokumentacji, która opisuje je z zakładką Lua.
Każda składowa aiLib, z init.lua w ai-lib. Większość to odpowiedniki funkcji TypeScript i jest opisana na stronie tej funkcji, z wywołaniem Lua w bloku sygnatury i zakładką z przykładem Lua. Czeka oznacza, że wywołanie wstrzymuje się, aż przyjdzie odpowiedź: wywołuj je wewnątrz wątku (zobacz Funkcje, które czekają).
Metody klasy (points:add(...), job:set(...)) są wymienione razem z klasą.
Obie strony
| Funkcja | Czeka | Opisana na |
|---|---|---|
aiLib.side | nie | Lib dla Lua |
aiLib.every(ms, fn, options?), job:set(active), job:stop(), job.running | nie | Harmonogram: every |
aiLib.waitFor(check, timeout?, interval?) | tak | Harmonogram: waitFor |
aiLib.formatText(text, ...) | nie | Tekst i liczby: formatText |
aiLib.locale(resource?) | nie | Tłumaczenia: createLocale |
aiLib.fail(error) | nie | Akcje i wejście z klienta: fail |
aiLib.numbers.round(value, decimals?) | nie | Tekst i liczby: round |
aiLib.numbers.groupDigits(value, separator?) | nie | Tekst i liczby: groupDigits |
aiLib.numbers.headingTo(from, to) | nie | Pozycje: headingTo |
aiLib.stripGameText(text) | nie | Tekst i liczby: stripGameText |
aiLib.notify(...): klient (text, kind?, duration?), serwer (source, text, kind?, duration?) | nie | Klient: Wspólne UI, Serwer: Gracze i postacie |
aiLib.inventory, aiLib.world, aiLib.appearance, aiLib.mdt | zobacz niżej | Składowe różnią się zależnie od strony (niżej). |
Klient
| Funkcja | Czeka | Opisana na |
|---|---|---|
aiLib.triggerServerCallback(name, args?, timeout?) | tak | Rozmowa z serwerem |
aiLib.onServerCallback(name, handler) | nie | Rozmowa z serwerem |
aiLib.onServerEvent(name, handler) | nie | Rozmowa z serwerem |
aiLib.callAction(name, args?, { fallback, timeout?, silent? }) | tak | Rozmowa z serwerem |
aiLib.cache (ped, playerId, serverId, vehicle, seat, weapon), aiLib.cache.onChange(key, handler) | nie | Lokalny gracz |
aiLib.player (coords, heading, distanceTo, freeze, teleport, playAnim, stopAnim) | teleport tak | Lokalny gracz |
aiLib.fadeOut(ms?), aiLib.fadeIn(ms?) | tak | Lokalny gracz |
aiLib.playerPed(serverId) | nie | Lokalny gracz |
aiLib.nearestPlayer(metres, { from?, filter? }) | nie | Lokalny gracz |
aiLib.playerData.get(key), aiLib.playerData.onChange(key, handler) | nie | Funkcje tylko dla Lua |
aiLib.Points.new(): :add, :addModel, :addVehicle, :remove, :clear, :refresh | nie | Punkty interakcji |
aiLib.Zones.new(): :add, :remove, :clear, :isInside | nie | Strefy |
aiLib.LocalPed.new(options): :remove | nie | Pedy, blipy i propy |
aiLib.Blips.new(): :add, :get, :remove, :clear; aiLib.Blips.create(options) | nie | Pedy, blipy i propy |
aiLib.progress(options), aiLib.progress.cancel(), aiLib.progress.isRunning() | progress tak | Wspólne UI |
aiLib.menu.show(request, listeners?) | tak | Wspólne UI, tabela menu |
aiLib.input(request) / aiLib.menu.input | tak | Wspólne UI |
aiLib.itemPicker(request) / aiLib.menu.itemPicker | tak | Wspólne UI |
aiLib.skillCheck(difficulty, keys?) / aiLib.menu.skillCheck | tak | Wspólne UI |
aiLib.lockpick(options?) / aiLib.menu.lockpick | tak | Wspólne UI |
aiLib.showPrompt(id, text), aiLib.hidePrompt(id), aiLib.onPromptPressed(handler) | nie | Wspólne UI |
aiLib.hud (hide, show, visible) | nie | Ekrany i sterowanie |
aiLib.keyHints (show, hide) | nie | Ekrany i sterowanie |
aiLib.controls (disable, disableAll, enable) | nie | Ekrany i sterowanie |
aiLib.Keybind.new(options): :disable | nie | Klawisze |
aiLib.inventory (openInventory, hasItem, currentWeapon) | nie | Warstwy przez ai-core |
aiLib.world (pauseSync, resumeSync) | nie | Warstwy przez ai-core |
aiLib.appearance (apply, read, openMenu, wearOutfit, reloadSkin) | nie | Warstwy przez ai-core |
aiLib.gestures (isHandsUp, isPointing, provider, playEmote, cancelEmote, emoteProvider) | nie | Warstwy przez ai-core |
aiLib.seatbelt (isOn, onChange, provider) | nie | Warstwy przez ai-core |
aiLib.radial (add, remove, refresh) | nie | Warstwy przez ai-core |
aiLib.mdt.open() | nie | Warstwy przez ai-core |
aiLib.nearestVehicle(metres, { networked?, notOwn?, filter? }) | nie | Pojazdy i encje |
aiLib.waitForEntity(netId, timeout?) | tak | Pojazdy i encje |
aiLib.raycast(from, to, options?) | nie | Sondy i wczytywanie |
aiLib.groundZ(x, y, z?), aiLib.locationName(coords?), aiLib.vehicleLabel(vehicle), aiLib.waypoint() | nie | Sondy i wczytywanie |
aiLib.pedHeadshot(ped, transparent?, timeout?) | tak | Sondy i wczytywanie |
aiLib.onShot(handler) | nie | Sondy i wczytywanie |
aiLib.requestModel, requestAnimDict, requestAnimSet, requestPtfxAsset, requestTextureDict, requestWeaponAsset (name, timeout?) | tak | Sondy i wczytywanie |
aiLib.ModelPoints i aiLib.targets są wewnętrzne (obsługują Points:addModel i adaptery skryptów targetu); nie wywołuj ich.
Serwer
| Funkcja | Czeka | Opisana na |
|---|---|---|
aiLib.onClientCallback(name, handler, { rate?, lock?, ace? }) | nie | Wejście z klienta |
aiLib.onClientEvent(name, handler, { rate?, ace? }) | nie | Wejście z klienta |
aiLib.triggerClientCallback(name, source, args?, timeout?) | tak | Wejście z klienta |
aiLib.progressFor(source, options) | tak | Wejście z klienta |
aiLib.minigameFor(source, options) | tak | Wejście z klienta |
aiLib.isAdmin(source, ace?) | nie | Funkcje tylko dla Lua |
aiLib.addCommand(name, options, handler) | nie | Komendy |
aiLib.online (character, name, jobs, gangs, jobGrade, gangGrade, dutyJob, sources) | nie | Funkcje tylko dla Lua |
aiLib.onCharacter({ loaded?, unloaded? }) | nie | Gracze i postacie |
aiLib.playersNear(source, radius), aiLib.playersNearEntity(entity, radius), aiLib.nearestPlayerTo(source, metres, filter?) | nie | Gracze i postacie |
aiLib.RateLimit.new(count, windowMs): :take(source), :release(source) | nie | Gracze i postacie |
aiLib.inventory (addItem, removeItem, getItemCount, hasItem, canCarryItem, getItems, clearInventory, registerStash, openInventory, registerUsableItem, getItemDefinition, registerShop, openShop) | nie | Przedmioty |
aiLib.spawnVehicle(options) | tak | Pojazdy |
aiLib.vehicleKeys (give, remove, has) | nie | Pojazdy |
aiLib.vehicleFromNet(netId), aiLib.vehicleNearPlayer(source, netId, options?), aiLib.nearestVehicleTo(source, metres, filter?) | nie | Pojazdy |
aiLib.billing (send, unpaid, pay, provider) | unpaid tak | Pieniądze i bankowość |
aiLib.banking (open, societyBalance, provider) | nie | Pieniądze i bankowość |
aiLib.dispatch.alert(alert) | nie | Prace i służby |
aiLib.prison (jail, release, timeLeft) | nie | Prace i służby |
aiLib.mdt (record, provider) | nie | Prace i służby |
aiLib.ems (available, distress, provider) | nie | Prace i służby |
aiLib.stress (gain, relieve, provider) | nie | Prace i służby |
aiLib.world (getWeather, setWeather, getTime, setTime, setBlackout, freezeTime) | nie | Świat |
aiLib.phone (number, sourceOf, hasPhone, mail, message, notify) | nie | Telefon i wygląd |
aiLib.appearance (get, provider) | get tak | Telefon i wygląd |
aiLib.aiLog(channel, message, options?) | nie | Logi |