Minden API-függvény egy HTTP GET vagy POST kérés. Az általános szintaxis a következő:
http://s{N}.zandagort.hu/{függvénynév}.php{argumentumok}
ahol
| N | a forduló/szerver sorszáma |
|---|---|
| függvénynév | a meghívott függvény neve, ezeket részletesen lásd ebben a dokumentációban |
| argumentumok | változó számú argumentum, a szokásos ?arg1=x1&arg2=x2 formátumban |
POST függvényeknél a bemenetet nem argumentumként, hanem POST-változóként kell átadni.
A függvények kimenete GET kérésnél egy kikommentelt json objektum:
/*{ ... }*/
POST kérésnél, ha sikeres volt az akció, akkor semmi (ez esetben általában frissíteni kell a lekért adatokat, hiszen változott valaminek az állapota) (pl a flotta állomásozás helyett tart valahova), ha valami akadályba ütközött, akkor egy hibaüzenet, amit a felhasználónak meg lehet mutatni (leszámítva, ahol nincs megírva a hibaüzenet).
Ha valahol a leírás helyén - szerepel, az azt jelenti, hogy annak már nincs jelentősége, nincs használatban, csak a visszafelé kompatibilitás miatt maradt bent (network spórolásból van egy csomó számozott tömb, ezeknél nem lehet csak úgy kihagyni néhány közbenső elemet).
Elemi matematikából ismert, hogy "százalék=századrész". :-) Vagyis ha valaminél az szerepel, hogy %-ban, akkor a valódi érték 100-szorosa szerepel ott. 90%-nyi hajó, az 0,9 darab hajó.
Bár előfordulhat, hogy egy POST függvény elfogad GET kéréseket is, egyrészt ez nem garantált, hogy mindig így marad, másrészt a HTTP "etikett" egyik alapja, hogy a GET-et és POST-ot nem szabad keverni. A proxy szerverektől a cache-eken át a szerverlogokig minden máshogy kezeli a GET és a POST kéréseket. Alapszabály: a GET eredményeként nem változik semmi a szerveren (csak információt kérünk le), a POST viszont valamit megváltoztat a szerveren.
| id | név | iparág |
|---|---|---|
| 1 | Naperőmű | 1 |
| 2 | SPS | 1 |
| 4 | Szélfarm | 1 |
| 5 | Vízi erőmű | 1 |
| 6 | Hullámfarm | 1 |
| 7 | Árapályerőmű | 1 |
| 8 | Ozmózis erőmű | 1 |
| 9 | Geotermikus erőmű | 1 |
| 10 | HDR erőmű | 1 |
| 11 | Bioetanol erőmű | 1 |
| 12 | Atomerőmű | 1 |
| 13 | Fúziós reaktor | 1 |
| 14 | Húsüzem | 2 |
| 15 | Vegagyár | 2 |
| 16 | Kenyérgyár | 2 |
| 17 | Szeszfőzde | 2 |
| 18 | Fűrészmalom | 3 |
| 19 | Kőbánya | 3 |
| 20 | Homokbánya | 3 |
| 21 | Titánmű | 3 |
| 22 | Urándúsító | 3 |
| 23 | Üveggyár | 4 |
| 24 | Félvezetőgyár | 4 |
| 25 | Szénégető | 4 |
| 26 | Olajgyár | 4 |
| 27 | Műanyaggyár | 4 |
| 28 | Űrhajógyár | 7 |
| 29 | Falu | 5 |
| 30 | Város | 5 |
| 31 | Kutatóintézet | 6 |
| 32 | Hírszerző központ | 6 |
| 33 | Űrkikötő | 6 |
| 34 | Teleport | 6 |
Ha valamilyen kontextusban különbséget teszünk egy gyár különböző üzemmódjai közt (milyen inputot használ vagy milyen outputot termel), akkor a gyárra és nem gyártípusra hivatkozunk.
| id | gyártípus | üzemmód | gyártípus név | üzemmód név |
|---|---|---|---|---|
| 1 | 1 | 59 | Naperőmű | Energia |
| 2 | 2 | 59 | SPS | Energia |
| 4 | 4 | 59 | Szélfarm | Energia |
| 5 | 5 | 59 | Vízi erőmű | Energia |
| 6 | 6 | 59 | Hullámfarm | Energia |
| 7 | 7 | 59 | Árapályerőmű | Energia |
| 8 | 8 | 59 | Ozmózis erőmű | Energia |
| 9 | 9 | 59 | Geotermikus erőmű | Energia |
| 10 | 10 | 59 | HDR erőmű | Energia |
| 11 | 11 | 6 | Bioetanol erőmű | Cukornád |
| 12 | 11 | 17 | Bioetanol erőmű | Kukorica |
| 13 | 11 | 28 | Bioetanol erőmű | Búza |
| 14 | 11 | 40 | Bioetanol erőmű | Krumpli |
| 15 | 12 | 59 | Atomerőmű | Energia |
| 16 | 13 | 59 | Fúziós reaktor | Energia |
| 17 | 14 | 9 | Húsüzem | Panda |
| 18 | 14 | 20 | Húsüzem | Zebra |
| 19 | 14 | 21 | Húsüzem | Zsiráf |
| 20 | 14 | 32 | Húsüzem | Bárány |
| 21 | 14 | 44 | Húsüzem | Marha |
| 22 | 14 | 45 | Húsüzem | Vaddisznó |
| 23 | 14 | 52 | Húsüzem | Vapiti |
| 24 | 14 | 53 | Húsüzem | Barna medve |
| 25 | 15 | 3 | Vegagyár | Gomba |
| 26 | 15 | 4 | Vegagyár | Rizs |
| 27 | 15 | 5 | Vegagyár | Yam |
| 28 | 15 | 2 | Vegagyár | Banánfa |
| 29 | 15 | 17 | Vegagyár | Kukorica |
| 30 | 15 | 16 | Vegagyár | Füge |
| 31 | 15 | 15 | Vegagyár | Majomkenyérfa |
| 32 | 15 | 29 | Vegagyár | Szőlő |
| 33 | 15 | 26 | Vegagyár | Olajfa |
| 34 | 15 | 40 | Vegagyár | Krumpli |
| 35 | 16 | 28 | Kenyérgyár | Búza |
| 36 | 16 | 41 | Kenyérgyár | Árpa |
| 37 | 16 | 49 | Kenyérgyár | Rozs |
| 38 | 17 | 6 | Szeszfőzde | Cukornád |
| 39 | 17 | 18 | Szeszfőzde | Agavé |
| 40 | 17 | 28 | Szeszfőzde | Búza |
| 41 | 17 | 29 | Szeszfőzde | Szőlő |
| 42 | 17 | 40 | Szeszfőzde | Krumpli |
| 43 | 17 | 41 | Szeszfőzde | Árpa |
| 44 | 17 | 49 | Szeszfőzde | Rozs |
| 45 | 18 | 1 | Fűrészmalom | Ébenfa |
| 46 | 18 | 15 | Fűrészmalom | Majomkenyérfa |
| 47 | 18 | 27 | Fűrészmalom | Cédrus |
| 48 | 18 | 39 | Fűrészmalom | Tölgy |
| 49 | 18 | 48 | Fűrészmalom | Fenyő |
| 50 | 19 | 65 | Kőbánya | Kő |
| 51 | 20 | 66 | Homokbánya | Homok |
| 52 | 21 | 67 | Titánmű | Titán |
| 53 | 22 | 68 | Urándúsító | Dúsított urán |
| 54 | 23 | 72 | Üveggyár | Üveg |
| 55 | 24 | 73 | Félvezetőgyár | Félvezető |
| 56 | 25 | 69 | Szénégető | Szén |
| 57 | 26 | 70 | Olajgyár | Olaj |
| 58 | 27 | 71 | Műanyaggyár | Műanyag |
| 59 | 28 | 201 | Űrhajógyár | Könnyűcirkáló |
| 60 | 28 | 202 | Űrhajógyár | Skorpió |
| 61 | 28 | 203 | Űrhajógyár | Fregatt |
| 62 | 28 | 204 | Űrhajógyár | Interceptor |
| 63 | 28 | 205 | Űrhajógyár | Csatahajó |
| 64 | 28 | 206 | Űrhajógyár | Szonda |
| 65 | 28 | 207 | Űrhajógyár | Cirkáló |
| 66 | 28 | 208 | Űrhajógyár | Vadász |
| 67 | 28 | 209 | Űrhajógyár | Korvett |
| 68 | 28 | 210 | Űrhajógyár | Fulgur |
| 69 | 28 | 211 | Űrhajógyár | Dreadnought |
| 70 | 28 | 212 | Űrhajógyár | Koordinátor |
| 71 | 28 | 213 | Űrhajógyár | Nehézcirkáló |
| 72 | 28 | 214 | Űrhajógyár | Raptor |
| 73 | 28 | 215 | Űrhajógyár | Romboló |
| 74 | 28 | 216 | Űrhajógyár | Anyahajó |
| 75 | 28 | 217 | Űrhajógyár | Nemesis |
| 76 | 28 | 218 | Űrhajógyár | OHS-1 |
| 77 | 29 | 55 | Falu | Lakóhely |
| 78 | 30 | 58 | Város | Képzett munkaerő |
| 79 | 31 | 150 | Kutatóintézet | Kutatási pont |
| 84 | 31 | 60 | Kutatóintézet | Nyers kő |
| 85 | 31 | 61 | Kutatóintézet | Nyers homok |
| 86 | 31 | 62 | Kutatóintézet | Titánérc |
| 87 | 32 | 76 | Hírszerző központ | Kémkapacitás |
| 88 | 33 | 75 | Űrkikötő | Matrózmorál |
| 89 | 34 | 58 | Teleport | Képzett munkaerő |
| 90 | 31 | 63 | Kutatóintézet | Uránérc |
| id | név | mértekegység | szállítható/tőzsdézhető | TT-igény | raktározható/fosztható |
|---|---|---|---|---|---|
| 56 | Élelmiszer | RDA | 1 | 100000 | 1 |
| 59 | Energia | MWh | 0 | 1 | 1 |
| 60 | Nyers kő | t | 0 | 1 | 0 |
| 61 | Nyers homok | t | 0 | 1 | 0 |
| 62 | Titánérc | t | 0 | 1 | 0 |
| 63 | Uránérc | t | 0 | 1 | 0 |
| 64 | Fa | köbméter | 1 | 1000 | 1 |
| 65 | Kő | t | 1 | 1000 | 1 |
| 66 | Homok | t | 1 | 1000 | 1 |
| 67 | Titán | t | 1 | 1000 | 1 |
| 68 | Dúsított urán | kazetta | 1 | 100 | 1 |
| 69 | Szén | t | 1 | 1000 | 1 |
| 70 | Olaj | hordó | 1 | 10000 | 1 |
| 71 | Műanyag | t | 1 | 100 | 1 |
| 72 | Üveg | lap | 1 | 1000 | 1 |
| 73 | Félvezető | egység | 1 | 100 | 1 |
| 74 | Alkohol | hl | 1 | 1000 | 1 |
| id | név | szállítható/tőzsdézhető | TT-igény | raktározható/fosztható |
|---|---|---|---|---|
| 55 | Lakóhely | 0 | 1 | 0 |
| 57 | Munkaerő | 0 | 1 | 0 |
| 58 | Képzett munkaerő | 0 | 1 | 0 |
| 150 | Kutatási pont | 1 | 10 | 1 |
| 75 | Matrózmorál | 0 | 0 | 0 |
| 76 | Kémkapacitás | 0 | 0 | 0 |
| 77 | Képzett munkahely | 0 | 0 | 0 |
| 78 | Teleportkapacitás | 0 | 0 | 0 |
| id | név |
|---|---|
| 201 | Könnyűcirkáló |
| 202 | Skorpió |
| 203 | Fregatt |
| 204 | Interceptor |
| 205 | Csatahajó |
| 206 | Szonda |
| 207 | Cirkáló |
| 208 | Vadász |
| 209 | Korvett |
| 210 | Fulgur |
| 211 | Dreadnought |
| 212 | Koordinátor |
| 213 | Nehézcirkáló |
| 214 | Raptor |
| 215 | Romboló |
| 216 | Anyahajó |
| 217 | Nemesis |
| 218 | OHS-1 |
| 219 | Behemót |
| 220 | Zeusz |
| 221 | Szúnyog |
| 222 | Akna |
| 223 | Castor |
| 224 | Pollux |
| id | név | trofikus szint | bolygó osztály | mértekegység |
|---|---|---|---|---|
| 1 | Ébenfa | 1 | 1 | ha |
| 2 | Banánfa | 1 | 1 | ha |
| 3 | Gomba | 1 | 29 | ha |
| 4 | Rizs | 1 | 1 | ha |
| 5 | Yam | 1 | 1 | ha |
| 6 | Cukornád | 1 | 1 | ha |
| 7 | Sáska | 2 | 3 | |
| 8 | Tapír | 2 | 1 | |
| 9 | Panda | 2 | 1 | |
| 10 | Gibbon | 2 | 1 | |
| 11 | Koboldmaki | 3 | 1 | |
| 12 | Tigris | 3 | 1 | |
| 13 | Fű | 1 | 2 | ha |
| 14 | Kaktusz | 1 | 2 | ha |
| 15 | Majomkenyérfa | 1 | 2 | ha |
| 16 | Füge | 1 | 2 | ha |
| 17 | Kukorica | 1 | 2 | ha |
| 18 | Agavé | 1 | 2 | ha |
| 19 | Ugróegér | 2 | 2 | |
| 20 | Zebra | 2 | 2 | |
| 21 | Zsiráf | 2 | 2 | |
| 22 | Pávián | 2 | 2 | |
| 23 | Prérifarkas | 3 | 2 | |
| 24 | Leopárd | 3 | 2 | |
| 25 | Macchia | 1 | 4 | ha |
| 26 | Olajfa | 1 | 4 | ha |
| 27 | Cédrus | 1 | 4 | ha |
| 28 | Búza | 1 | 4 | ha |
| 29 | Szőlő | 1 | 4 | ha |
| 30 | Gyík | 2 | 4 | |
| 31 | Nyúl | 2 | 4 | |
| 32 | Bárány | 2 | 4 | |
| 33 | Mókus | 2 | 28 | |
| 34 | Sün | 2 | 4 | |
| 35 | Farkas | 3 | 28 | |
| 36 | Borz | 3 | 12 | |
| 37 | Hanga | 1 | 8 | ha |
| 38 | Lucerna | 1 | 8 | ha |
| 39 | Tölgy | 1 | 8 | ha |
| 40 | Krumpli | 1 | 8 | ha |
| 41 | Árpa | 1 | 8 | ha |
| 42 | Egér | 2 | 8 | |
| 43 | Fürj | 2 | 8 | |
| 44 | Marha | 2 | 8 | |
| 45 | Vaddisznó | 2 | 8 | |
| 46 | Moha | 1 | 16 | ha |
| 47 | Zuzmó | 1 | 16 | ha |
| 48 | Fenyő | 1 | 16 | ha |
| 49 | Rozs | 1 | 16 | ha |
| 50 | Lemming | 2 | 16 | |
| 51 | Havasi nyúl | 2 | 16 | |
| 52 | Vapiti | 2 | 16 | |
| 53 | Barna medve | 2 | 16 | |
| 54 | Rozsomák | 3 | 16 |
A "bolygó osztály" kódolása: A+2B+4C+8D+16E, ahol A,B,C,D,E=1, ha az adott osztályú bolygón van ilyen faj, 0, ha nincs.
...
...
| id | név |
|---|---|
| 2 | meghív |
| 3 | kirúg |
| 4 | kinevez |
| 5 | közös flotta |
| 7 | diplo |
| 6 | vendég |
| 8 | újtéma |
| 9 | mod |
| 1 | belső fórum |
| 10 | radar |
| 11 | nagy radar |
| 12 | kém |
bolygo_adatok
| id | bolygó id-ja |
|---|
| letezik | ha nem létezik a bolygó, akkor 0 (ez esetben más adat nincs is), egyébként 1 |
|---|---|
| id | a bolygó id-ja |
| te | a te id-d |
| tied | tied-e a bolygó |
| nev | a bolygó neve |
| esc_nev | a bolygó neve kicsit mashogy escape-elve |
| tulaj | tulajdonos neve |
| tulaj_id | tulajdonos id-ja |
| tulaj_szov | |
| vegjatek | |
| iparag_jelzok | |
| gyar_ikonok | |
| befagy_utemezett_szallitas | |
| befagy_utemezett_tozsde | |
| premium | |
| x | |
| y | |
| hexa_x | |
| hexa_y | |
| bolygokepmeret | |
| regio | |
| osztaly | |
| terulet | |
| terulet_foglalt | |
| terulet_foglalt_effektiv | |
| kornyezeti_fejlettseg | |
| hold | |
| alapbol_regisztralhato | |
| random_regisztralhato | |
| vedelmi_bonusz | |
| foszthato | |
| moratorium | |
| szabot | |
| koltozheto |
Ha saját bolygóról van szó, akkor még az alábbiak is:
| kezelo | |
|---|---|
| kezelo_id | |
| eroforrasok | tömbök tömbje, részletesen lásd lentebb |
| auto_transz | [] |
| auto_transz_in | [] |
| flottak | [] |
| teljesflottaertek | |
| teljesflottaertek_szondanelkul | |
| hajok | tömbök tömbje, részletesen lásd lentebb |
| gyarak | tömbök tömbje, részletesen lásd lentebb |
| fajok | tömbök tömbje, részletesen lásd lentebb |
| bio_kitermeles | tömbök tömbje, részletesen lásd lentebb |
| term_mikor | |
| moral | |
| lakohely | |
| lakohelytermeles | |
| kaja | |
| kajatermeles | |
| pop | |
| cel_pop | |
| munkaero | |
| munkaeroigeny | |
| kepzettmunkaero | |
| kepzettmunkaeroigeny | |
| teleporttoltes | |
| teleportkapacitas | |
| kocsmaszam | |
| techszint | |
| magan_bolygok_szama | |
| bolygok | tömbök tömbje, részletesen lásd lentebb |
| kovetkezo | |
| elozo |
Ha idegen bolygó, akkor pedig:
| kemriportok |
|---|
eroforrasok:
| 0 | id |
|---|---|
| 1 | készlet |
| 2 | nettó termelés |
| 3 | a bruttó fogyasztás és a készlet hányadosa*100 (100 fölött nincs elég készlet a termeléshez) |
| 4 | - |
| 5 | bruttó fogyasztás |
| 6 | bruttó termelés |
| 7 | - |
| 8 | szállítható/tőzsdézhető-e |
| 9 | hány kör alatt fogy ki a készlet (ha nincs prémium, akkor -2) |
| 10 | - |
| 11 | ütemezett szállítás: a bejövő pozitív, a kimenő negatív |
| 12 | - |
| 13 | minihelp, ha csökken az erőforrás mennyisége |
hajok:
| 0 | id |
|---|---|
| 1 | felkerekített darabszám |
| 2 | darabszám %-ban |
| 3 | egyenérték %-ban |
gyarak:
| 0 | id |
|---|---|
| 1 | gyártípus |
| 2 | név |
| 3 | darabszám |
| 4 | aktív darabszám |
| 5 | iparág neve |
| 6 | üzemmód id |
| 7 | üzemmódok száma ezen a bolygóosztályon (vagyis fel kell-e kínálni az üzemmódváltás lehetőségét az adott gyárnál) |
| 8 | üzemben lévő darabszám %-ban |
| 9 | - |
| 10 | prémium vagy-e |
fajok:
| 0 | id |
|---|---|
| 1 | létszám |
| 2 | trofikus szint |
| 3 | létszám szűz bolygón (az ehhez képesti % a lényeg) |
bio_kitermeles (az ökoszimulátornak összegyűjtve, hogy a biológiai inputot használó gyárakból mennyi van):
| 0 | gyártípus |
|---|---|
| 1 | üzemmód (erőforrás) |
| 2 | gyár |
| 3 | gyár aktív darabszáma |
bolygok (ahova lehet szállítani, vagyis a saját bolygóid):
| 0 | id |
|---|---|
| 1 | név |
| 2 | osztály |
| 3 | - |
gyar_epit_tobb (POST)
Gyár építése.
| bolygo_id | bolygó azonosítója |
|---|---|
| gyar_id | gyár (nem gyártípus!) azonosítója |
| db | hány darab épüljön |
| a | aktív (1) vagy inaktív (0) |