Dokumentacja techniczna

Zdolności i kontrakt adapterów

Każda zdolność: strona, argumenty i to, co zwraca.

Zdolność to jedna rzecz, o którą studio i mechaniki projektu proszą serwer, bez nazwy frameworka ani resource’u: „daj przedmiot”, „pokaż powiadomienie”. Robi ją adapter resource’u, który ją umie (rozdział Co umie projekt, własny adapter: Własny adapter).

Obecna wersja kontraktu: 2. Adaptery napisane dla wcześniejszej wersji działają dalej.

Jak adapter robi zdolność

Adapter to folder adapters/<id>/ z plikami adapter.json, server.lua i client.lua (format adapter.json jest na stronie Pliki projektu). Lista server i client w adapter.json mówi, które zdolności daje. Kod rejestruje je wywołaniem StudioAdapter(id, { ['<zdolność>'] = function(...) end }).

Zdolność działa po jednej stronie. Funkcja po stronie serwera dostaje najpierw id gracza (src), potem argumenty z tabeli niżej, w tej kolejności. Po stronie klienta same argumenty.

Gracz

Zdolność Strona Argumenty Zwraca
player.get
Postać gracza
serwer — { id, name, job { name, label, grade, gradeLabel, onDuty }, gang { … }, money { konto: kwota } } albo nil przed wyborem postaci
player.job
Praca gracza (u niego w grze)
klient — nazwa pracy
player.setJob
Ustaw pracę
serwer job Praca (job)
grade Stopień (number)
—
player.setDuty
Na służbie / poza służbą
serwer onDuty Na służbie (boolean) —
player.setGang
Ustaw gang
serwer gang Gang (gang)
grade Stopień (number)
—
character.list
Postacie gracza
serwer — [{ id, name }] postaci na licencji gracza
character.login
Zaloguj na postać
serwer id Postać (id z character.list) (string) true po wczytaniu postaci (sam serwer albo kliknięcie na ekranie wyboru postaci)
character.create
Załóż postać i wejdź na nią
serwer data { firstname, lastname, birthdate, gender } (json) id nowej postaci
character.prepare
Dopisz postacie do konta, zanim wybór postaci je odczyta
serwer characters [{ firstname, lastname, birthdate, gender }] (json) liczba dopisanych postaci
character.selectOpen
Ekran wyboru postaci jest otwarty
klient — true, gdy gracz widzi wybór postaci
character.spawn
Wejście do gry po wczytaniu postaci przez serwer (zamyka wybór postaci)
klient — —
character.prepareSpawn
Przygotuj postać do wejścia bez ekranów startowych (np. wyboru apartamentu)
serwer — co przygotował (np. nazwa apartamentu) albo false, gdy nic nie trzeba

Pieniądze

Zdolność Strona Argumenty Zwraca
player.addMoney
Dodaj pieniądze
serwer account Konto (account)
amount Kwota (number)
reason? Powód (string)
—
player.removeMoney
Zabierz pieniądze
serwer account Konto (account)
amount Kwota (number)
reason? Powód (string)
true, gdy było tyle na koncie
player.setMoney
Ustaw stan konta
serwer account Konto (account)
amount Kwota (number)
—
bank.open
Bank
klient — —

Katalog

Zdolność Strona Argumenty Zwraca
catalog.jobs
Prace
serwer — [{ name, label, grades: [{ grade, label }] }]
catalog.gangs
Gangi
serwer — [{ name, label, grades }]
catalog.accounts
Konta pieniędzy
serwer — [“cash”, “bank”, …]
catalog.items
Przedmioty
serwer — [{ name, label, weight?, kind? (item|weapon|ammo|component), studio?, imageDir? }]

Ekwipunek

Zdolność Strona Argumenty Zwraca
inventory.list
Ekwipunek gracza
serwer — [{ name, count }]
inventory.add
Daj przedmiot
serwer item Przedmiot (item)
count Liczba (number)
metadata? Dane przedmiotu (json)
—
inventory.remove
Zabierz przedmiot
serwer item Przedmiot (item)
count Liczba (number)
true, gdy gracz go miał
inventory.count
Ile ma przedmiotu
serwer item Przedmiot (item) liczba
inventory.clear
Wyczyść ekwipunek
serwer — —
inventory.defineItem
Nowy przedmiot (plik paczki ekwipunku)
serwer def { name, label, weight, description, stack, image, usable } (json) { file, content }: nowa treść pliku tej paczki; studio go zapisuje i restartuje paczkę
inventory.itemInfo
Dane przedmiotu (do edycji)
serwer name Przedmiot (item) { name, label, weight, description, stack, image, usable, studio }
inventory.removeItem
Usuń przedmiot (plik paczki ekwipunku)
serwer name Przedmiot (item) { file, content }: nowa treść pliku tej paczki
inventory.registerStash
Załóż schowek
serwer id Nazwa schowka (string)
label Podpis (string)
slots Miejsca w schowku (number)
weight Udźwig (g) (number)
personal? Osobny dla każdego gracza (boolean)
job? Tylko dla pracy (job)
—
inventory.openStash
Otwórz schowek
klient id Nazwa schowka (string) —
inventory.openTrunk
Otwórz bagażnik pojazdu
klient netId Pojazd (network id) (number) —
inventory.addToTrunk
Włóż do bagażnika
serwer plate Rejestracja (string)
item Przedmiot (item)
count Liczba (number)
true, gdy się zmieściło

