Update der Dokumentation
Change-Id: Icdfcbbcbb3b82bfa4abc4e1c60d961e3edea4a5d
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