CR-Format

Bekannte Beispiele (unvollständig):

ZAUBERE [STUFE n] Zauber
"";syntax

ZAUBERE [STUFE n] Zauber <Einheit-Nr>
"u";syntax

ZAUBERE Zauber <Einheit-Nr> <investierte Aura>
"ui";syntax

ZAUBERE [REGION x y] [STUFE n] Zauber REGION
ZAUBERE [REGION x y] [STUFE n] Zauber EINHEIT <Einheit-Nr>
ZAUBERE [REGION x y] [STUFE n] Zauber GEBÄUDE <Gebäude-Nr>
ZAUBERE [REGION x y] [STUFE n] Zauber SCHIFF <Schiff-Nr>
"kc?";syntax

ZAUBERE Zauber <Richtung>
"c";syntax

ZAUBERE [STUFE n] Zauber <Einheit-Nr> [<Einheit-Nr> ...]
"u+";syntax

Bedeutung der einzelnen Buchstaben:

'c' = Zeichenkette
'k' = REGION|EINHEIT|STUFE|SCHIFF|GEBAEUDE
'i' = Zahl
's' = Schiffsnummer
'b' = Gebaeudenummer
'r' = Regionskoordinaten (x, y)
'u' = Einheit
'+' = Wiederholung des vorangehenden Parameters
'?' = vorangegangener Parameter ist nicht zwingend

Defaultwert: ZAUBERE [STUFE n] Zauber
oder Syntax nicht bekannt.
Seit Report 511.

ZUTATEN
"Flachwurz"
"Fjordwuchs"

Zwischen dem Vorlage-Entwickler (Glurak) und den Magellanentwicklern hat man sich auf ein einheitliches System geeinigt, das allerdings noch nicht implementiert ist.
Hierbei wird auf einer Region einer Insel ein Insel-Attribut angelegt, oder mehrere Regionen mit unterschiedlichen Werten, falls die Insel bezüglich des Namens geteilt ist, das als int-Wert die Nummer der Insel enthält.
Existiert nur ein solch ein Insel-Attribut auf der Insel, wird so die gesamte Insel benannt. Existieren jedoch mehrere Attribute, entscheidet die Entfernung einer Region zu den benennenden Regionen zu welchem Teil der Insel diese Region nun gehört.
Weiters existiert je Insel ein ISLAND-Block, der die weitere Benennung und Beschreibung der Insel enthält.

Aktuell sind noch folgende beiden Systeme etabliert:

Die Mercator-Methode, ist das zuerst vom Client Mercator etablierte System. Hierbei wird wie in der erstgenannten Methode ein Insel-Attribut in einer der Regionen einer Insel angelegt, welches jedoch direkt den Inselnamen als String enthält.
Auch hier wird der Name an die anderen Regionen der Insel wie oben weitergegeben. Ein zusätzlicher Block existiert nicht.

Die von Magellan angewendete Methode verwendet auch ein Insel-Attribut mit einem String als Wert, doch wird der Inhalt des Strings zwingend als base10 Integer interpretiert. Die weitere Beschreibung der Insel geschieht hier über einen ISLAND-Block.
Bei dieser Methode wird der Name allerdings nicht von Region zur restlichen Insel weitergegeben, sondern jede Region einer Insel muss ein Attribut mit der Inselnummer als String enthalten.

EFFECT     => "\"" EFFECT_STR "(" NUMMER ")"
            | "\"" EFFECT_NUM EFFECT_STR"\""
EFFECT_STR => {ANY_ASCII_CHAR}
EFFECT_NUM => NUMBER
NUMMER     => BASE36 [BASE36 [BASE36 [BASE36]]]
BASE36     => "0" | ... | "9" | "a" | ... | "z" | "A" | ... | "Z"

Der EFFECT_STR Teil ist hierbei ein vom genauen Effekt abhängiger String, der vom Spieler lesbar ist. Der NUMMER Teil ist eine base36 Zahl, welche die Nummer des Effekts angibt. Die Nummer eines Effektes ist fix vergeben, hält der Effekt also über mehrere Runden an, so findet sich beim entsprechenden Listeneintrag immer die selbe Nummer.

Es gibt alternativ dazu auch Effekte von Alchemistischen Tränken, welche keine Effekt-Nummer haben, sondern durch deren Anzahl und einen vom Spieler lesbaren String gegeben sind.

DURCHSCHIFFUNG => "\"" NAME "(" NUMMER ")"
NAME           => {ANY_ASCII_CHAR}
NUMMER         => BASE36 [BASE36 [BASE36 [BASE36]]]
BASE36         => "0" | ... | "9" | "a" | ... | "z" | "A" | ... | "Z"

Generell besteht der Wert des text-Attributs aus reinem Text, welcher 1:1 übernommen wird, und Text der zu ersetzenden ist.

