Das Basismodul
Eine Liste der in Siedler 5 verfügbaren Funktionen des Lua-Basismoduls mit einer kurzen Beschreibung. Verlinkt sind ausführlichere Doku-Seiten.
| Funktion | Beschreibung |
|---|---|
| assert (_Condition [, _Message ]) | Prüft die Bedingung _Condition und zeigt eine Fehlermeldung an, falls sie nicht zutrifft. Außerdem wird die Ausführung der Funktion an der Stelle, an der _Condition nicht zutrifft, abgebrochen. In der Fehlermeldung wird der optionale Parameter _Message angezeigt. Diese Funktion wird in der Regel dafür benutzt, um angegebene Parameter auf Gültigkeit zu prüfen. |
| ipairs (_Table) | Gibt für ein numerisches Table _Table einen Iterator ( link) zurück, der in pro Iteration einen Index und zugehörigen Wert im Table generiert, wobei der Index von 1 bis n läuft. Die Iteration stoppt, sobald ein Index-Wert nicht mehr auf den vorigen folgt. Nicht-numerische Keys werden ignoriert |
| next (_Table [, _Key ]) | Gibt für ein Table _Table das nächste Key-Value-Paar des Tables, abhängig von _Key zurück. Ist _Key nicht angegeben, wird ein beliebiges Key-Value-Paar zurückgegeben. Ist _Table leer oder das letzte Element erreicht, wird nil zurückgegeben. Die Reihenfolge, in der die Key-Value-Paare des Tables zurückgegeben werden, ist undefiniert und kann jedes mal unterschiedlich sein |
| pairs (_Table) | Gibt für ein Table _Table einen Iterator ( link) zurück, der in pro Iteration ein Key-Value-Paar im Table generiert, deren Reihenfolge undefiniert ist und jedes mal unterschiedlich sein kann |
| tonumber (_String [, _Base ]) | Konvertiert einen String _String in eine Zahl. Der optionale Parameter _Base gibt an, zu welcher Basis die Zahl im String interpretiert werden soll. Kann _String nicht zu einer Zahl umgewandelt werden, wird nil zurückgegeben |
| tostring (_Value) | Wandelt den Wert _Value in einen String um. Praktisch nur für Zahlen und Booleans sinnvoll |
| type (_Value) | Gibt den Datentyp von _Value als String zurück |
| unpack (_Table) | Gibt für ein numerisches Table _Table alle Werte (einzeln) zurück |