Update der Dokumentation
Change-Id: Icdfcbbcbb3b82bfa4abc4e1c60d961e3edea4a5d
diff --git a/doc/help/syntax b/doc/help/syntax
index 88da7cb..7b1a857 100644
--- a/doc/help/syntax
+++ b/doc/help/syntax
@@ -54,6 +54,6 @@
> grinse /was-neues-was-auch-nicht-in-der-"adverb"-Liste-steht
SIEHE AUCH:
- syntaxhinweis, verben, adverb, idee
+ syntaxhilfe, syntaxhinweis, verben, adverb, idee
Letzte Aenderung: 16.06.2017, Bugfix
diff --git a/doc/lfun/AddMoney b/doc/lfun/AddMoney
index e90846d..8f15cc6 100644
--- a/doc/lfun/AddMoney
+++ b/doc/lfun/AddMoney
@@ -16,8 +16,7 @@
DEFINIERT IN
============
- /std/container/moneyhandler.c
- /std/living/moneyhandler.c
+ /std/container/moneyhandler.c /std/living/moneyhandler.c
/std/player/moneyhandler.c
@@ -25,48 +24,46 @@
=========
int amount
- Die zufuehrende oder abziehende Geldmenge
+ Die zufuehrende oder abziehende Geldmenge
BESCHREIBUNG
============
- Dem Spieler wird die in <amount> festgelegte Geldmenge abgezogen oder
- zugefuehrt.
+ Dem Spieler wird die in <amount> festgelegte Geldmenge abgezogen
+ oder zugefuehrt.
RUeCKGABEWERT
=============
Technisch gesehen wird Geld mit entsprechendem <amount> erzeugt
- ("/items/money.c") und mittels "move" in den Spieler bewegt. Das Ergebnis
- dieses "move"-Aufrufes wird hier uebergeben, z.B. 1 fuer OK.
- Die moeglichen Fehler-Konstanten sind in /sys/moving.h definiert, siehe
- auch Dokumentation zu "move".
+ ("/items/money.c") und mittels "move" in den Spieler bewegt. Das
+ Ergebnis dieses "move"-Aufrufes wird hier uebergeben, z.B. 1 fuer
+ OK. Die moeglichen Fehler-Konstanten sind in /sys/moving.h
+ definiert, siehe auch Dokumentation zu "move".
BEMERKUNGEN
===========
- <amount> kann sowohl positiv als auch negativ sein. Welche Auswirkungen
- beide Faelle haben, sollte klar sein. Doch sollte bei einem negativen
- <amount> vorher mittels QueryMoney() abgefragt werden, ob der Spieler
- auch ueber ausreichend Geld verfuegt.
- Wird dem Spieler Geld abgezogen, ist darauf zu achten, dieses in der
- Zentralbank einzuzahlen (s.a.:PayIn() ).
- Verschafft man dem Spieler Geld aus dem Nichts, muss es vorher bei der
- Zentralbank abgebucht (WithDraw()) werden.
+ <amount> kann sowohl positiv als auch negativ sein. Welche
+ Auswirkungen beide Faelle haben, sollte klar sein. Doch sollte bei
+ einem negativen <amount> vorher mittels QueryMoney() abgefragt
+ werden, ob der Spieler auch ueber ausreichend Geld verfuegt. Wird
+ dem Spieler Geld abgezogen, ist darauf zu achten, dieses in der
+ Zentralbank einzuzahlen (s.a.:PayIn() ). Verschafft man dem Spieler
+ Geld aus dem Nichts, muss es vorher bei der Zentralbank abgebucht
+ (WithDraw()) werden.
Achtung: Kann der Spieler die in <amount> angebene Geldmenge nicht
- tragen, werden ihm keine Muenzen in sein Inventar bewegt. Die
- Fehlermeldung erkennt man an dem Rueckgabewert ME_TOO_HEAVY.
+ tragen, werden ihm keine Muenzen in sein Inventar bewegt. Die
+ Fehlermeldung erkennt man an dem Rueckgabewert ME_TOO_HEAVY.
- Im Gegensatz zu Spielern haben alle anderen Objekte (Raeume, NPC, etc.)
- standardmaessig keinen Moneyhandler. In diesem Fall muss in Lebewesen
- "/std/living/moneyhandler"
- und in nicht-Lebewesen
- "/std/container/moneyhandler"
- geerbt werden.
+ Im Gegensatz zu Spielern haben alle anderen Objekte (Raeume, NPC,
+ etc.) standardmaessig keinen Moneyhandler. In diesem Fall muss in
+ Lebewesen "/std/living/moneyhandler" und in nicht-Lebewesen
+ "/std/container/moneyhandler" geerbt werden.
BEISPIELE
@@ -89,10 +86,9 @@
SIEHE AUCH
==========
- Geldhandling: QueryMoney(L)
- Zentralbank: PayIn(L), WithDraw(L)
- Sonstiges: move(L),
- /items/money.c, /sys/moving.h, /sys/money.h, /sys/bank.h
- /std/container/moneyhandler.c
+ Geldhandling: QueryMoney(L) Zentralbank: PayIn(L),
+ WithDraw(L) Sonstiges: move(L), /items/money.c,
+ /sys/moving.h, /sys/money.h, /sys/bank.h
+ /std/container/moneyhandler.c
18.02.2013, Zesstra
diff --git a/doc/lfun/NotifyInsert b/doc/lfun/NotifyInsert
index fa2f2ac..5ae2070 100644
--- a/doc/lfun/NotifyInsert
+++ b/doc/lfun/NotifyInsert
@@ -35,7 +35,7 @@
===========
Diese Funktion wird nur im Falle unbelebter Objekte gerufen. Fuer
- Lebewesen s. bitte. init().
+ Lebewesen siehe init().
SIEHE AUCH
diff --git a/doc/lfun/QueryOwn b/doc/lfun/QueryOwn
index 22e9e5f..6179f38 100644
--- a/doc/lfun/QueryOwn
+++ b/doc/lfun/QueryOwn
@@ -39,7 +39,7 @@
=========
printf("%s %s loest sich auf.\n",
- capitalize(obj->QueryOwn(WER)),obj->name(WER));
+ capitalize(obj->QueryOwn(WER)),obj->name(RAW));
(In den meisten Faellen kann man hier auch direkt "Dein" oder "Deine"
einsetzen.)
diff --git a/doc/lfun/SearchPath b/doc/lfun/SearchPath
index 040965e..ec15b5f 100644
--- a/doc/lfun/SearchPath
+++ b/doc/lfun/SearchPath
@@ -14,7 +14,7 @@
============
/p/daemon/pathd.c
- <sys/path.d>
+ <sys/pathd.h>
ARGUMENTE
diff --git a/doc/lfun/short b/doc/lfun/short
index f7bb169..c446d1c 100644
--- a/doc/lfun/short
+++ b/doc/lfun/short
@@ -24,30 +24,40 @@
BESCHREIBUNG
============
- Der Inhalt der Property P_SHORT wird ausgewertet, mit ".\n"
+ Der Inhalt der Property P_SHORT wird ausgewertet, mit ".n"
abgeschlossen und zurueckgegeben.
+ Durch Ueberladen von short() lassen sich ggf. weitere Eigenschaften
+ des Objektes zeigen. Fackeln zeigen zum Beispiel an, ob sie
+ brennen, Ruestungen, ob sie angezogen sind und Waffen, ob sie
+ gezueckt sind.
+
+ In jedem Fall muss die Kurzbeschreibung aber *kurz* sein, empfohlen
+ werden max. 60 Zeichen.
+
RUeCKGABEWERT
=============
- Die Kurzbeschreibung als String oder 0, falls das Objekt unsichtbar
- ist.
+ Die Kurzbeschreibung als String oder 0, falls das Objekt nicht
+ wahrnehmbar ist (d.h. nicht in Inventaren angezeigt wird).
BEMERKUNGEN
===========
- Durch Ueberladen von short() lassen sich noch weitere Eigenschaften des
- Objektes zeigen. Fackeln zeigen zum Beispiel an, ob sie brennen,
- Ruestungen, ob sie angezogen sind und Waffen, ob sie gezueckt sind.
+ Zu der mit dem Rueckgabewert von 0 vermittelten Unsichtbarkeit s.
+ P_SHORT.
SIEHE AUCH
==========
- Aehnliches: long()
- Properties: P_SHORT, P_INVIS
- Sonstiges: make_invlist()
+ Aehnliches
+ long()
-20.01.2015, Zesstra
+ Properties
+ P_SHORT, P_INVIS, P_INT_SHORT
+
+Letzte Aenderung:
+ 18.06.2020, Zesstra
diff --git a/doc/lfun/show_notify b/doc/lfun/show_notify
index 0ce99ac..9d42c15 100644
--- a/doc/lfun/show_notify
+++ b/doc/lfun/show_notify
@@ -2,7 +2,7 @@
show_notify()
*************
-give_notify()
+show_notify()
FUNKTION
diff --git a/doc/pcmd/syntaxhinweis b/doc/pcmd/syntaxhinweis
index 41d04c7..0086cb8 100644
--- a/doc/pcmd/syntaxhinweis
+++ b/doc/pcmd/syntaxhinweis
@@ -35,6 +35,6 @@
Meldung fuer Deinen momentanen Raum abgesetzt.
SIEHE AUCH:
- bug, idee, typo, detail, bezugsobjekt
+ syntaxhilfe, bug, idee, typo, detail, bezugsobjekt
Letzte Aenderung: 12.06.2019, Zesstra
diff --git a/doc/props/P_INVIS b/doc/props/P_INVIS
index 4063546..5609c84 100644
--- a/doc/props/P_INVIS
+++ b/doc/props/P_INVIS
@@ -6,7 +6,8 @@
NAME
====
- P_INVIS "invis"
+ P_INVIS
+ "invis"
DEFINIERT IN
@@ -18,48 +19,36 @@
BESCHREIBUNG
============
- Die Property P_INVIS dient dazu, Objekte als unsichtbar zu kennzeichnen.
- Hierbei versucht P_INVIS die moeglichen Interaktionen mit Spielern zu
- minimieren (im Gegensatz zu einer fehlenden P_SHORT, welche das Objekt
- nur einfach nicht-sichtbar macht).
-
-
+ Die Property P_INVIS dient dazu, Objekte als nicht wahrnehmbar
+ ('unsichtbar') zu kennzeichnen. Diese Unsichtbarkeit erstreckt sich
+ auch auf andere Sinne als nur 'Sehen'. Hierbei versucht P_INVIS
+ auch die moeglichen Interaktionen mit Spielern zu minimieren (im
+ Gegensatz zu einer fehlenden P_SHORT, welche das Objekt nur
+ 'verschleiert' bzw. nicht mehr in Inventaren anzeigt).
Man sollte drei Arten von unsichtbaren Objekten unterscheiden:
- - Gegenstaende
- Setzt man P_INVIS auf eine Zahl ungleich 0, wird der Gegenstand
- unsichtbar und der Name zu "etwas". Zusaetzlich koennen Spieler ihn
- nicht mehr ansprechen, d.h. nehmen, wegwerfen, weitergeben etc.
- (Bei magier-eigenen Kommandos ist dies evtl. nicht umgesetzt...)
- Setzt man P_SHORT auf 0, wird der Gegenstand nur nicht mehr in
- der Inventarliste von Behaeltern/Raeumen angezeigt, er behaelt aber
- seinen Namen und ist durch Spieler ansprechbar, wenn sie eine ID
- kennen.
+ Gegenstaende
+ Setzt man P_INVIS auf 1, wird der Gegenstand unsichtbar und der
+ Name zu "etwas". Zusaetzlich koennen Spieler ihn nicht mehr
+ ansprechen, d.h. nehmen, wegwerfen, weitergeben etc. (Bei
+ magier-eigenen Kommandos ist dies evtl. nicht umgesetzt...)
- - NPCs
- Bei gesetztem P_INVIS wird der NPC unsichtbar und sein Name wird zu
- "Jemand". Zusaetzlich koennen Spieler ihn nicht mehr ansprechen, z.B.
- toeten oder knuddeln.
- (Bei magier-eigenen Kommandos ist dies evtl. nicht umgesetzt...)
- Setzt man P_SHORT auf 0, wird der NPC nur nicht mehr in der
- Inventarliste von Behaeltern/Raeumen angezeigt, er behaelt aber seinen
- Namen und ist durch Spieler ansprechbar, wenn sie eine ID kennen. Auch
- angreifen und kaempfen ist moeglich.
+ NPCs
+ Bei gesetztem P_INVIS wird der NPC unsichtbar und sein Name wird
+ zu "Jemand". Zusaetzlich koennen Spieler ihn nicht mehr
+ ansprechen, z.B. toeten oder knuddeln. (Bei magier-eigenen
+ Kommandos ist dies evtl. nicht umgesetzt...)
+ Magier
+ Magier macht man unsichtbar, indem man ihnen die Property
+ P_INVIS auf einen Wert <> 0 setzt. Dieser muss dem Wert von
+ P_AGE zu diesem Zeitpunkt entsprechen (keine F_QUERY_METHOD!).
+ Spieler duerfen **nicht** unsichtbar gemacht werden! Setzt man
+ die Property auf den Wert 1, so erhaelt ein Spieler, wenn er den
+ entsp. Magier fingert, die Ausgabe: Alter: 00:00:02, was genauso
+ verraeterisch ist, wie ein Alter, dass bei einem scheinbar nicht
+ eingeloggten Magier immer weiter hochgezaehlt wird.
-
- - Magier
- Magier macht man unsichtbar, indem man ihnen die Property P_INVIS auf
- einen Wert <> 0 setzt.
- * Spieler duerfen nicht unsichtbar gemacht werden! *
- * Wird ein Magier unsichtbar gemacht, muss man ihm die Property *
- * P_INVIS auf den Wert setzen, den die Property P_AGE zu diesem *
- * Zeitpunkt hat (keine F_QUERY_METHOD !). *
- Setzt man die Property auf den Wert 1, so erhaelt ein Spieler,
- wenn er den entsp. Magier fingert, die Ausgabe: Alter: 00:00:02,
- was genauso verraeterisch ist, wie ein Alter, dass bei einem
- scheinbar nicht eingeloggten Magier immer weiter hochgezaehlt
- wird.
-
-27.05.2015, Zesstra
+Letzte Aenderung:
+ 27.05.2015, Zesstra
diff --git a/doc/props/P_SHORT b/doc/props/P_SHORT
index 8c20a87..7b65025 100644
--- a/doc/props/P_SHORT
+++ b/doc/props/P_SHORT
@@ -6,7 +6,8 @@
NAME
====
- P_SHORT "short"
+ P_SHORT
+ "short"
DEFINIERT IN
@@ -18,32 +19,39 @@
BESCHREIBUNG
============
- Diese Property enthaelt die Kurzbeschreibung des Objektes als String
- oder Closure (diese muss einen String zurueckgeben).
+ Diese Property enthaelt die Kurzbeschreibung eines Objektes bei
+ Ansicht *von aussen* als String. Fuer die Innen(kurz)ansicht von
+ Raeumen muss man P_INT_SHORT benutzen.
- ACHTUNG: Die Kurzbeschreibung sollte dabei nicht mit einem "\n"
- abgeschlossen sein (dies wird von den zustaendigen Funktionen
- erledigt).
- Aus historischen Gruenden wird ein Punkt ergaenzt, wenn das letzte
+ Die Kurzbeschreibung darf *nicht* mit einem "n" abgeschlossen sein
+ (dies wird von den zustaendigen Funktionen erledigt). Aus
+ historischen Gruenden wird ein Punkt ergaenzt, wenn das letzte
Zeichen kein Punkt, Ausrufezeichen oder Fragezeichen ist.
- Setzt man diese Property auf 0, so ist das Objekt unsichtbar, allerdings
- ansprechbar, wenn der Spieler eine ID des Objektes kennt. D.h. Objekte
- koennen mitgenommen, weggeworfen oder ggf. auch angegriffen werden. Will
- man dies nicht, sollte man das Objekt mit P_INVIS unsichtbar machen.
-
- Diese Property bestimmt die Ansicht des Objektes von aussen. Fuer die
- Innen(kurz)ansicht von Raeumen muss man P_INT_SHORT benutzen.
+ Setzt man diese Property auf 0, so wird das Objekt von Spielern
+ nicht mehr wahrgenommen (es wird in Inventaren nicht mehr
+ angezeigt). Der Effekt ist der eines "PAL-Feldes" ("Problem anderer
+ Leute"). Es bleibt allerdings ansprechbar, wenn Spieler eine ID des
+ Objektes kennen. Diese koennen dann damit alles anstellen, was sie
+ sonst auch koennten. D.h. Objekte koennen insb. mitgenommen,
+ weggeworfen, untersucht oder ggf. auch angegriffen werden und es
+ kann angreifen. Will man dies nicht, muss man das Objekt mit
+ P_INVIS richtig unsichtbar machen.
BEMERKUNGEN
===========
- Die Funktion, die die Kurzbeschreibung ausgibt (short()), filtert P_SHORT
- durch process_string(). Von der Nutzung dieses Features wird in neuem
- Code abgeraten.
- Soll eine dyn. Kurzbeschreibung geschaffen werden, bitte eine
- F_QUERY_METHOD einsetzen oder short() passend ueberschreiben.
+ * In altem Code wird manchmal eine Closure als Wert (nicht als
+ Querymethode) eingetragen, welche einen String zurueckgibt. Dies
+ ist *deprecated* und sollte nicht mehr formuliert werden.
+
+ * Die Funktion, die die Kurzbeschreibung ausgibt (short()),
+ filtert P_SHORT durch process_string(). Dieses Feature ist
+ *deprecated* und von der Nutzung wird in neuem Code abgeraten.
+
+ * Soll eine dyn. Kurzbeschreibung geschaffen werden, bitte eine
+ F_QUERY_METHOD einsetzen oder short() passend ueberschreiben.
BEISPIELE
@@ -56,7 +64,7 @@
SIEHE AUCH
==========
- Aehnliches: P_LONG, short()
- Sonstiges: P_INT_SHORT, process_string()
+ Aehnliches
+ P_LONG, P_INT_SHORT, P_INVIS, short()
-27.05.2015, Zesstra
+13.06.2020, Zesstra
diff --git a/doc/sphinx/lfun/AddMoney.rst b/doc/sphinx/lfun/AddMoney.rst
index a0119d4..416bdee 100644
--- a/doc/sphinx/lfun/AddMoney.rst
+++ b/doc/sphinx/lfun/AddMoney.rst
@@ -3,17 +3,14 @@
AddMoney(L)
-----------
-::
FUNKTION
--------
-::
public int AddMoney(int amount);
DEFINIERT IN
------------
-::
/std/container/moneyhandler.c
/std/living/moneyhandler.c
@@ -21,21 +18,18 @@
ARGUMENTE
---------
-::
int amount
Die zufuehrende oder abziehende Geldmenge
BESCHREIBUNG
------------
-::
Dem Spieler wird die in <amount> festgelegte Geldmenge abgezogen oder
zugefuehrt.
RUeCKGABEWERT
-------------
-::
Technisch gesehen wird Geld mit entsprechendem <amount> erzeugt
("/items/money.c") und mittels "move" in den Spieler bewegt. Das Ergebnis
@@ -45,7 +39,6 @@
BEMERKUNGEN
-----------
-::
<amount> kann sowohl positiv als auch negativ sein. Welche Auswirkungen
beide Faelle haben, sollte klar sein. Doch sollte bei einem negativen
@@ -69,7 +62,8 @@
BEISPIELE
---------
-::
+
+.. code-block:: pike
#include <zentralbank.h>
@@ -86,13 +80,12 @@
SIEHE AUCH
----------
-::
Geldhandling: QueryMoney(L)
Zentralbank: PayIn(L), WithDraw(L)
Sonstiges: move(L),
- /items/money.c, /sys/moving.h, /sys/money.h, /sys/bank.h
- /std/container/moneyhandler.c
+ /items/money.c, /sys/moving.h, /sys/money.h, /sys/bank.h
+ /std/container/moneyhandler.c
18.02.2013, Zesstra
diff --git a/doc/sphinx/lfun/NotifyInsert.rst b/doc/sphinx/lfun/NotifyInsert.rst
index ee01336..f9f0836 100644
--- a/doc/sphinx/lfun/NotifyInsert.rst
+++ b/doc/sphinx/lfun/NotifyInsert.rst
@@ -34,7 +34,7 @@
::
Diese Funktion wird nur im Falle unbelebter Objekte gerufen. Fuer
- Lebewesen s. bitte. init().
+ Lebewesen siehe init().
SIEHE AUCH
----------
diff --git a/doc/sphinx/lfun/QueryOwn.rst b/doc/sphinx/lfun/QueryOwn.rst
index 50e7bdf..052a827 100644
--- a/doc/sphinx/lfun/QueryOwn.rst
+++ b/doc/sphinx/lfun/QueryOwn.rst
@@ -38,7 +38,7 @@
::
printf("%s %s loest sich auf.\n",
- capitalize(obj->QueryOwn(WER)),obj->name(WER));
+ capitalize(obj->QueryOwn(WER)),obj->name(RAW));
(In den meisten Faellen kann man hier auch direkt "Dein" oder "Deine"
einsetzen.)
diff --git a/doc/wiz/rm-howto b/doc/wiz/rm-howto
index 8f2730b..63c9a84 100644
--- a/doc/wiz/rm-howto
+++ b/doc/wiz/rm-howto
@@ -143,6 +143,9 @@
-- im Gebiet vorhandene Seherhaeuser umziehen, an P_SEHERHAUS_ERLAUBT im
Zielraum denken
-- evtl. im Gebiet vorhandene Kraeuterskill-Kraeuter beruecksichtigen
+ -- evtl. vorhandene Autoload-Objekte pruefen; in einfachen Faellen kann
+ man ein Wrapper-Objekt erstellen, das das alte beim Clonen durch das
+ neue ersetzt.
-- evtl. Briefempfaenger der Postquest beruecksichtigen,
-- ueber die Mudlib greppen lassen, um eventuell in anderen Regionen
verwendete Referenzen auf die alten Pfade des umziehenden Codes