Der Wert des String-Attributs nimmt diese Gestalt an (Siehe bei Beschreibung des Attribut-Syntax wegen Hochkomma-escapen):

TEXT => "\"" { ATTR | FUNC | CHAR } "\""
EXPR => ATTR | FUNC | STRING | CONST
ATTR => "$" ALPHA { ALPHANUM }
      | "${" {WS} ALPHA { ALPHANUM } {WS} "}"
FUNC => "$int"   {WS} "(" {WS} EXPR {WS} ")"
      | "$if"        {WS} "(" {WS} EXPR {WS} "," {WS} EXPR {WS} "," {WS} EXPR {WS} ")"
      | "$eq"        {WS} "(" {WS} EXPR {WS} "," {WS} EXPR {WS} ")"
      | "$unit"      {WS} "(" {WS} EXPR {WS} ")"
      | "$region"    {WS} "(" {WS} EXPR {WS} ")"
      | "$building"  {WS} "(" {WS} EXPR {WS} ")"
      | "$ship"      {WS} "(" {WS} EXPR {WS} ")"
      | "$faction"   {WS} "(" {WS} EXPR {WS} ")"
      | "$resource"  {WS} "(" {WS} EXPR {WS} "," {WS} EXPR {WS} ")"
      | "$resources" {WS} "(" {WS} EXPR {WS} ")"
      | "$order"     {WS} "(" {WS} EXPR {WS} ")"
      | "$isnull"    {WS} "(" {WS} EXPR {WS} ")"
      | "$strlen"    {WS} "(" {WS} EXPR {WS} ")"
      | "$add"       {WS} "(" {WS} EXPR {WS} "," {WS} EXPR {WS} ")"
      | "$direction" {WS} "(" {WS} EXPR {WS} ")"
      | "$localize"  {WS} "(" {WS} EXPR {WS} ")"
      | "$skill"     {WS} "(" {WS} EXPR {WS} ")"
      | "$spell"     {WS} "(" {WS} EXPR {WS} ")"
      | "$sace"      {WS} "(" {WS} EXPR {WS} ")"
      | "$weight"    {WS} "(" {WS} EXPR {WS} ")"
STRING   => "\"" EXPR "\""
CONST    => {NUM} { {WS} {NUM} }
CHAR     => ALPHA | NUM | WS | SYMB | UMLAUT
ALPHANUM => ALPHA | NUM
ALPHA    => "a" | ... | "z" | "A" | ... | "Z"
UMLAUT   => "ä" | "ü" | ... | "ß"
NUM      => "0" | ... | "9"
WS       => " "
SYMB     => "." | "," | "\\$" | HTAB
HTAB     => 0x09

Die mit "$" beginnenden Teile sind nun speziell zu behandelnde Funktionsaufrufe und Verweise auf ein Attribut im MESSAGE-Block.

Funktionen

$int( expr )
Es wird versucht expr als int zu interpretieren und in die umgebende Zeichenkette eingebettet. Diese Funktion scheint also nur den Zweck zu erfüllen, Zahlenwerte in Zeichenketten umzuwandeln. Zum Beispiel: "$int($amount) Korken."
Unklar ist ob auch ein Wert, wie er bei den Koordinaten einer Region vorkommt, erlaubt ist. Ist dem so, wäre ein Beispiel wie folgt: $int("10 -4 0") ergibt den int-wert: 10 -4 0.

$if( condition, expr1, expr2 )
Condition erwartet einen int-Wert. Dieser int-Wert wird C-üblich interpretiert, d.h. bei condition!=0 wird der Wert von expr1 zurückgegeben, sonst wird der Wert von expr2 zurückgegeben. Welcher der beiden Werte bei einem NULL-Wert zurückgegeben werden soll, ist unklar. Im Zweifelsfall sollte das expr2 sein.

$eq( expr1, expr2 )
Gibt einen int-Wert ungleich 0 zurück, wenn expr1 und expr2 den selben Wert annehmen, sonst 0. In allen bekannten Messagetypen sind expr1 und expr2 int-Werte, dies muss aber nicht zwangsläufig so sein.

$unit( expr )
Erwartet für expr einen int-Wert, und interpretiert diesen als Einheitennummer. Zurückgegeben wird ein zusammengestzer String aus Name und Nummer (in base36, siehe das Basis-Attribut des VERSION-Blocks) der Einheit. Zum Beispiel: "Fridolin (foo)". Eine Ausnahme gilt für den Wert 1: In diesem Fall wird vom Server der Text "eine unbekannte Einheit (1)" zurückgegeben. Einen NULL Wert sollte die Funktion ähnlich behandeln. Abweichend gibt es auch die Schreibweise $unit.dative() die aber offenbar die gleichen Ergebnisse liefert.

