Doku-Update
Change-Id: I50f67930cc59da3e054128503dbf33bfd33f36e6
diff --git a/doc/sphinx/lfun/GiveMiniQuest.rst b/doc/sphinx/lfun/GiveMiniQuest.rst
index 65f920a..5914f05 100644
--- a/doc/sphinx/lfun/GiveMiniQuest.rst
+++ b/doc/sphinx/lfun/GiveMiniQuest.rst
@@ -37,13 +37,11 @@
------------
::
- Mit dieser Funktion wird nach dem erfolgreichen Loesen einer
- MiniQuest die Quest im Spieler eingetragen. Dabei muss der
- Aufruf in dem Objekt erfolgen, welches im Questmaster
- eingetragen ist. Als Argument muss das Spielerobjekt
- angegeben werden, welches die Quest bestanden hat.
-
-
+ Mit dieser Funktion wird nach dem erfolgreichen Loesen einer
+ MiniQuest die Quest im Spieler eingetragen. Dabei muss der
+ Aufruf in dem Objekt erfolgen, welches im Questmaster
+ eingetragen ist. Als Argument muss das Spielerobjekt
+ angegeben werden, welches die Quest bestanden hat.
BEISPIEL
--------
@@ -55,7 +53,7 @@
----------
::
- HasMiniQuest
+ HasMiniQuest(), AddMiniQuest()
/secure/questmaster.h, /secure/questmaster.c
HINWEIS
diff --git a/doc/sphinx/lfun/PresentEnemies.rst b/doc/sphinx/lfun/PresentEnemies.rst
index a774a12..a47f4c4 100644
--- a/doc/sphinx/lfun/PresentEnemies.rst
+++ b/doc/sphinx/lfun/PresentEnemies.rst
@@ -23,7 +23,8 @@
-------------
::
- anwesende Feinde
+ Array mit anwesenden Feinden. Wenn keine Feinde anwesend sind, ist
+ das Array leer, es wird jedoch immer ein Array zurueckgegeben.
BESCHREIBUNG
------------
diff --git a/doc/sphinx/props/P_ARRIVEMSG.rst b/doc/sphinx/props/P_ARRIVEMSG.rst
index 73b3ac9..9adeb84 100644
--- a/doc/sphinx/props/P_ARRIVEMSG.rst
+++ b/doc/sphinx/props/P_ARRIVEMSG.rst
@@ -17,5 +17,14 @@
------------
::
- Meldung, wenn der Transporter anlegt.
+ Die Property enthaelt die Meldungen, die beim Erreichen eines
+ Haltepunktes an die Reisenden und an den Haltepunkt-Raum ausgegeben
+ werden. Sie muss ein String-Array mit zwei Elementen enthalten.
+ Fuer den Umbruch muss der Nutzer selbst Sorge tragen.
+
+LETZTE AENDERUNG
+----------------
+::
+
+ 2020-09-01 Arathorn
diff --git a/doc/sphinx/props/P_DEPARTMSG.rst b/doc/sphinx/props/P_DEPARTMSG.rst
index 0913c76..266ad28 100644
--- a/doc/sphinx/props/P_DEPARTMSG.rst
+++ b/doc/sphinx/props/P_DEPARTMSG.rst
@@ -17,5 +17,14 @@
------------
::
- Meldung, mit der ein Transporter ablegt.
+ Die Property enthaelt die Meldungen, die beim Verlassen eines
+ Haltepunktes an die Reisenden und an den Haltepunkt-Raum ausgegeben
+ werden. Sie muss ein String-Array mit zwei Elementen enthalten.
+ Fuer den Umbruch muss der Nutzer selbst Sorge tragen.
+
+LETZTE AENDERUNG
+----------------
+::
+
+ 2020-09-01 Arathorn
diff --git a/doc/sphinx/props/P_ENTERFAIL.rst b/doc/sphinx/props/P_ENTERFAIL.rst
index 538b528..7558a93 100644
--- a/doc/sphinx/props/P_ENTERFAIL.rst
+++ b/doc/sphinx/props/P_ENTERFAIL.rst
@@ -18,9 +18,25 @@
::
Meldung an den Spieler, wenn er einen vollen Transporter betreten
- will. Ist die Propertie ein Array, so wird das erste Element als
- Meldung an den Spieler, das zweite als Meldung an die Mitspieler
- im Raum geschickt.
+ will.
+
+ Die Property kann verschiedene Arten von Daten enthalten:
+
+ - Array aus Strings (1 oder 2 Elemente):
+ Das erste Element wird als Meldung an den Spieler ausgegeben. Sofern
+ das zweite vorhanden ist, wird es als Meldung an den Transporter
+ ausgegeben. Der Meldung an den Transporter wird Name(WER,2) des
+ Spielers vorangestellt. An beide Meldungen wird "\n." angehaengt.
+
+ - String:
+ Wird als Meldung an den Spieler ausgegeben, "\n." wird angehaengt.
+
+ - Closure:
+ Die Closure wird gerufen; die Funktion muss sich um die Ausgabe von
+ Meldungen selbst kuemmern.
+ Hinweis: Eine Closure als Wert zu setzen ist nicht dasselbe wie eine
+ Querymethode auf dieser Property.
+
BEISPIEL
--------
@@ -28,12 +44,17 @@
SetProp(P_ENTERFAIL,"Dort ist wirklich kein Platz mehr fuer Dich");
-
-
SetProp(P_ENTERFAIL, ({ "Dort ist wirklich kein Platz mehr fuer Dich",
"versucht, auf die Kutsche zu klettern, wird "
+"aber wieder heruntergeschickt" }) );
+HINWEIS
+-------
+::
+
+ Wenn die Property nicht gesetzt wird, ist die Defaultmeldung
+ "Dort ist kein Platz mehr fuer Dich".
+
SIEHE AUCH
----------
::
@@ -44,5 +65,5 @@
----------------
::
- Don, 24.01.2002, 10:15:07h von Tilly
+ 2020-09-01 Arathorn
diff --git a/doc/sphinx/props/P_ENTERMSG.rst b/doc/sphinx/props/P_ENTERMSG.rst
index 72e5ea4..ad0f0fc 100644
--- a/doc/sphinx/props/P_ENTERMSG.rst
+++ b/doc/sphinx/props/P_ENTERMSG.rst
@@ -17,8 +17,13 @@
------------
::
- Array mit zwei Meldungen, eine fuer den Raum, den der Spieler
- verlaesst, und eine fuer den Transporter, in den er geht.
+ String-Array mit zwei Meldungen, die als Argumente 4 und 5 an move()
+ uebergeben werden, d.h. die erste ist fuer den Raum, den der Spieler
+ verlaesst, und die zweite fuer den Transporter, in den er geht.
+
+ Hat das Array keine zwei Elemente, werden Standardmeldungen ausgegeben,
+ so als waere die Property auf ({"betritt", "kommt herein"}) gesetzt.
+ Die Property hat jedoch keinen Default-Wert.
BEISPIEL
--------
@@ -36,5 +41,4 @@
-----------------
::
- Don, 24.01.2002, 10:15:07h von Tilly
-
+ 2020-09-01 Arathorn
diff --git a/doc/sphinx/props/P_LEAVEFAIL.rst b/doc/sphinx/props/P_LEAVEFAIL.rst
index 9af4941..d25cb02 100644
--- a/doc/sphinx/props/P_LEAVEFAIL.rst
+++ b/doc/sphinx/props/P_LEAVEFAIL.rst
@@ -18,11 +18,24 @@
::
Meldung an den Spieler, wenn er ausserhalb der Anlegezeiten einen
- Transporter verlassen will. Ist die Propertie ein Array, so wird
- das erste Element als Meldung an den Spieler, das zweite als
- Meldung an die Mitspieler im Transporter geschickt. Ist der Eintrag
- dagegen ein simpler String, so wird die Meldung nur an den Spieler
- ausgegeben.
+ Transporter verlassen will.
+
+ Die Property kann verschiedene Arten von Daten enthalten:
+
+ - Array aus Strings (1 oder 2 Elemente):
+ Das erste Element wird als Meldung an den Spieler ausgegeben. Sofern
+ das zweite vorhanden ist, wird es als Meldung an den Transporter
+ ausgegeben. Der Meldung an den Transporter wird Name(WER,2) des
+ Spielers vorangestellt. An beide Meldungen wird "\n." angehaengt.
+
+ - String:
+ Wird als Meldung an den Spieler ausgegeben, "\n." wird angehaengt.
+
+ - Closure:
+ Die Closure wird gerufen; die Funktion muss sich um die Ausgabe von
+ Meldungen selbst kuemmern.
+ Hinweis: Eine Closure als Wert zu setzen ist nicht dasselbe wie eine
+ Querymethode auf dieser Property.
BEISPIEL
--------
@@ -34,7 +47,12 @@
"versucht, vom Ruecken der Wildgans zu "
+"klettern und besinnt sich dann doch" }) );
-
+HINWEIS
+-------
+::
+
+ Wenn die Property nicht gesetzt wird, ist die Defaultmeldung
+ "Das ist momentan viel zu gefaehrlich".
SIEHE AUCH
----------
diff --git a/doc/sphinx/props/P_LEAVEMSG.rst b/doc/sphinx/props/P_LEAVEMSG.rst
index 3253e77..5042624 100644
--- a/doc/sphinx/props/P_LEAVEMSG.rst
+++ b/doc/sphinx/props/P_LEAVEMSG.rst
@@ -17,8 +17,13 @@
------------
::
- Array mit zwei Meldungen. Der erste Eintrag wird an den Transporter
- ausgegeben, der zweite an den Raum in den der Spieler kommt.
+ String-Array mit zwei Meldungen, die als Argumente 4 und 5 an move()
+ uebergeben werden, d.h. die erste ist fuer den Transporter, den der
+ Spieler verlaesst, und die zweite fuer den Raum, in den er geht.
+
+ Hat das Array keine zwei Elemente, werden Standardmeldungen ausgegeben,
+ so als waere die Property auf ({"verlaesst", "kommt herein"}) gesetzt.
+ Die Property hat jedoch keinen Default-Wert.
BEISPIEL
--------
@@ -27,12 +32,13 @@
SetProp(P_LEAVEMSG, ({ "klettert vom Ruecken der Wildgans",
"kommt vom Ruecken einer Wildgans herunter" }) );
-SIEHE AUCH:
+SIEHE AUCH
+----------
+::
P_ENTERMSG, P_LEAVEFAIL, P_ENTERFAIL, transporter
LETZTE AENDERUNG
----------------
::
-
- Don, 24.01.2002, 10:15:07h von Tilly
+ 2020-09-01 Arathorn