Manuál k Advoru - vývojovému nástroji pro tvorbu adventur

Toto je manuál k Advoru 1.0. Není ještě zcela hotový, ale základní věci tu jsou. K pochopení je také možno použít tutoriály na hlavní straně Advoru.

Sprite
Sprite je soubor jednoho nebo více obrázků, které se mohou střídat v daném intervalu a vytvářet animaci. Sprity obsahují objekty, ale také místnosti. Interval si určuje každý objekt zvláš?. Sprity jsou editovány ve Sprite editoru.

Sprite může být průhledný (transparent). Průhlednost znamená, že se zvolená barva (Průhledná barva, Transparent color) v obrázku nevykresluje.

Instance
Instance je vlastne klon vytvoreny podle predlohy (objektu). Kazda mistnost v Advoru muze obsahovat az 30 instanci. Instanci se pri vytvoreni nastavi stejne parametry, jako ma objekt, ale ty se daji za behu hry nezavisle na ostatnich instancich menit. Pr. : udelam si objekt ker, na kterem se pri vytvoreni (on create event) vytvori 3 plody. Do mistnsti park potom umistim tento objekt 3x. Po spusteni hry budou v parku 3 kere a kazdy se tremi plody. Kdyz seberu plody z jednoho kere, na ostatnich 2 zustanou porad 3.

Objekty

Objekty jsou mysleny vsechny aktivni veci vlozene v mistnosti. Advor rozlisuje 3 zakladni typy objektu :

Objekt
Objekt chapeme jako vec, se kterou se neco deje, ale nelze sebrat. Kazdy objekt v sobe muze obsahovat libovolne mnozstvi spritu. V tomto se Advor lisi napr. oproti GameMakeru, kde jsou sprity vsechhy pohromade a je v tom bordel. V Advoru si napr. u objektu vaza vytvorim sprite vazy v celku, rozbite vazy a nepletou se mi tam nejake skrinky, dvere, cedule a spousty dalsich spritu.
Na objekty lze pouzit subjekty (predmety), jeji povrch muze byt definovany bud spritem nebo maskou.

Maska se pouziva napr. ve chvili, kdyz mame na pozadi na zdi obraz, po kterem chceme jen to, aby hrdina pri kliknuti na nej prohlasil : "Hezky, ale domu bych si to nedal." Nic jineho se s obrazem dit nebudE, nebude se animovat, pohybovat a bude vypadat porad stejne, tudiz je zbytecne pouzivat sprite. Vytvorime si tedy objekt obraz. Ale misto toho, aby jsme z pozadi vystrihli jeho obrazek a nastavili ho objektu jako sprite, tak nam jako sprite postaci jen cernobily obdelnicek velikosti obrazu, kde bila barva znamena ktere casti spritu patri k objektu a ktere jsou jen pozadi (cerne).
Subject (Předmět)
Jako subjekty jsou v advoru chapany vsechny objekty, ktere lze z mistnosti sebrat, vlozit a prehazovat v inventari nebo je v nem kombinovat. Subjekty lze i pouzivat na objekty, slouzi k tomu akce on use with. Maji tri sprity : sprite, inventory sprite a drop sprite.
Character (Postava)

Events (Události)

Event je udalost, na kterou muze objekt reagovat akcemi. Kazda udalost umoznuje objektu vykonat az 10 akci. Kazdy typ objektu muze reagovat az na 10 udalosti nasledujicich typu :

On click (Při kliknutí)
parametry : žádné
Všechny akce v této události se provedou po kliknutí na daný objekt.

On use with (Při použití předmětu)
parametry :

předmět

Všechny akce v této události se provedou, pokud je na objekt použit příslušný předmět.
Př. : Mám objekt váza a předmět kladivo. Chci, aby se váza po užití kladiva rozbila. V objektu váza si vytvořím událost On use with a jako parametr zvolím kladivo. Nyní do události přidám akce jako změna obrázku na střepy, přehrání zvuku tříštícího skla a nakonec tuto událost vymaži pomocí akce Delete event, protože rozbitá váza nesmí jít rozbít znovu.

On transmute (Při spojení s předmětem)
parametry :

předmět - předmět, se kterým se náš objekt spojí
předmět - předmět, který vznikne po spojení

Akce v této události se provedou ve chvíli, když vinventáři spojíme objekt typu předmět s dalším předmětem v inventáři. Událost může být prázdná, používá se hlavně pro definování, s čím se má předmět spojit a co potom v inventáři vznikne. Při spojení se přehraje Transmute sound, který je definovaný v Prefs.
Pozn.: V Advoru v. 1.0 se akce této události neprovedou, slouží jen pro definování spojení.