$region( expr )
Ähnlich wie $unit.
Erwartet für expr einen Verweis auf ein Attribut mit 3 int-Werten, und interpretiert diese als Koordinaten einer Region. Zurückgegeben wird ein zusammengestzer String aus Name und Koordinaten der Region. Zum Beispiel: "Waldberge (23,-4)" (Ist die z-Koordinate 0, wird sie nicht dargestellt).
Als Konstante kann dieses int-Tripel eigentlich nur wie bei $int() beschrieben dargestellt werden, also "1 2 1". Nur Kommas sind als Trenner ungeignet, da bereits die Funktionsparameter durch Kommas getrennt werden. Möglicherweise wäre eine Einklammerung in eckige Klammern denkbar "[1 2 0]". Konform mit der Schreibweise in den Tags im CR sollte es aber die erste genannte Variante sein.

$building( expr )
Ähnlich wie $unit.
Erwartet für expr einen int-Werten, und interpretiert diese als Gebäudenummer. Zurückgegeben wird ein zusammengestzer String aus Name und Nummer (in base36, siehe das Basis-Attribut des VERSION-Blocks) des Gebäudes. Zum Beispiel: "Seefeste (r5x)".

$ship( expr )
Ähnlich wie $unit.

$faction( expr )
Ähnlich wie $unit.

$resource( expr1, expr2 )
Erwartet für expr1 einen String, der den Namen der Resource (In der Reportinternen gültigen Form, also "Pferd", "Juwel", ...) bezeichnet, und für expr2 einen int-Wert der die Menge angibt. Zurückgegeben wird dann ein zusammengesetzer String, der die Resource in der Menge grammatikalisch richtig und lokalisiert angibt. Zum Beispiel: $resource("Pferd",32) ergibt "Pferde" oder bei Locale=EN "horses". Zu beachten ist, das die Menge selbst nicht mit ausgegeben wird.

$order( expr )
expr ist ein String, und wird als Befehl interpretiert. Vor der Rückgabe des Befehlsstrings wird dieser noch hinsichtlich der Lesbarkeit verändert (zum Beispiel in eine andere Sprache übersetzt).

$isnull( expr )
Der Rückgabewert ist ein int-Wert ungleich 0, wenn das Attribut auf das expr verweist fehlt, oder -1 ist.

$strlen( expr )
Erwartet für expr einen String, und gibt dessen Länge als int-Wert zurück.

$add( expr1, expr2 )
Erwartet für expr1 und expr2 jeweils einen int-Wert, und gibt deren Summe zurück.

$direction( expr )
Die Funktion erwartet einen int-Wert und liefert eine Zeichenkette mit der Richtung zurück. Dabei gleichen die gleichen Beziehungen wie bei Küste:
0 = Nordwesten
1 = Nordosten
2 = Osten
3 = Südosten
4 = Südwesten
5 = Westen
Der String sollte entsprechend lokalisiert werden. Die Übersetzung findet man NICHT im Translation-Block.

$localize( expr )
Erwartet einen String der mithilfe der im TRANSLATION Block enthaltenen Daten lokalisiert werden muss.

$spell( expr )
Wie $localize(), interpretiert den String aber speziell als Zauberspruch.

$skill( expr )
Wie $localize(), interpretiert den String aber speziell als Talent.

$race( expr )
Wie $localize(), interpretiert den String aber speziell als Rasse.

$weight( expr )
Erwartet einen int-Wert der ein Gewicht in Silber angibt. Die zurückgegebene Zeichenkette sollte deutlich machen, das es sich um ein Gewicht handelt. Beispiele: $weight(100)="1 GE", $weight(10)="0.1 GE". Ich bin mir nicht sicher ob Gewichtseinheiten im englischen tatsächlich als "WU" gekennzeichnet werden.

$resources( expr )
Erwartet eine Zeichenkette. Diese sollte bereits richtig lokalisiert sein und kann daher ungeändert ausgegeben werden. Lediglich bei einer Änderung der Lokalisierung kann eine Übersetzung notwendig werden.

Verweise

Verweise auf Attribute des MESSAGE-Blocks sind nun alle jene speziell behandelten Teile, die keine Funktion sind.

Sie beginnen also alle ebenfalls mit einem "$" Zeichen, dem das Tag des Attributs folgt.

Der Verweis nimmt dann den Wert des Attributs an, wobei ein nicht Vorhanden sein des Attributs mit diesem Tag einen speziellen NULL Wert ergibt (Zum Beispiel bei der $isnull() Funktion von Bedeutung).

Der zurückgegebene Wert ist Typbehaftet, ist also ein Integer (int), ein Integer-Tupel (zB int-Trippel) oder ein String.