Automatisch erzeugte Manpages.
Damit nicht jeder sphinx auf dem Rechner haben muss,
behalten wir bis auf weiteres die aus den .rst
erzeugten Manpoages auch im Repo.
Change-Id: Id556c0d11cf5f79659d8350952ce1c014d81ea44
diff --git a/doc/lfun/Configure b/doc/lfun/Configure
index 9763999..5a919ce 100644
--- a/doc/lfun/Configure
+++ b/doc/lfun/Configure
@@ -1,23 +1,38 @@
+
+Configure()
+***********
+
Configure()
- public mixed Configure(mixed data)
+ public mixed Configure(mixed data)
-DEFINIERT IN:
+
+DEFINIERT IN
+============
+
Beliebigen Objekten
-ARGUMENTE:
+
+ARGUMENTE
+=========
+
<data>
0 fuer Datenabfrage
beliebige Daten, die ein Configure(0) vorher lieferte
-BESCHREIBUNG:
+
+BESCHREIBUNG
+============
+
Viele Objekte werden fuer bestimmte Spieler konfiguriert und so
personalisiert. Sie enthalten zusaetzlich zu den Daten, welche waehrend des
create() gesetzt wurden, noch weitere spieler-individuelle Daten.
Damit diese Objekte im Bedarfsfall neu erstellt werden koennen, sollte ein
geeignetes Configure() definfiert werden, um diese Daten abzurufen und in
einem neuen Clone (oder neugeladener Blueprint) wieder zu setzen.
-
+
+
+
Existiert Configure() im Objekt, MUSS dieses bei einem Aufruf mit
<data>==0 (d.h. Configure(0)) alle individuellen Daten zurueckliefern,
die noetig sind, um den aktuellen Zustand des Objektes spaeter
@@ -29,7 +44,10 @@
von Configure(data) wieder gesetzt. Das Configure MUSS genau die Daten, die
es im alten Objekt zurueckliefert, wieder akzeptieren.
-RUeCKGABEWERT:
+
+RUeCKGABEWERT
+=============
+
Wenn <data>==0:
Alle individuellen Daten in einer beliebigen Form. Ein Mapping bietet
sich jedoch an.
@@ -39,13 +57,19 @@
1, wenn die Daten zur Konfiguration akzeptiert wurden.
0, sonst.
-BEMERKUNGEN:
+
+BEMERKUNGEN
+===========
+
Configure() ist nicht verpflichtet, erneut Daten zu akzeptieren, wenn es
bereits einmal mit gueltigen Daten aufgerufen wurde.
Das Zurueckschreiben der Daten kann auch nach Ablauf laengerer Zeit
und/oder in einer anderen Uptime erfolgen.
-BEISPIELE:
+
+BEISPIELE
+=========
+
Ein Objekt, welches ein anderes Objekt sicher ersetzt, d.h. die
individuelle Konfiguration bleibt erhalten:
mixed data;
@@ -71,6 +95,8 @@
"Daten enthaelt.",78));
}
-LETZTE AeNDERUNG:
-26.09.2011, Zesstra
+LETZTE AeNDERUNG
+================
+
+26.09.2011, Zesstra