P_INTERNAL_EXTRA_LOOK-Dokumentation und Konstanten
* Dokumentation ueberarbeitet und praezisiert
* magic numbers fuer Rueckgabewerte und Schluessel durch
Konstanten in Header/im Code ersetzt
Change-Id: I3d38867f24510ef4fc97d7f3cdf350e169a63ccd
diff --git a/doc/sphinx/props/P_INTERNAL_EXTRA_LOOK.rst b/doc/sphinx/props/P_INTERNAL_EXTRA_LOOK.rst
index bff5353..dd95176 100644
--- a/doc/sphinx/props/P_INTERNAL_EXTRA_LOOK.rst
+++ b/doc/sphinx/props/P_INTERNAL_EXTRA_LOOK.rst
@@ -15,44 +15,55 @@
BESCHREIBUNG
------------
- Diese Property enthaelt ein Mapping, in dem alle einzelnen
- Extra-Look-Eintraege des Livings enthalten sind. Dabei weden die Daten von
- AddExtraLook() und RemoveExtraLook() verwaltet. Fragt man diese Prop mit
- QueryProp() ab, erhaelt man die Ausgabe der gueltigen Extralooks des
- Livings. Bei Abfrage per Query() erhaelt man ein Mapping mit allen
- Eintraegen und deren Daten.
- Der Key ist jeweils die ID des Extralooks, der Value ist erneut ein
- Mapping, welches folgende Keys enthalten kann:
-
- "xllook":
- String, der im Extralook des Living angezeigt wird.
- "xlduration":
- Zeitstempel (int), der angibt, wie lang der Eintrag gueltig
- ist. 0 == "Unendlich", negative Zahlen besagen, dass der Eintrag nur
- bis Reboot/Ende gueltig sein soll und abs(xlduration) ist der Zeitpunkt
- des Eintrages dieses Extralooks.
- "xlende":
- String, der nach Ablaufen an das Living ausgegeben wird.
- "xlfun":
- Funktion, die gerufen wird und den String zurueckliefern muss, der
- ausgegeben werden soll.
- "xlendefun":
- Funktion, die gerufen wird, wenn der Eintrag abgelaufen ist und den
- String zurueckliefern muss, der dann ans Living ausgegeben wird.
- "xlobjectname":
- Objekt, in dem die o.a. Funktionen gerufen werden.
+ Diese Property enthaelt ein Mapping, in dem alle einzelnen
+ Extra-Look-Eintraege des Livings enthalten sind. Dabei weden die Daten von
+ AddExtraLook() und RemoveExtraLook() verwaltet. Fragt man diese Prop mit
+ QueryProp() ab, erhaelt man die Ausgabe der gueltigen Extralooks des
+ Livings. Bei Abfrage per Query() erhaelt man ein Mapping mit allen
+ Eintraegen und deren Daten.
- .. warning::
+ Der Key ist jeweils die ID des Extralooks, der Value ist erneut ein
+ Mapping, welches folgende Keys enthalten kann:
+
+ - "xllook":
+ String, der im Extralook des Living angezeigt wird.
+ - "xlduration":
+ Zeitstempel (int), der angibt, wie lang der Eintrag gueltig
+ ist.
+
+ - 0 ewig gueltig
+ - <0 gueltig bis Ende/Reboot
+ - >0 Gueltig in Sekunden
+
+ - "xlende":
+ String, der nach Ablaufen an das Living ausgegeben wird.
+ - "xlfun":
+ Funktion, die gerufen wird und den String zurueckliefern muss, der
+ ausgegeben werden soll.
+ - "xlendefun":
+ Funktion, die gerufen wird, wenn der Eintrag abgelaufen ist und den
+ String zurueckliefern muss, der dann ans Living ausgegeben wird.
+ - "xlobjectname":
+ Objekt, in dem die o.a. Funktionen gerufen werden.
+
+BEMERKUNGEN:
+------------
+
+ .. warning::
- DIESE PROPERTY BITTE **NIEMALS** PER HAND MIT Set()/SetProp() AENDERN!
- Die Daten in dieser Prop werden vom Living selber verwaltet. Extralooks
- koennen mittel AddExtraLook() eingetragen und mit RemoveExtraLook() entfernt
- werden.
+ Keine echte Property. Die Methode _query_internal_extralook() in /std/living/description.c stellt die Daten zusammen.
+
+ .. warning::
+
+ ACHTUNG: Bitte nur die bereitgestellten Methoden zur Manipulation benutzen! Setzen als Property hat keinen Effekt.
SIEHE AUCH
----------
- - :doc:`../lfun/long`
- - /std/living/description.c, /std/player/base.c
- - :doc:`../lfun/AddExtraLook`, :doc:`../lfun/RemoveExtraLook`
+ Verwandt:
+ :doc:`../lfun/AddExtraLook`, :doc:`../lfun/RemoveExtraLook`
+ :doc:`../lfun/long`
+ Fuer Spielerobjekte:
+ :doc:`../props/P_EXTRA_LOOK`
+15. Juni 2017 Gloinson