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