Hauptmenü öffnen

AntamarWiki β

Änderungen

Function

1.482 Bytes hinzugefügt, 15:59, 28. Mai 2012
ermittle-item-anzahl hinzu
Mit Hilfe des <function>-Tags können in [[AOQML]] interne Abfragen gemacht werden. Dieser Tag ist generisch gehalten, damit vielfältige, ungewöhnliche Abfragen an das System möglich sind.
== Syntax ==
*'''param2''' (optional) ist der zweite Parameter, der der Funktion übergeben wird.
''Beachte'': Jede Funktion benötigt eine vorgeschriebene Anzahl an Parametern, dazu bitte bei der Anwendung der Funktion nachlesen.
Das Ergebnis einer Funktion wird ausgegeben. Um das Ergebnis weiter zu nutzen, kann man den <function>-Tag durch ein [[store]] umschließen.
== Funktionen ==
 
=== Funktion "ermittle-item-anzahl" ===
 
Diese Funktion gibt als Ergebnis die Anzahl eines Gegenstandes zurück, den der Held mit sich führt. Dabei wird auch im Gepäck von [[Begleiter|Begleitern]] gesucht.
 
*'''param1''': erwartet den Warennamen oder die WareID, mit # vorangestellt.
*'''Rückgabe''': eine Zahl.
 
Beispiel:
<code xml n>
<store name="anzahl1"><function name="ermittle-item-anzahl" param1="Wolldecke"/></store>
<p>Anzahl Wolldecken: <fetch name="anzahl1"/></p>
 
<store name="anzahl2"><function name="ermittle-item-anzahl" param1="#2300"/></store>
<p>Anzahl Wolldecken: <fetch name="anzahl2"/></p>
</code>
=== Funktion "ist-urgott-in-pantheon" ===
Diese Funktion erlaubt die Prüfung, ob ein Urgott durch eine Gottheit in einem Pantheon repräsentiert wird.
Erwartet werden *'''zwei Parameterparam1''': Hier wird der Urgott angegeben.*'param1' steht für den Urgott, 'param2' für '': Hier wird das Pantheonangegeben.  *'''Rückgabe''' der Funktion ist : 'true' oder 'false'.
Beispiel:
=== Funktion "ist-segelschiff" ===
Die Funktion prüft, ob das aktuelle Fortbewegungsmittel (auf Reisen) ein Segelschiff ist. <br />Es wird kein Parameter erwartet.<br />
Rückgabe der Funktion ist 'true' oder 'false'.
=== Funktion "waren-wiederfinden" ===
Die Funktion ist für besonders seltene '''Zufallsbegegnungen ''' vorgesehen. Sie erlaubt, ehemals verlorene Gegenstände des Helden in derselben ZB wiederzufinden.Als Parameter (*'''param1''' (optional) kann angegeben werden: wenn 'false', ob auch verlorene Gegenstände von anderen Helden gefunden werden können (standardmäßig aktiv), oder ob nur eigene Gegenstände wiedergefunden werden können (wenn . Wenn dieser Parameter nicht angegeben ist, oder einen anderen Wert als 'false')enthält, dann werden auch Gegenstände von fremden Helden wiedergefunden.<br />*'''Rückgabe''' der Funktion ist : 'true' (wenn mindestens 1 Gegenstand wiedergefunden wurde) oder 'false' (wenn kein Gegenstand aufgenommen wurde).
Beispiel:
</has>
</code>
 
=== Funktion "get-ware-from-inventory" ===
 
Diese Funktion liest den Warennamen oder die WareninstanzID aus einem Inventar aus.
 
*'''param1''': Name des [[Inventar|Inventars]]
*'''param2''': wenn 'name' wird der Warenname zurückgegeben, andernfalls die InstanzID
*'''param3''': wenn 'true' wird die Ware aus dem Inventar entfernt
*'''Rückgabe''': der Warenname oder die WareninstanzID, abhängig von param1
 
Beispiel:
<code xml n>
 
</code>
 
=== Funktion "mach-gegenstand-unklaubar" ===
 
Diese Funktion markiert einen Gegenstand intern als unklaubar. Diese Funktion wird hier nicht weiter dokumentiert, da sie nur mit Bedacht eingesetzt werden soll, d.h. ausschließlich von den Programmierern. Diese können sich die interne Dokumentation anschauen.
 
[[Kategorie:AOQML-Tags]]
[[Kategorie:AOQML]]