Funkce a příkazy skriptu

Postupně překládaný popis skriptovacích příkazu eAtheny z eathena\doc\script_commands.txt.
Zatím jsem skončil u hideoffnpc, a ne u všech je přeložený popis.
Tak kdyby měl někdo chuť tak pomožte :-)

Seznam všech dostupných funkcí a příkazů pro skriptování npc přeložený z dokumentace k eAtheně. Rozdíl mezi funkcí a příkazem je v tom, že příkaz pouze mění stav systému, ale nezanechává návratovou hodnotu, kdežto funkce ano. Návratová hodnota může být použita např. v podmínce nebo jako argument jiného příkazu. Při skriptování je třeba rozlišit kdy použít funkci a kdy příkaz. Volání příkazu místo funkce může někdy fungovat, ale není to doporučeno, protože to může vést k těžko zjistitelným chybám. Volání funkce místo příkazu zaneřádí zásobník, takže příkaz 'return' pak v tomto skriptu nebude fungovat správně. Všechny příkazy musí končit středníkem (;). Lze tedy použít i několik příkazů na řádce, pokud je správně ukončíte středníkem. Tento způsob však není doporučen, zejména kvůli přehlednosti skriptu. V textu %TAB% označuje obyčejný tabelátor.

A:A B:B C:C D:D E:E F:F G:G H:H I:I J:J K:K L:L M:M N:N O:O P:P Q:Q R:R S:S T:T U:U V:V W:W X:X Y:Y Z:Z

• addtoskill <id skillu>,<level>{,<flag>};

• announce “<text>“,<flag>{,<barva>};

• areaannounce “<jméno mapy>“,<x1>,<y1>,<x2>,<y2>,“<text>“,<flag>[,<barva>];

• areamonster “<jméno mapy>“,<x1>,<y1>,<x2>,<y2>,“<jméno mobu>“,<počet>{,“<event label>“};

• areawarp “<jméno počáteční mapy>“,<x1>,<y1>,<x2>,<y2>,“<jméno cílové mapy>“,<x3>,<y3>;

• basicskillcheck();

• bonus <typ bonusu>,<číslo>;
• bonus2 <typ bonusu>,<číslo>;
• bonus3 <typ bonusu>,<číslo>;
• bonus4 <typ bonusu>,<číslo>;

• callfunc “<funkce>“{,<argument>,…<argument>};
• callfunc(“<funkce>“{,<argument>,…<argument>}); - Příkaz vyvolává funkci. Funkce může být volána z jakéhokoliv skriptu na map serveru. Příkaz return vrátí spuštěný skript na místo odkud byl vyvolán. Následující NPC se jménem Dežo hraje s hráčem jednoduchou hru, kdy hráč vyhrává s pravděpodobností 25%.

place.gat,50,50,6%TAB%script%TAB%Dežo%TAB%115,{
  mes "[Dežo]"
  mes "Vyber si skořápku...";
  next;
  callfunc "funcNPC";
  mes "Oh, vyhrál jsi!";
  close;
}
function%TAB%script%TAB%funcNPC%TAB%{
  set @win, rand(4);
  if(@win==0) return;
  mes "Bohužel jsi prohrál.";
  end;
}

Je možné předat funkci argumenty - hodnoty říkající přesně co dělat - které pak budou dostupné pomocí Getarg:getarg(). Za povšimnutí také stojí to, že není třeba používat Return:return a je možné ukončit provádění skriptu pomocí End:end. Pokud chcete vrátit hodnotu uvnitř funkce, je lepší napsat ji ve funkční formě, což dělá kód čistší.

place.gat,50,50,6%TAB%script%TAB%Gauss%TAB%115,{
  mes "[Gauss]"
  mes "Řekni číslo!";
  next;
  input @number;
  if (callfunc("OverCislo",@number)) mes "Ale tohle číslo je liché!";
  close;
}
function%TAB%script%TAB%OverCislo%TAB%{
    if (getarg(0)%2==0) goto JeSude;
    return (1);
  JeSude:
    return (0);
}

