Dokumentations-Update
Change-Id: I302332f32e9a6e0e67a837a1feee7939feea3028
diff --git a/doc/lfun/CannotSee b/doc/lfun/CannotSee
index b86d33a..50c43eb 100644
--- a/doc/lfun/CannotSee
+++ b/doc/lfun/CannotSee
@@ -18,27 +18,30 @@
ARGUMENTE
=========
- silent - Soll an das Lebewesen direkt automatisch eine Meldung
- ausgegeben werden wenn es nichts sehen kann?
+ silent - Wenn ungleich 0, wird an das Lebewesen keine Meldung
+ ausgegeben, wenn es nichts sehen kann.
BESCHREIBUNG
============
- Diese Funktion prueft ob das Lebewesen etwas sehen kann, oder nicht.
- Hierbei wird sowohl das Lichtlevel mit saemtlichen Modifikatoren,
- als auch Nachtsicht und die Property P_BLIND beruecksichtigt. Da
- diese Funktion bei zukuenftigen Mudlibaenderungen immer aktualisiert
- werden duerfte, sollte man sie nach Moeglichkeit benutzen und die
- Abfragen nicht selbst implementieren.
+ Diese Funktion prueft, ob das Lebewesen etwas sehen kann oder nicht.
+ Hierbei werden sowohl das Lichtlevel mit saemtlichen Modifikatoren,
+ als auch Nachtsicht und die Property P_BLIND beruecksichtigt.
+
+ Wenn die Funktion ohne Argument aufgerufen wird, wird eine Meldung an
+ das Lebewesen ausgegeben, falls es blind ist. Diese Meldung ist entweder
+ der Inhalt von P_BLIND, sofern dort ein String eingetragen ist, oder
+ aber die Standardmeldung "Du bist blind.".
RUeCKGABEWERT
=============
- 0, wenn der Spieler etwas sehen kann
- 1, wenn der Spieler nichts sehen kann: Blindheit
- 2, wenn der Spieler nichts sehen kann: zu wenig Licht/keine Nachtsicht
+ 0, wenn das Lebewesen etwas sehen kann
+ 1, wenn das Lebewesen wegen Blindheit nichts sehen kann
+ 2, wenn das Lebewesen wegen zu wenig Licht bzw. mangels Nachtsicht nichts
+ sehen kann
SIEHE AUCH
@@ -46,4 +49,4 @@
P_BLIND, P_LIGHT_MODIFIER, P_PLAYER_LIGHT
-Last modified: Mon Jan 17 18:22:27 2000 by Padreic
+Last modified: 2022-11-23 Arathorn
diff --git a/doc/lfun/HIsHookConsumer b/doc/lfun/HIsHookConsumer
new file mode 100644
index 0000000..b45b816
--- /dev/null
+++ b/doc/lfun/HIsHookConsumer
@@ -0,0 +1,47 @@
+
+HIsHookConsumer()
+*****************
+
+
+FUNKTION
+========
+
+ int HIsHookConsumer(int hookid, object|closure consumer)
+
+
+DEFINIERT IN
+============
+
+ /std/hook_provider.c /sys/hook.h
+
+
+ARGUMENTE
+=========
+
+ * hookid: gibt den Hook-Typ an
+
+ * consumer: Objekt oder Closure. Wenn ein Objekt uebergeben wird,
+ wird eine Closure auf HookCallback() an diesem Objekt erstellt.
+
+
+BESCHREIBUNG
+============
+
+ Prueft, ob eine Closure als consumer fuer einen bestimmten Hook
+ eingetragen ist.
+
+
+RUECKGABEWERTE
+==============
+
+ 1 : Closure ist als consumer registriert
+
+ 0 : Closure nicht als Konsument gefunden
+
+
+SIEHE AUCH
+==========
+
+ HRegisterToHook(), HUnregisterFromHook(), HookCallback()
+
+Letzte Aenderung: 08.10.2022, Bugfix
diff --git a/doc/lfun/HListHooks b/doc/lfun/HListHooks
new file mode 100644
index 0000000..6578c94
--- /dev/null
+++ b/doc/lfun/HListHooks
@@ -0,0 +1,64 @@
+
+HListHooks()
+************
+
+
+FUNKTION
+========
+
+ int* HListHooks()
+
+
+DEFINIERT IN
+============
+
+ /std/hook_provider.c /sys/hook.h
+
+
+ARGUMENTE
+=========
+
+ keine
+
+
+BESCHREIBUNG
+============
+
+ Diese Methode liefert eine Liste von Hooktypen, fuer die das Objekt
+ Registrierungen akzeptiert. Standardmaessig bieten die Mudlib-
+ Basis- objekte folgende Hooks an: Spielerobjekte: H_HOOK_MOVE,
+ H_HOOK_DIE, H_HOOK_DEFEND, H_HOOK_ATTACK,
+
+ H_HOOK_HP, H_HOOK_SP, H_HOOK_ATTACK_MOD, H_HOOK_ALCOHOL
+ H_HOOK_FOOD, H_HOOK_DRINK, H_HOOK_POISON, H_HOOK_CONSUME,
+ H_HOOK_TEAMROWCHANGE ,H_HOOK_INSERT
+
+ NPCs: H_HOOK_MOVE, H_HOOK_DIE, H_HOOK_DEFEND, H_HOOK_ATTACK,
+ H_HOOK_ATTACK_MOD, H_HOOK_ALCOHOL, H_HOOK_FOOD, H_HOOK_DRINK,
+ H_HOOK_POISON, H_HOOK_CONSUME, H_HOOK_TEAMROWCHANGE
+
+ Raeume: H_HOOK_EXIT_USE, H_HOOK_INIT Dinge: keine
+
+
+RUECKGABEWERTE
+==============
+
+ Integer-Array der angebotenen Hook-IDs
+
+
+BEISPIEL
+========
+
+ // Bietet das Objekt einen Consume-Hook an?
+ if(H_HOOK_CONSUME in ob->HListHooks())
+ {
+ do_something();
+ }
+
+
+SIEHE AUCH
+==========
+
+ HRegisterToHook(), HUnregisterFromHook(), HIsHookConsumer()
+
+Letzte Aenderung: 06.10.2022, Bugfix
diff --git a/doc/lfun/HRegisterToHook b/doc/lfun/HRegisterToHook
new file mode 100644
index 0000000..3a26017
--- /dev/null
+++ b/doc/lfun/HRegisterToHook
@@ -0,0 +1,116 @@
+
+HRegisterToHook()
+*****************
+
+
+FUNKTION
+========
+
+ int HRegisterToHook(int hookid, object|closure consumer, int
+ hookprio,
+ int consumertype, int timeInSeconds)
+
+
+DEFINIERT IN
+============
+
+ /std/hook_provider.c /sys/hook.h
+
+
+ARGUMENTE
+=========
+
+ * hookid: gibt den Hook-Typ an Man kann sich nur fuer Hooktypen
+ eintragen, die die Methode HListHooks() angeboten hat.
+
+ * consumer: Objekt oder Closure. Wenn ein Objekt uebergeben wird,
+ wird eine Closure auf HookCallback() an diesem Objekt erstellt
+ und gespeichert, andernfalls wird die uebergebene Closure
+ gespeichert. Diese Closure wird spaeter beim Ausloesen des Hooks
+ aufgerufen.
+
+ * hookprio: Gibt die Prioritaet an, mit der der Hook laufen soll.
+ Diese Angabe bestimmt die Reihenfolge, in der die Hooks in der
+ Liste der Hooks eingetragen werden. Siehe Abschnitt Beschreibung
+ fuer Details.
+
+ * consumertype: Gibt an, um welche Art von Consumer es sich
+ handelt.
+
+ * timeInSeconds: gibt die Laufzeit des Hooks an. Falls 0
+ eingetragen wird, laeuft der Hook ewig.
+
+
+BESCHREIBUNG
+============
+
+ Registriert ein Objekt oder eine Closure als Hook-Konsument.
+
+ Die Callback-Methode wird mit folgenden Argumenten gerufen:
+
+ * object hooksource: das Objekt, in welchem das Ereignis
+ ausgeloest wurde
+
+ * int hookid: die ID des Hooks
+
+ * mixed hookdata: die Daten des Hooks (siehe Doku zum jeweiligen
+ Hook)
+
+ Fuer hookprio sind folgende Werte vorgesehen (Konstanten aus
+ hook.h):
+
+ * H_HOOK_LIBPRIO(x)
+
+ * H_HOOK_GUILDPRIO(x) oder
+
+ * H_HOOK_OTHERPRIO(x).
+
+ x darf 0, 1 oder 2 sein (je niedriger, desto hoeher die
+ Prioritaet).
+
+ Fuer consumertype gibt es vier festgelegte Arten, die fuer alle
+ Hooks existieren koennen, aber nicht muessen (Konstanten aus
+ hook.h):
+
+ * H_LISTENER: Wird nur informiert
+
+ * H_DATA_MODIFICATOR: Kann Daten des Ereignisses aendern
+
+ * H_HOOK_MODIFICATOR: Kann das Ereignis zusaetzlich abbrechen
+
+ * H_HOOK_SURVEYOR: Kann zusaetzlich entscheiden, ob sich Objekte
+ registrieren, Daten modifizieren oder Ereignisse abbrechen
+ koennen
+
+ Die Methode *HConsumerTypeIsAllowed* gibt Aufschluss darueber,
+ welche Consumer-Typen tatsaechlich freigegeben sind.
+
+
+RUECKGABEWERTE
+==============
+
+ 1 : Registrierung erfolgreich
+
+ -1 : Hook unbekannt
+
+ -2 : consumer ist keine closure und es konnte kein Callback auf
+ HookCallback im consumer erstellt werden.
+
+ -3 : Consumer ist bereits registriert
+
+ -4 : Consumer-Typ ist nicht erlaubt
+
+ -5 : hookprio ist nicht erlaubt
+
+ -6 : Surveyor hat Registrierung nicht erlaubt
+
+ -7 : zuviele Hooks registriert / kein Hookeintrag frei
+
+
+SIEHE AUCH
+==========
+
+ HUnregisterFromHook(), HookCallback(), HListHooks(),
+ HIsHookConsumer()
+
+Letzte Aenderung: 05.10.2022, Bugfix
diff --git a/doc/lfun/HUnregisterFromHook b/doc/lfun/HUnregisterFromHook
new file mode 100644
index 0000000..7933312
--- /dev/null
+++ b/doc/lfun/HUnregisterFromHook
@@ -0,0 +1,47 @@
+
+HUnregisterFromHook()
+*********************
+
+
+FUNKTION
+========
+
+ int HUnregisterFromHook(int hookid, object|closure consumer)
+
+
+DEFINIERT IN
+============
+
+ /std/hook_provider.c /sys/hook.h
+
+
+ARGUMENTE
+=========
+
+ * hookid: gibt den Hook-Typ an
+
+ * consumer: Objekt oder Closure. Wenn ein Objekt uebergeben wird,
+ wird eine Closure auf HookCallback() an diesem Objekt erstellt
+ und versucht diese auszutragen, andernfalls wird versuchtdie
+ uebergebene Closure ausgetragen.
+
+
+BESCHREIBUNG
+============
+
+ Hebt die Registrierung von <consumer> fuer einen bestimmten Hook-
+ Typ wieder auf.
+
+
+RUECKGABEWERTE
+==============
+
+ 1 : Austragen erfolgreich 0 : consumer nicht als Konsument gefunden
+
+
+SIEHE AUCH
+==========
+
+ HRegisterToHook(), HookCallback(), HIsHookConsumer()
+
+Letzte Aenderung: 06.10.2022, Bugfix
diff --git a/doc/lfun/HasAutoloader b/doc/lfun/HasAutoloader
index e3eea7e..0a58f2d 100644
--- a/doc/lfun/HasAutoloader
+++ b/doc/lfun/HasAutoloader
@@ -1,3 +1,4 @@
+
HasAutoloader()
***************
@@ -34,10 +35,15 @@
RUeCKGABEWERT
=============
- 1 wenn der Spieler den Autoloader eingelagert hat
- 0 wenn nicht
- -1 wenn Unfug uebergeben wurde, der Spieler keine Truhe besitzt
- oder die Funktion nicht in der Blueprint aufgerufen wurde
+ 1
+ wenn der Spieler den Autoloader eingelagert hat
+
+ 0
+ wenn nicht
+
+ -1
+ wenn Unfug uebergeben wurde, der Spieler keine Truhe besitzt
+ oder die Funktion nicht in der Blueprint aufgerufen wurde
HINWEIS
diff --git a/doc/lfun/HookCallback b/doc/lfun/HookCallback
new file mode 100644
index 0000000..b6204b6
--- /dev/null
+++ b/doc/lfun/HookCallback
@@ -0,0 +1,78 @@
+
+HookCallback()
+**************
+
+
+FUNKTION
+========
+
+ mixed HookCallback(object hooksource, int hookid, mixed hookdata)
+
+
+DEFINIERT IN
+============
+
+ Eigenen Objekten
+
+
+ARGUMENTE
+=========
+
+ * hooksource: Das Objekt, in dem das Ereignis ausgeloest wurde
+
+ * hookid: Hooktyp des ausgeloesten Hooks
+
+ * hookdata: Daten des ausgeloesten Hooks (S. Doku des jeweiligen
+ Hooks.)
+
+
+BESCHREIBUNG
+============
+
+ Standard-Callback-Methode fuer Hooks. Wird beim Registrieren ein
+ Objekt uebergeben, wird versucht, eine Closure auf HookCallback()
+ an diesem Objekt zu erstellen. Man kann die Funktion auch anders
+ benennen und direkt als Closure uebergeben. Dies ist insb. bei
+ mehreren Hooks im gleichen Objekt hilfreich, weil es den Code
+ uebersichtlicher macht. Die Argumente muessen jedoch immer die
+ gleichen wie bei HookCallback() sein.
+
+ Die Reihenfolge des Aufrufs der Konsumenten ist Surveyor, Hook-
+ Modifikator, Data-Modifikator, Listener. Innerhalb der Gruppen wird
+ nach Prioritaet abgearbeitet. Ein Surveyor-Hook kann verhindern,
+ dass Hooks bestimmte Aenderungen durchfuehren.
+
+
+RUECKGABEWERTE
+==============
+
+ ({<status>, <hookdata>})
+
+ * Status: Eine der folgenden Konstanten: - H_NO_MOD: keine
+ Veraenderung - H_ALTERED: Daten des Hooks geaendert -
+ H_CANCELLED: Die Ausfuehrung der Hook-Kette und das ausloesende
+
+ Ereignis werden abgebrochen
+
+ Nicht alle Hooks unterstuetzen jeden Status.
+
+ * hookdata: Die ggf. modifizierten Hookdaten. (S. Doku des
+ jeweiligen Hooks.)
+
+
+BEMERKUNGEN
+===========
+
+ Bitte nutzt in neuem code nicht mixed, sondern unions entsprechend
+ der Dokumentation der verwendeten Hooks.
+
+ Auch reine Listener-Objekte muesse nein Array zurueckgeben, dessen
+ erstes Element H_NO_MOD sein muss.
+
+
+SIEHE AUCH
+==========
+
+ HRegisterToHook(), HUnregisterFromHook(), unions
+
+Letzte Aenderung: 06.10.2022, Bugfix
diff --git a/doc/lfun/QueryQuest b/doc/lfun/QueryQuest
index 338ed77..496af27 100644
--- a/doc/lfun/QueryQuest
+++ b/doc/lfun/QueryQuest
@@ -30,7 +30,7 @@
1 : Spieler hat die Quest bereits geloest (OK)
0 : Ungueltiger Questname oder der Spieler
hat die Quest noch nicht. (QQ_KEY_INVALID)
- 2 : Gaeste koennen keine Quest loesen (QQ_QUEST)
+ 2 : Gaeste koennen keine Quest loesen (QQ_GUEST)
BESCHREIBUNG
diff --git a/doc/lfun/ReceiveMsg b/doc/lfun/ReceiveMsg
index 976c8bd..96d01a6 100644
--- a/doc/lfun/ReceiveMsg
+++ b/doc/lfun/ReceiveMsg
@@ -2,8 +2,6 @@
ReceiveMsg()
************
-ReceiveMsg()
-
public varargs int ReceiveMsg(string msg, int msg_typ, string
msg_action,
string msg_prefix, mixed origin)
@@ -240,6 +238,7 @@
benutzt bzw. versucht, die Aktion zu erraten.
MA_PUT Jemand legt etwas hin und gibt jemanden etwas
MA_TAKE Jemand nimmt etwas
+ MA_GIVE Jemand gibt jemandem etwas
MA_MOVE_IN Jemand betritt den Raum
MA_MOVE_OUT Jemand verlaesst den Raum
MA_MOVE Jemand bewegt sich
diff --git a/doc/sphinx/lfun/CannotSee.rst b/doc/sphinx/lfun/CannotSee.rst
index b9fe25b..0779344 100644
--- a/doc/sphinx/lfun/CannotSee.rst
+++ b/doc/sphinx/lfun/CannotSee.rst
@@ -17,27 +17,30 @@
---------
::
- silent - Soll an das Lebewesen direkt automatisch eine Meldung
- ausgegeben werden wenn es nichts sehen kann?
+ silent - Wenn ungleich 0, wird an das Lebewesen keine Meldung
+ ausgegeben, wenn es nichts sehen kann.
BESCHREIBUNG
------------
::
- Diese Funktion prueft ob das Lebewesen etwas sehen kann, oder nicht.
- Hierbei wird sowohl das Lichtlevel mit saemtlichen Modifikatoren,
- als auch Nachtsicht und die Property P_BLIND beruecksichtigt. Da
- diese Funktion bei zukuenftigen Mudlibaenderungen immer aktualisiert
- werden duerfte, sollte man sie nach Moeglichkeit benutzen und die
- Abfragen nicht selbst implementieren.
+ Diese Funktion prueft, ob das Lebewesen etwas sehen kann oder nicht.
+ Hierbei werden sowohl das Lichtlevel mit saemtlichen Modifikatoren,
+ als auch Nachtsicht und die Property P_BLIND beruecksichtigt.
+
+ Wenn die Funktion ohne Argument aufgerufen wird, wird eine Meldung an
+ das Lebewesen ausgegeben, falls es blind ist. Diese Meldung ist entweder
+ der Inhalt von P_BLIND, sofern dort ein String eingetragen ist, oder
+ aber die Standardmeldung "Du bist blind.".
RUeCKGABEWERT
-------------
::
- 0, wenn der Spieler etwas sehen kann
- 1, wenn der Spieler nichts sehen kann: Blindheit
- 2, wenn der Spieler nichts sehen kann: zu wenig Licht/keine Nachtsicht
+ 0, wenn das Lebewesen etwas sehen kann
+ 1, wenn das Lebewesen wegen Blindheit nichts sehen kann
+ 2, wenn das Lebewesen wegen zu wenig Licht bzw. mangels Nachtsicht nichts
+ sehen kann
SIEHE AUCH
----------
@@ -46,5 +49,5 @@
P_BLIND, P_LIGHT_MODIFIER, P_PLAYER_LIGHT
-Last modified: Mon Jan 17 18:22:27 2000 by Padreic
+Last modified: 2022-11-23 Arathorn
diff --git a/doc/sphinx/lfun/HIsHookConsumer.rst b/doc/sphinx/lfun/HIsHookConsumer.rst
index 5f83efb..4c24fa8 100644
--- a/doc/sphinx/lfun/HIsHookConsumer.rst
+++ b/doc/sphinx/lfun/HIsHookConsumer.rst
@@ -29,6 +29,7 @@
--------------
1 : Closure ist als consumer registriert
+
0 : Closure nicht als Konsument gefunden
SIEHE AUCH
diff --git a/doc/sphinx/lfun/QueryQuest.rst b/doc/sphinx/lfun/QueryQuest.rst
index 6ebb184..d1cf06b 100644
--- a/doc/sphinx/lfun/QueryQuest.rst
+++ b/doc/sphinx/lfun/QueryQuest.rst
@@ -29,7 +29,7 @@
1 : Spieler hat die Quest bereits geloest (OK)
0 : Ungueltiger Questname oder der Spieler
hat die Quest noch nicht. (QQ_KEY_INVALID)
- 2 : Gaeste koennen keine Quest loesen (QQ_QUEST)
+ 2 : Gaeste koennen keine Quest loesen (QQ_GUEST)
BESCHREIBUNG
------------