| Beide Seiten, vorherige ÜberarbeitungVorherige ÜberarbeitungNächste Überarbeitung | Vorherige Überarbeitung |
| scripting:tutorials:level2:functions [2023/09/09 16:19] – fritz_98 | scripting:tutorials:level2:functions [2024/05/17 10:02] (aktuell) – fritz_98 |
|---|
| Es handelt sich dabei nur um eine alternative Schreibweise, die Funktionalität bleibt die gleiche. | Es handelt sich dabei nur um eine alternative Schreibweise, die Funktionalität bleibt die gleiche. |
| |
| Das gleiche Prinzip funktioniert auch, wenn ein Table als einziger Parameter erwartet wird. Wir definieren eine Funktion, die eine Person etwas sagen lässt: | Das gleiche Prinzip funktioniert auch, wenn ein Table als einziger Parameter erwartet wird. Wir definieren eine Funktion, die eine Person etwas sagen lässt und belassen es Optional, ob der Sprecher oder die Aussage angegeben werden. Dazu benutzen wir ein Table als Paramter und wenden einen kleinen Trick an: Um herauszufinden, welche Informationen gegeben wurden, fragen wir (indirekt), ob sie **nil** sind. In Lua ist jede Variable, bevor sie definiert wird, **nil**. Demzufolge sind alle undefinierten Variablen **nil**. |
| <code lua> | <code lua> |
| -- _WhoAndWhat ist ein Table, das eine Person und einen Text enthalten kann, aber nicht muss | -- _WhoAndWhat ist ein Table, das eine Person und einen Text enthalten kann, aber nicht muss |
| ====Beispiele im Siedler-Skripting==== | ====Beispiele im Siedler-Skripting==== |
| |
| Eine Funktion, die beim Siedler-Skripten häufig verwendet wird, ermittelt die Gebäude oder Einheiten eines bestimmten Typs des Spielers. ''Logic.GetPlayerEntities(_PlayerId, _EntityType, _Amount)'' gibt höchstens ''_Amount'' EntityIds (FIXME link) von Spieler ''_PlayerId'' vom Typ ''_EntityType'' zurück. Wenn der Spieler weniger als ''_Amount'' Entities des gesuchten Typs besitzt, werden entsprechend weniger EnitityIds zurückgegeben. Wir haben hier also genau den Fall, dass eine Funktion viele Rückgabewerte hat, deren Anzahl aber nicht immer gleich ist. | Eine Funktion, die beim Siedler-Skripten häufig verwendet wird, ermittelt die Gebäude oder Einheiten eines bestimmten Typs des Spielers. ''Logic.GetPlayerEntities(_PlayerId, _EntityType, _Amount)'' gibt höchstens ''_Amount'' [[ scripting:tutorials:level1:place_entities#exkursentity-id_vs_skriptname |Entity-Ids]] von Spieler ''_PlayerId'' vom Typ ''_EntityType'' zurück. Wenn der Spieler weniger als ''_Amount'' Entities des gesuchten Typs besitzt, werden entsprechend weniger EnitityIds zurückgegeben. Wir haben hier also genau den Fall, dass eine Funktion viele Rückgabewerte hat, deren Anzahl aber nicht immer gleich ist. |
| |
| Darüber hinaus ist der erste Rückgabewert keine EntityId, sondern die Anzahl der gefundenen Ids! | Darüber hinaus ist der erste Rückgabewert keine EntityId, sondern die Anzahl der gefundenen Ids! |
| werden nur die ersten drei beachtet und addiert, der Rest verworfen. Die Funktion hat keine Möglichkeit, auf die Argumente zuzugreifen. Allerdings wird **kein** Fehler angezeigt! Darauf zu achten, einer Funktion nicht zu viele Argumente zu übergeben, wird dem Programmierer überlassen. | werden nur die ersten drei beachtet und addiert, der Rest verworfen. Die Funktion hat keine Möglichkeit, auf die Argumente zuzugreifen. Allerdings wird **kein** Fehler angezeigt! Darauf zu achten, einer Funktion nicht zu viele Argumente zu übergeben, wird dem Programmierer überlassen. |
| |
| Der Nutzen, den man daraus ziehen kann, ist eingeschränkt. Im Artikel zur [[ scripting:tutorials:level2:lua_library |Lua-Standardbibliothek]] wird die Funktion ''unpack'' beschrieben, mit der ein numerisches Table ([[ scripting:tutorials:level1:tables#tables_als_listen |Liste]]) "ausgepackt" wird. Die Funktion gibt jeden Eintrag im Table einzeln als Rückgabewert aus (siehe auch den Abschnitt oben über mehrere Rückgabewerte). ''unpack'' kann also dazu benutzt werden, die Inhalte eines numerischen Tables einzeln als Argumente zu übergeben. Mit der Funktion ''SumOfThree'' können so die ersten drei Zahlen in so einem Table addiert werden: | Der Nutzen, den man daraus ziehen kann, ist eingeschränkt. Im Artikel zur [[ scripting:tutorials:level2:lua_library |Lua-Standardbibliothek]] wird die Funktion ''unpack'' beschrieben, mit der ein numerisches Table ([[ scripting:tutorials:level1:tables#tables_als_listen |Liste]]) "ausgepackt" wird. Die Funktion gibt jeden Eintrag im Table einzeln als Rückgabewert aus (siehe auch den Abschnitt [[ scripting:tutorials:level2:functions#mehrere_rueckgabewerte |oben]] über mehrere Rückgabewerte). ''unpack'' kann also dazu benutzt werden, die Inhalte eines numerischen Tables einzeln als Argumente zu übergeben. Mit der Funktion ''SumOfThree'' können so die ersten drei Zahlen in so einem Table addiert werden: |
| <code lua> | <code lua> |
| local Numbers = {3, 25, 14, 9, 11, 17, 36} | local Numbers = {3, 25, 14, 9, 11, 17, 36} |
| Auch hier ist wieder zu beachten, dass zu wenige Argumente nicht per se als Fehler gelten und als Problemursache häufig versteckt auftreten. In unserem Beispiel mit der Summe können damit aber alle Parameter optional gemacht werden, sodass die nicht zwingend besetzt werden müssen. | Auch hier ist wieder zu beachten, dass zu wenige Argumente nicht per se als Fehler gelten und als Problemursache häufig versteckt auftreten. In unserem Beispiel mit der Summe können damit aber alle Parameter optional gemacht werden, sodass die nicht zwingend besetzt werden müssen. |
| |
| **Achtung**: Auf diese Weise solltest du höchstens **einen** Parameter als optional definieren. Bedenke, dass in unserem Beispiel für die Angabe von ''_C'' **zwingend** die Angabe von ''_B'' notwendig ist. Es lassen sich demnach keine Parameter "überspringen". Wenn du mehrere optionale Parameter anbieten willst, solltest du den Parameter als Table definieren (siehe auch das Beispiel ''SaySomething'' aus dem Abschnitt oben über verkürzte Funktionsaufrufe). Dadurch bekommt jeder Parameter einen Namen und kann unabhängig von allen anderen angegeben werden. \\ | **Achtung**: Auf diese Weise solltest du höchstens **einen** Parameter als optional definieren. Bedenke, dass in unserem Beispiel für die Angabe von ''_C'' **zwingend** die Angabe von ''_B'' notwendig ist. Es lassen sich demnach keine Parameter "überspringen". Wenn du mehrere optionale Parameter anbieten willst, solltest du den Parameter als Table definieren (siehe auch das Beispiel ''SaySomething'' aus dem Abschnitt [[ scripting:tutorials:level2:functions#verkuerzte_funktionsaufrufe |oben]] über verkürzte Funktionsaufrufe). Dadurch bekommt jeder Parameter einen Namen und kann unabhängig von allen anderen angegeben werden. \\ |
| Diesem Prinzip folgt beispielsweise die aus [[ scripting:tutorials:level1:enemy_ai#setupplayerai |Ebene 1 bekannte Funktion]] ''SetupPlayerAi'', die viele Optionen für die Definition eines KI-Spielers bietet, die unabhängig voneinander gewählt werden können. | Diesem Prinzip folgt beispielsweise die aus [[ scripting:tutorials:level1:enemy_ai#setupplayerai |Ebene 1 bekannte Funktion]] ''SetupPlayerAi'', die viele Optionen für die Definition eines KI-Spielers bietet, die unabhängig voneinander gewählt werden können. |
| |
| <code lua> | <code lua> |
| function Sum(...) | function Sum(...) |
| | local Result = 0 |
| for _, Number in ipairs(arg) do | for _, Number in ipairs(arg) do |
| Result = Result + Number | Result = Result + Number |
| </code> | </code> |
| Nach dem Aufruf hat ''MyTable'' 8 Einträge, wurde also um alle Werte, die der Funktion übergeben wurden, erweitert. | Nach dem Aufruf hat ''MyTable'' 8 Einträge, wurde also um alle Werte, die der Funktion übergeben wurden, erweitert. |
| | |
| | **Achtung**: Die Parameter können in diesem Fall nicht umgekehrt angegeben werden (also nicht ''MultiInsert(..., _Table)''! Die Funktion kann beim Aufruf nicht wissen, welche Argumente zu ''...'' und welche zu ''_Table'' gehören. Deshalb besteht generell die Regel, dass zuerst die festen/notwendigen Parameter angegeben werden müssen, bevor man die Funktion für beliebig viele weitere Parameter mit ''...'' "öffnet". |
| |
| ---- | ---- |