• callsub <návěstí>{,<argument>,…<argument>}; - Příkaz přejde na dané návěstí v tomto skriptu, stejně jako při volání Callfunc:callfunc a předává argumenty dostupné pomocí Getarg:getarg. Jakmile skončíme, měl by být použit Return:return k návratu do bodu odkud bylo návěstí vyvoláno. Příkaz je používán pokud je určitá část skriptu volána znovu a znovu. Ušetří se tím místo i čas, bez potřeby vytvářet další NPC potřebné při volání Callfunc:callfunc. Návěstí ale není přístupné z jiného skriptu.

mes "[Žena]"
  mes "Podívejme se zda jsi vyhrál...";
  callsub Check;
  mes "Výborně, vyhrál jsi!";
Check:
  set @win, rand(2);
  if(@win==0) return;
  mes "Bohužel jsi prohrál...";

• checkcart();

• checkfalcon();

• checkoption(<číslo>);
• checkoption1(<číslo>);
• checkoption2(<číslo>);

• checkriding();

• checkweight(“<jméno předmětu>“,<počet>);
• checkweight(<id předmětu>,<počet>);

• cleararray <název pole>[<první hodnota určená ke změně>],<hodnota>,<počet hodnot ke změně>;

• clone “<jméno mapy>“,<x>,<y>,“<event>“,<id postavy>{,<master_id>{,<mód>{,<flag>,<trvání>}}};

• close;

• close2;

• copyarray <cílové pole>[<první hodnota>],<původní pole>[<první hodnota>],<počet ke kopírování>;

• countitem(“<jméno předmětu>“); - funkce vrací počet přemětů určených jménem v inventáři postavy.
• countitem(<id předmětu>); - funkce vrací počet přemětů určených 'id předmětu' v inventáři postavy.

mes "[Celník]";
mes "Hmmm, zdá se že pašuješ "+countitem(502)+" jablek!";
close;

• countitem2(<id předmětu>,<identifikace>,<refine>,<atribut>,<karta1>,<karta2>,<karta3>,<karta4>);
• countitem2(“<název předmětu>“,<identifikace>,<refine>,<atribut>,<karta1>,<karta2>,<karta3>,<karta4>);

• cutin “<jméno souboru bez přípony>“,<pozice>;

• cutincard <id předmětu>;

• deletearray <jméno pole>[<první hodnota>],<kolik smazat>;

• delitem <jméno předmětu>,<počet>; - smaže daný počet předmětů určených jménem z inventáře postavy.
• delitem <id předmětu>,<počet>; - smaže daný počet předmětů určených 'id předmětu' z inventáře postavy.

• delitem2 “<název předmětu>“,<počet>,<identifikace>,<refine>,<atribut>,<karta1>,<karta2>,<karta3>,<karta4>{,<id postavy>};
• delitem2 <id předmětu>,<počet>,<identifikace>,<refine>,<atribut>,<karta1>,<karta2>,<karta3>,<karta4>{,<id postavy>}; - Pro popis argumentů viz Getitem2:getitem2.

• disable_items; Viz také Enable_items:enable_items

• disablenpc “<jméno NPC objektu>“; Viz také Enablenpc:enablenpc

• doevent “<jméno NPC objektu>::<label eventu>“;

• donpcevent “<event label>“;

• eaclass {<číslo povolání>};

• enable_items; Viz také Disable_items:disable_items

• disablenpc “<jméno NPC objektu>“; Viz také Disablenpc:disablenpc

• end; - Ukončí spouštění aktuálního skriptu.

* failedrefitem <equipment slot>;

• getareadropitem(“<jméno mapy>“,<x1>,<y1>,<x2>,<y2>,<předmět>);

• getareausers(“<jméno mapy>“,<x1>,<y1>,<x2>,<y2>);

• getarg(<číslo>);

• getarraysize(<jméno pole>);

