vEnd

Obtížnost:
 
Osnova:
1. Úvod, co je to funkce;
2. Definice funkce a její části;
3. Parametry;

4. Návratová hodnota;

5. Závěr.
 
1. Úvod, co je to funkce

Zdravím, tímto návodem konečně dokončím šňůru návodů pro začátečníky. Posledním tématem, které jsme ještě nestihli probrat, jsou funkce. O čem je řeč?

Funkce jsou takové části kódu, které lze volat v různých částech skriptu. Někdy se lze také setkat s pojmem podprogram (ačkoliv to není to samé – podprogramem mohou být i metody, ale to se nás ani Pawn netýká).

Účel je jasný – abychom nemuseli psát tentýž kód na více místech, napíšeme jej jen jednou a voláme jej tam, kde potřebujeme. Přináší nám to hned několik benefitů – kratší a přehlednější kód, při úpravě kódu jej stačí upravit na jednom místě, totéž platí pro opravy chyb.

Počas skriptování SA:MP skriptů se setkáváme s funkcemi nepřetržitě, jmenovitě například funkce GetPlayerName, SendClientMessage, strval, ale i OnPlayerConnect či OnFilterScriptInit.

2. Definice funkce a její části

Když už máme představu, co to funkce je, měli bychom si ukázat, jak ji vytvořit. Každá funkce má svůj název (identifikátor), dále pak parametry, o kterých si řekneme za chvíli, tělo, do kterého vkládáme kód, a jako poslední návratovou hodnotu (i když tu nemusí mít nezbytně, o tom za chvíli).

Ukažme si to na kódu:

Secist(cislo1, cislo2)
{
    new suma;
    suma = cislo1 + cislo2;
    return suma;
}

Teď si určíme jednotlivé části funkce:

– identifikátor: Secist

– parametry: cislo1 a cislo2

– tělo funkce: všechno mezi složenými závorkami {}

– návratová hodnota: return suma;

Jak je vidět, jako první se uvádí identifikátor, poté následují parametry ohraničené kulatými závorkami, následně se píše tělo kódu do složených závorek a do těla se uvádí návratová hodnota příkazem return. Výše uvedená funkce slouží k součtu dvou celých čísel.

3. Parametry

Díky parametrům můžeme funkci předávat vstupní hodnoty a/nebo ovlivňovat to, jak se bude chovat. U naší sčítací funkce parametry slouží k předání sčítanců. Ale například funkce strcmp má parametr ignorecase, který nám určuje, zda má funkce ignorovat rozdíl mezi velkými a malými písmeny. Tento parametr ovlivňuje chování funkce.

Parametry funkcí v Pawn mohou být různého datového typu (tedy celá čísla, desetinná čísla, logické hodnoty, řetězce atd.) a může jich být libovolný počet. Jsou funkce, které nemají žádné parametry (kulaté závorky ale musíme uvést vždy – ()), jsou takové, které jich mají i 10.

Zde je pár funkcí na ukázku, každá s jiným počtem parametrů (všechny lze dohledat na SA:MP wiki):

GetTickCount(); //funkce bez parametrů
SendClientMessage(playerid, color, const message[]); //funkce se 3 parametry
AddPlayerClass(modelid, Float:spawn_x, Float:spawn_y, Float:spawn_z, Float:z_angle, weapon1, weapon1_ammo, weapon2, weapon2_ammo, weapon3, weapon3_ammo); //funkce s 11 parametry

Lze si všimnout, že u některých se objevují věci jako Float:, [] apod. Právě tyto, prozatím tomu říkejme "věci", nám určují, jaký datový typ bude daný parametr mít. Seznam nejčastěji používaných datových typů:

playerid // když neuvedeme nic, bere to jako celé číslo
Float:x // Float: nám značí desetinné číslo
bool:ignorecase // bool: nám značí logickou hodnotu (true/false)
message[] // hranaté závorky znamenají řetězec (nebo pole, viz předchozí návody)

Zbývá nám uvést si, jak takové parametry dosazovat při volání funkce. Jednoduše za ně dosadíme skutečné hodnoty (přesněji argumenty) v tom pořadí, v jakém jsme je definovali:

GetTickCount(); //nic se nemění
SendClientMessage(0, 1, "Ahoj, světe!"); //dosazení argumentů (skutečných hodnot)

Nad rámec návodu (pro zvídavé):

strcmp("Ahoj", "Hello"); // nechali jsme parametrům výchozí hodnoty
strcmp("Ahoj", "Hello", true); // změnili jsme výchozí hodnotu parametru ignorecase
strcmp("Ahoj", "Hello", true, 2); // změnili jsme výchozí hodnotu oběma parametrům

Soucet(cislo1, cislo2=0) //parametr cislo2 má výchozí hodnotu 0, a tudíž musí být na konci
{
    new suma;
    suma = cislo1 + cislo2;
    return suma;
}

4. Návratová hodnota

Na začátku jsme řekli, že funkce má také návratovou hodnotu. Přesněji řečeno, může mít, ale nemusí. Přesně tak, funkce žádnou návratovou hodnotu mít nemusí. V některých jazycích se pak funkce bez návratové hodnoty nazývá procedurou.

V kódu naší sčítací funkce je vidět, že hodnotu vrátíme příkazem return. Ve funkci můžeme tento příkaz použít vícekrát (často to souvisí s podmínkami a větvením), ale pravidlem je, že musí vždy vrátit hodnotu stejného datového typu. Kompilátor nám neumožní vrátit jednou celé číslo a jednou řetězec, to prostě nejde.

Když už jsme zmínili datové typy, je třeba si dávat pozor na jednu věc. Pokud vracíme hodnotu jinou než celé číslo či řetězec, musíme před identifikátor uvést příslušný tag (teď už nepíši "věc", ale tag). Upravme si tedy naši funkci pro sčítání dvou desetinných čísel:

Float:Secist(Float:cislo1, Float:cislo2) // před názvem nám přibyl tag Float
{
    new Float:suma;
    suma = cislo1 + cislo2;
    return suma;
}

Zde je vidět, že před názvem nám přibylo Float:. Je to nutné pro správný chod funkce. Kdybychom vraceli např. logické hodnoty, byl by tam tag bool:.

A jak je to tedy s funkcemi (procedurami, jestli chcete), které nic nevracejí? Jsou dvě možnosti, buď uvedeme prázdný return – return; – nebo neuvedeme nic. Je to jen na vás, běžná je druhá varianta (neuvádět nic). Ukázka:

Vypis(const message[])
{
    print(message);
    return;
}

Vypis2(const message[])
{
    print(message);
}

5. Závěr

A tím jsme se dostali jak k závěru tutoriálu, tak k závěru celé série. Děkuji všem, kteří si návod přečetli, a obdivuji všechny, kteří prošli celou sérií. Doufám, že jste se dozvěděli něco nového, pokud ne, alespoň jste si to zopakovali.

Prozatím neplánuji začínat další sérii návodů, ale je možné, že se sem tam něco objeví.

Ještě jednou děkuji a platí to, co vždycky – pokud jste našli nějakou chybu či nesrovnalost nebo se jen chcete na něco zeptat, zanechte mi vzkaz pod tímto příspěvkem.