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.getPostać gracza |
serwer | — | { id, name, job { name, label, grade, gradeLabel, onDuty }, gang { … }, money { konto: kwota } } albo nil przed wyborem postaci |
player.jobPraca gracza (u niego w grze) |
klient | — | nazwa pracy |
player.setJobUstaw pracę |
serwer | job Praca (job)grade Stopień (number) |
— |
player.setDutyNa służbie / poza służbą |
serwer | onDuty Na służbie (boolean) |
— |
player.setGangUstaw gang |
serwer | gang Gang (gang)grade Stopień (number) |
— |
character.listPostacie gracza |
serwer | — | [{ id, name }] postaci na licencji gracza |
character.loginZaloguj na postać |
serwer | id Postać (id z character.list) (string) |
true po wczytaniu postaci (sam serwer albo kliknięcie na ekranie wyboru postaci) |
character.createZałóż postać i wejdź na nią |
serwer | data { firstname, lastname, birthdate, gender } (json) |
id nowej postaci |
character.prepareDopisz postacie do konta, zanim wybór postaci je odczyta |
serwer | characters [{ firstname, lastname, birthdate, gender }] (json) |
liczba dopisanych postaci |
character.selectOpenEkran wyboru postaci jest otwarty |
klient | — | true, gdy gracz widzi wybór postaci |
character.spawnWejście do gry po wczytaniu postaci przez serwer (zamyka wybór postaci) |
klient | — | — |
character.prepareSpawnPrzygotuj 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.addMoneyDodaj pieniądze |
serwer | account Konto (account)amount Kwota (number)reason? Powód (string) |
— |
player.removeMoneyZabierz pieniądze |
serwer | account Konto (account)amount Kwota (number)reason? Powód (string) |
true, gdy było tyle na koncie |
player.setMoneyUstaw stan konta |
serwer | account Konto (account)amount Kwota (number) |
— |
bank.openBank |
klient | — | — |
Katalog
| Zdolność | Strona | Argumenty | Zwraca |
|---|---|---|---|
catalog.jobsPrace |
serwer | — | [{ name, label, grades: [{ grade, label }] }] |
catalog.gangsGangi |
serwer | — | [{ name, label, grades }] |
catalog.accountsKonta pieniędzy |
serwer | — | [“cash”, “bank”, …] |
catalog.itemsPrzedmioty |
serwer | — | [{ name, label, weight?, kind? (item|weapon|ammo|component), studio?, imageDir? }] |
Ekwipunek
| Zdolność | Strona | Argumenty | Zwraca |
|---|---|---|---|
inventory.listEkwipunek gracza |
serwer | — | [{ name, count }] |
inventory.addDaj przedmiot |
serwer | item Przedmiot (item)count Liczba (number)metadata? Dane przedmiotu (json) |
— |
inventory.removeZabierz przedmiot |
serwer | item Przedmiot (item)count Liczba (number) |
true, gdy gracz go miał |
inventory.countIle ma przedmiotu |
serwer | item Przedmiot (item) |
liczba |
inventory.clearWyczyść ekwipunek |
serwer | — | — |
inventory.defineItemNowy 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.itemInfoDane przedmiotu (do edycji) |
serwer | name Przedmiot (item) |
{ name, label, weight, description, stack, image, usable, studio } |
inventory.removeItemUsuń przedmiot (plik paczki ekwipunku) |
serwer | name Przedmiot (item) |
{ file, content }: nowa treść pliku tej paczki |
inventory.registerStashZałóż 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.openStashOtwórz schowek |
klient | id Nazwa schowka (string) |
— |
inventory.openTrunkOtwórz bagażnik pojazdu |
klient | netId Pojazd (network id) (number) |
— |
inventory.addToTrunkWłóż 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.registerZałóż sklep |
serwer | id Nazwa sklepu (string)label Podpis (string)items Towary [{ name, price }] (json)job? Tylko dla pracy (job) |
— |
shop.openOtwórz sklep |
klient | id Nazwa sklepu (string) |
— |
Pojazdy
| Zdolność | Strona | Argumenty | Zwraca |
|---|---|---|---|
vehicle.giveKeysDaj kluczyki |
serwer | netId Pojazd (network id) (number) |
— |
vehicle.hasKeysMa kluczyki |
serwer | netId Pojazd (network id) (number) |
— |
vehicle.setFuelUstaw paliwo |
serwer | netId Pojazd (network id) (number)level Paliwo (0–100) (number) |
— |
garage.registerZałóż 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.notifyPowiadomienie |
klient | text Tekst (string)type? Rodzaj (inform, success, error) (string) |
— |
ui.textShowPokaż podpowiedź (np. [E] Otwórz) |
klient | text Tekst (string) |
— |
ui.textHideSchowaj podpowiedź |
klient | — | — |
ui.progressPasek postępu |
klient | label Tekst (string)duration Czas (ms) (number)canCancel? Można przerwać (boolean) |
true, gdy dobiegł końca |
ui.confirmPotwierdzenie |
klient | title Tytuł (string)text Tekst (string) |
true przy potwierdzeniu |
ui.inputOkno z polem |
klient | title Tytuł (string)fields Pola [{ label, type }] (json) |
wartości pól albo nil |
ui.menuMenu wyboru |
klient | title Tytuł (string)options Opcje [{ label, value }] (json) |
value wybranej opcji albo nil |
ui.skillCheckTest zręczności |
klient | difficulty? Trudność (easy, medium, hard) (string) |
true przy sukcesie |
Celowanie
| Zdolność | Strona | Argumenty | Zwraca |
|---|---|---|---|
target.addEntityOpcja na obiekcie |
klient | netId Obiekt (network id) (number)options Opcje (json) |
— |
target.addModelOpcja na modelu (cały świat) |
klient | models Modele (json)options Opcje (json) |
— |
target.addGlobalOpcja 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.addSphereOpcja w miejscu |
klient | coords Miejsce (coords)radius Promień (number)options Opcje (json) |
id strefy |
target.listOptionsOpcje celowania na obiekcie |
klient | entity Obiekt (handle) (number) |
[{ label, icon }] opcji, które gracz zobaczy na tym obiekcie |
target.removeUsuń opcje |
klient | handle Co zwróciło dodanie (json) |
— |
Praca
| Zdolność | Strona | Argumenty | Zwraca |
|---|---|---|---|
job.openBossMenuMenu szefa |
klient | kind? job albo gang (string) |
— |
Wygląd
| Zdolność | Strona | Argumenty | Zwraca |
|---|---|---|---|
appearance.openClothingSklep z ubraniami |
klient | — | — |
appearance.openBarberFryzjer |
klient | — | — |
appearance.saveZapisz obecny wygląd postaci |
klient | — | nazwa skryptu, który zapisał wygląd |
appearance.addTattooDodaj 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.secondPlayerDrugi gracz z tą samą licencją (serwer deweloperski) |
serwer | — | true, gdy Gracz 2 z tej samej licencji Rockstar wejdzie na serwer studia |
server.saveAllZapisz dane przed restartem (gracze, ekwipunki, pojazdy) |
serwer | — | — |
db.queryZapytanie do bazy |
serwer | sql SQL (string)params? Parametry (json) |
wiersze albo wynik zapytania |
Świat
| Zdolność | Strona | Argumenty | Zwraca |
|---|---|---|---|
world.setPora 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.