* getbrokenid(<číslo>);

• getcharid(<typ>{,“<jméno postavy>“});

• getelementofarray(<jméno pole>,<index>);

• getequipisenableref(<equipment slot>);

• getequipisequiped(<equipment slot>);

• getequipisidentify(<equipment slot>);

• getequipid(<equipment slot>);

* getequipname(<equpment slot>);

• getequippercentrefinery(<equipment slot>);

• getequiprefinerycnt(<equipment slot>);

• getequipweaponlv(<equipment slot>);

• getgdskilllv(<id gildy>,<id skillu>);

• getgmlevel(); - funkce vrací hodnotu GM práv.

• getguildmaster(<id gildy>);

• getguildmasterid(<id gildy>);

• getguildname(<id gildy>);

• getitem “<název předmětu>“,<počet>{,<id postavy>}; - vytvoří předmět podle jména.
• getitem <id předmětu>,<počet>{,<id postavy>}; - vytvoří předmět podle ID.
  • getitem „Poring_Card“,4; - vytvoří 4 Poring karty v inventáři postavy.
  • getitem 502,10; - vytvoří 10 jablek v inventáři postavy.

• getitem2 “<název předmětu>“,<počet>,<identifikace>,<refine>,<atribut>,<karta1>,<karta2>,<karta3>,<karta4>{,<id postavy>};
• getitem2 <id předmětu>,<počet>,<identifikace>,<refine>,<atribut>,<karta1>,<karta2>,<karta3>,<karta4>{,<id postavy>};

• getmapusers(“<map name>“);

• getpartyleader <id party>,[<typ>];

• getpartymember <id party>,[<typ>];

• getpartyname(<id party>);

• getskilllv(<id skillu>);

• gettime(<typ>)

• gettimetick(<typ tiku>);

• gettimestr(<formátovací řetězec>,<maximální délka>);

• getusers(<typ>);

• goto <návěstí>; - Provede skok na řádek skriptu obsahující 'návěstí'. Obvykle je používán v kombinaci s jinými příkazy, např. if:if.

goto Label;
  mes "Toto hráč neuvidí.";
Label:
  mes "Toto hráč uvidí.";

• groupranditem <id skupiny>;

• guildchangegm(<id gildy>,<jméno nového guild mastera>);

• guildopenstorage();

• guildskill <id skillu>,<level>{,<flag>};

• heal <hp>,<sp>; - vylečí nebo obnoví postavě daný počet hp, sp.

• hideoffnpc “<jméno NPC objektu>“; viz také Hideonnpc:hideonnpc

• hideonnpc “<jméno NPC objektu>“; viz také Hideoffnpc:hideoffnpc

• if (<podmínka>) <kód>;

• input <proměnná>;

• itemheal <hp>,<sp>;

• itemskill <id skillu>,<level skillu>,“<viditelné jméno skillu>“;

• jobchange <číslo povolání>{,<upper flag>};

• jobname <číslo povolání>;

• killmonster “<jméno mapy>“,“<event label>“; - zabije všechny moby na dané mapě s určitým labelem.

• killmonsterall “<jméno mapy>“;

• makeitem “<název předmětu>“,<počet>,<x>,<y>,“<jméno mapy>“;
• makeitem <id předmětu>,<počet>,<x>,<y>,“<jméno mapy>“;

• mapannounce “<map name>“,“<text>“,<flag>[,<color>];

• menu “<položka menu1>“,<návěstí1>{,“<položka menu2>“,<návěstí2>…};