Handel

Zdolność Strona Argumenty Zwraca
shop.register
Załóż sklep
serwer id Nazwa sklepu (string)
label Podpis (string)
items Towary [{ name, price }] (json)
job? Tylko dla pracy (job)
—
shop.open
Otwórz sklep
klient id Nazwa sklepu (string) —

Pojazdy

Zdolność Strona Argumenty Zwraca
vehicle.giveKeys
Daj kluczyki
serwer netId Pojazd (network id) (number) —
vehicle.hasKeys
Ma kluczyki
serwer netId Pojazd (network id) (number) —
vehicle.setFuel
Ustaw paliwo
serwer netId Pojazd (network id) (number)
level Paliwo (0–100) (number)
—
garage.register
Załóż garaż
serwer id Nazwa garażu (string)
label Podpis (string)
coords Wjazd (coords)
spawn Miejsce wyjazdu (coords)
job? Tylko dla pracy (job)
—

Interfejs

Zdolność Strona Argumenty Zwraca
ui.notify
Powiadomienie
klient text Tekst (string)
type? Rodzaj (inform, success, error) (string)
—
ui.textShow
Pokaż podpowiedź (np. [E] Otwórz)
klient text Tekst (string) —
ui.textHide
Schowaj podpowiedź
klient — —
ui.progress
Pasek postępu
klient label Tekst (string)
duration Czas (ms) (number)
canCancel? Można przerwać (boolean)
true, gdy dobiegł końca
ui.confirm
Potwierdzenie
klient title Tytuł (string)
text Tekst (string)
true przy potwierdzeniu
ui.input
Okno z polem
klient title Tytuł (string)
fields Pola [{ label, type }] (json)
wartości pól albo nil
ui.menu
Menu wyboru
klient title Tytuł (string)
options Opcje [{ label, value }] (json)
value wybranej opcji albo nil
ui.skillCheck
Test zręczności
klient difficulty? Trudność (easy, medium, hard) (string) true przy sukcesie

Celowanie

Zdolność Strona Argumenty Zwraca
target.addEntity
Opcja na obiekcie
klient netId Obiekt (network id) (number)
options Opcje (json)
—
target.addModel
Opcja na modelu (cały świat)
klient models Modele (json)
options Opcje (json)
—
target.addGlobal
Opcja na każdym pojeździe, pedzie, graczu albo obiekcie
klient kind vehicle, ped, player, object (string)
options Opcje (z bones dla części pojazdu) (json)
—
target.addSphere
Opcja w miejscu
klient coords Miejsce (coords)
radius Promień (number)
options Opcje (json)
id strefy
target.listOptions
Opcje celowania na obiekcie
klient entity Obiekt (handle) (number) [{ label, icon }] opcji, które gracz zobaczy na tym obiekcie
target.remove
Usuń opcje
klient handle Co zwróciło dodanie (json) —

Praca

Zdolność Strona Argumenty Zwraca
job.openBossMenu
Menu szefa
klient kind? job albo gang (string) —

Wygląd

Zdolność Strona Argumenty Zwraca
appearance.openClothing
Sklep z ubraniami
klient — —
appearance.openBarber
Fryzjer
klient — —
appearance.save
Zapisz obecny wygląd postaci
klient — nazwa skryptu, który zapisał wygląd
appearance.addTattoo
Dodaj tatuaż do wyglądu i zapisz
klient tattoo Tatuaż: name, label, hashMale, hashFemale, zone, collection (json) nazwa skryptu, który zapisał wygląd

Serwer

Zdolność Strona Argumenty Zwraca
session.secondPlayer
Drugi gracz z tą samą licencją (serwer deweloperski)
serwer — true, gdy Gracz 2 z tej samej licencji Rockstar wejdzie na serwer studia
server.saveAll
Zapisz dane przed restartem (gracze, ekwipunki, pojazdy)
serwer — —
db.query
Zapytanie do bazy
serwer sql SQL (string)
params? Parametry (json)
wiersze albo wynik zapytania

Świat

Zdolność Strona Argumenty Zwraca
world.set
Pora i pogoda dla wszystkich
serwer hour Godzina (number)
minute Minuta (number)
weather Pogoda (string)
frozen? Zatrzymany czas (boolean)
—

Pytanie, na które tu nie ma odpowiedzi? Zadaj je na Discordzie.

Webexe Studio

Kliknij, żeby zobaczyć w 100%.