On mouse enter (Když myš vstoupí na objekt)
parametry: žádné
Akce v této události se provedou jednou, a to ve chvíli, když na objekt najede kurzor myši. Vhodné pro využití např. do tlačítek v menu, která se rozsvítí, když na ně najedeme myší.

On mouse leave (Když myš opustí objekt)
parametry: žádné
Akce v této události se provedou jednou, a to ve chvíli, když je na objektu kurzor myši, který objekt v zápětí opustí. Vhodné pro využití např. do tlačítek v menu, která se rozsvítí, když na ně najedeme myší a poté zhasnou, když z nich myš sjede.

On timer (Při hodinách)
parametry: interval [ms]
Provede obsažené akce každých X milisekund. Počet milisekund určuje parametr interval.

On room enter
parametry: žádné
Provede se ve chvíli, když dojde ke změně místnosti (při vstupu do nové místnosti).

On key down (Při stisknutí klávesy)
parametry: klávesa
Provede se jen jednou a to ve chvíli, když stiskneme zvolenou klávesu. Může se znovu provést až poté, co drženou klávesu pustíme a stiskneme znovu.

Custom event 1-3 (Vlastní událost 1-3)
parametry: žádné
Tuto událost nic nevyvolává. Můžete ji používat na stejný kód, který budete volat vícekrát. Čili naplníte ji akce a potom kdykoli budete chtít tyto akce vyvolat, použijete akci Call event. Také ji můžete naplnit akcemi, které se už nevešly do jiné události a zavolat totožnou akcí.

Akce

Start new game (Nová hra) - Začne úplně novou hru, což znamená, že se obnoví výchozí nastavení hry (použijeme, když máme rozehranou hru a chceme hrát znovu odzačátku).
parametry : žádné

Save current game (Uložit hru) - Uloží hru do daného slotu.
parametry:

index slotu - číslo od nuly, které označuje, do kterého slotu se má hra uložit
šířka náhledu - šířka obrázku, který se uloží spolu s hrou a může být použit jako náhled uložené hry do menu
výška náhledu - výška tohoto obrázku

Restore saved game (Načíst hru) - Načte hru z daného slotu.
parametry:

index slotu - číslo slotu, kde je hra uložena

Exit game (Ukončit hru) - Ukončí hru (zavře program).
parametry: žádné

Set language (Nastavit jazyk) - Nastaví jazyk
parametry:

language index - index jazyka (základní je 0, další jsou jazyky definované v Editoru jazyků)

Sleep (Spát) - Čeká zvolený počet milisekund
parametry:

interval [ms] - určuje, za kolik milisekund se mohou začít provádět další akce

Play sound (Přehraj zvuk) - Přehraje zvuk
parametry :

resource object - jméno objektu, který zvuk obsahuje
sound - jméno zvuku

Fade screen out (Ztmavit obrazovku) -
parametry :

Fade screen in (Rozsvítit obrazovku) - Používá se po akci Fade screen out. Pomalu "rozsvítí" obrazovku z černé.
parametry : žádné

Save last game screen -
parametry :

Set slot sprite -
parametry :

Back to game -
parametry :

Freez game -
parametry :

Unfreez game -
parametry :

Set HP -
parametry :

If HP has a value -
parametry :

If game in progress -
parametry :

Clear in progress game -
parametry :

Change depth -
parametry :

Stop character (zastav postavu) -
parametry :

Add object - prida novou instanci objektu do dane mistnosti
parametry :

object - jmeno objektu
room - jmeno mistnosti
x,y - souradnice instance

Delete object - vymaze vsechny instance od daneho objektu v mistnosti
parametry :

object - jmeno objektu
room - jmeno mistnosti

Change object - vymaze vsechny instance od daneho objektu v mistnosti a na jejich mistech vytvori nove instance jineho objektu.
parametry :

object - jmeno objektu
room - jmeno mistnosti
destination object - jmeno objektu, jehoz instance se maji vytvorit

Set instance as inactive

Change sprite - Zmeni sprite vsech instanci daneho objektu v mistnosti.
parametry :

object - jmeno objektu
resource object - jmeno objektu, ktery obsahuje potrebny sprite
room - jmeno mistnosti
sprite - jmeno spritu

Play animation on instance
parametry :

Change position - presune vsechny instance objektu v mistnosti na dane souradnice.
parametry :

object - jmeno objektu
room - jmeno mistnosti
x,y - souradnice instance
relative - pocatecni bod souradnic [0,0] je v levem hornim rohu mistnosti nebo lezi na souradnicich instance, ktere akce nalezi

Walk to - Posle dany charakter na urcene misto

Remove holding subject -

Change cursor -

Set character sprite -

Call event -

Delete event - vymaze danou udalost instance v mistnosti. Vhodne napr. kdyz rozbijeme vazu kladivem, tak potom udalost pouziti kladiva vymazeme, aby nesla rozbit vicekrat.
parametry :