• mes “<řetězec>“; - Tento příkaz zobrazí na obrazovce hráče, který skript spustil, okno a zobrazí 'řetězec' v tomto okně. Okno neobsahuje žádné tlačítka 'close' ani 'next', proto je důležité je připojit! Bez nich hráč nemůže dělat nic jiného. Pokud je 'řetězec' prázdný, zobrazí se prázdné okno. V řetězci je možné měnit barvy. Barevný kód je '^<R><G><B>' a obsahuje tři hexadecimální čísla reprezentující červenou, zelenou a modrou složku. ^FF0000 je červená, ^00FF00 zelená, ^0000FF modrá, ^000000 je černá. POZOR ^FF00FF je fialová barva, ale právě toto je barva kterou klient považuje za průhlednou, takže text v této barvě vytvoří poněkud podivný efekt. Jakmile změníte barvu, nezapomeňte ji změnit zpět na černou, pokud ovšem nechcete zbytek textu ve změněné barvě. Je také dobré oddělit barevné kódy od textu mezerou.
  • mes „Tento text se zobrazí v okně.“;
  • mes „Toto je ^FF0000 červené ^000000 a toto je ^00FF00 zelené ^000000.“;

• monster “<jméno mapy>“,<x>,<y>,“<jméno>“,<id mobu>,<počet>{,“<event label>“};
  • <jméno mapy> - jméno mapy kde se monstrum objeví
  • <x>,<y> - souřadnice na mapě, kde se monstrum objeví
  • <jméno> - jméno se kterým se mob objeví
  • <id mobu> - id podle mob_db.txt monstra určí jaký typ moba bude použit
  • <počet> - počet mobů
  • <event label> - label, který se provede po smrti mobíka.

• next;

• openstorage; - otevře postavě kafru.

• percentheal <hp>,<sp>;

• playerattached; - Vrátí ID hráče přidružené k právě spuštěnému skriptu. Vrátí 0 v případě že není žádné ID přidruženo nebo pokud hráč již neexistuje na map serveru (logout). Je moudré kontrolovat přidruženého hráče ve funkcích skriptu které zachází s timery, protože zde není záruka že hráč bude ještě nalogovaný ve hře v době spuštění triggeru. ID hráče je vlastně ID účtu.

• produce <level předmětu>;

• rand(<číslo1>{,<číslo2>}); - Pro jeden argument vybere náhodné číslo mezi 0 a číslo1 včetně. Pro dva argumenty vybere náhodné číslo mezi číslo1 a číslo2 včetně.
  • rand(2) - bude vybráno z čísel 0 1 2.
  • rand(2,4) - bude vybráno z čísel 2 3 4.

• readparam(<číslo parametru>);

• repair <číslo pokažené věci>;

• return {(<hodnota>)}; - Při volání Callsub:callsub nebo Callfunc:callfunc tento příkaz umožňuje návrat zpět do původího skriptu. Volitelně lze vrátit hodnou která původnímu skriptu řekne, co se přesně stalo. Pro přístup k této hodnotě je třeba použít příkaz Set:set: set <proměnná>,callfunc “<funkce>“

Nezapomeňte na kulaté závorky. Jsou potřeba kdykoliv 'hodnota' není přímo číslo. Např. return (@x+@y); Je třeba dávat pozor na to, že if (<podmínka>) return (<cokoliv>); vždy nefunguje! I když by to pomohlo k čitelnosti kódu, pokuste se této konstrukci vyhnout. Pro příklad použití viz Callfunc:callfunc a Callsub:callsub.

• roclass <job number> {,<gender>}

• save “<map name>“,<x>,<y>;

• savepoint “<jméno mapy>“,<x>,<y>;

• set <variable>,<expression>;

• setarray <array name>[<first value>],<value>{,<value>…<value>};

• setcart; - dá postavě vozík.

• setfalcon; - dá postavě falcona.

• setlook <typ vzhledu>,<hodnota>;

• setoption <číslo>{,typ};

* setriding;

• skill <id skillu>,<level>{,<flag>};

• statusup <vlastnost>;

• statusup2 <vlastnost>,<velikost změny>;

* strcharinfo(<typ>);

• successrefitem <equipment slot>;

• viewpoint <akce>,<x>,<y>,<číslo bodu>,<barva>;

• warp “<mapa>“,<x>,<y>; - přenese postavu na danou mapu a pozici (x,y).