blob: 913e47bb8dac7b71aa5b9d2bee0ce730911d9c73 [file] [log] [blame]
Zesstra18626972017-01-31 10:38:27 +01001P_SHORT
2=======
3
4NAME
5----
Zesstra18626972017-01-31 10:38:27 +01006
Zesstrad8673202020-06-13 16:26:59 +02007 P_SHORT
8 "short"
Zesstra18626972017-01-31 10:38:27 +01009
10DEFINIERT IN
11------------
Zesstra18626972017-01-31 10:38:27 +010012
Zesstrad8673202020-06-13 16:26:59 +020013 /sys/thing/description.h
Zesstra18626972017-01-31 10:38:27 +010014
15BESCHREIBUNG
16------------
Zesstra18626972017-01-31 10:38:27 +010017
Zesstrad8673202020-06-13 16:26:59 +020018 Diese Property enthaelt die Kurzbeschreibung eines Objektes bei Ansicht
19 *von aussen* als String. Fuer die Innen(kurz)ansicht von Raeumen muss man
20 P_INT_SHORT benutzen.
Zesstra18626972017-01-31 10:38:27 +010021
Zesstrad8673202020-06-13 16:26:59 +020022 Die Kurzbeschreibung darf *nicht* mit einem "\n" abgeschlossen sein (dies
23 wird von den zustaendigen Funktionen erledigt).
24 Aus historischen Gruenden wird ein Punkt ergaenzt, wenn das letzte
25 Zeichen kein Punkt, Ausrufezeichen oder Fragezeichen ist.
Zesstra18626972017-01-31 10:38:27 +010026
27 Setzt man diese Property auf 0, so ist das Objekt unsichtbar, allerdings
28 ansprechbar, wenn der Spieler eine ID des Objektes kennt. D.h. Objekte
29 koennen mitgenommen, weggeworfen oder ggf. auch angegriffen werden. Will
30 man dies nicht, sollte man das Objekt mit P_INVIS unsichtbar machen.
31
32 Diese Property bestimmt die Ansicht des Objektes von aussen. Fuer die
Zesstra5a397c72018-12-18 22:29:57 +010033 Innen(kurz)ansicht von Raeumen muss man P_INT_SHORT benutzen.
Zesstra18626972017-01-31 10:38:27 +010034
35BEMERKUNGEN
36-----------
Zesstra18626972017-01-31 10:38:27 +010037
Zesstrad8673202020-06-13 16:26:59 +020038 * In altem Code wird manchmal eine Closure als Wert (nicht als
39 Querymethode) eingetragen, welche einen String zurueckgibt. Dies ist
40 *deprecated* und sollte nicht mehr formuliert werden.
41
42 * Die Funktion, die die Kurzbeschreibung ausgibt (short()), filtert P_SHORT
43 durch process_string(). Dieses Feature ist *deprecated* und von der
44 Nutzung wird in neuem Code abgeraten.
45
46 * Soll eine dyn. Kurzbeschreibung geschaffen werden, bitte eine
Zesstra18626972017-01-31 10:38:27 +010047 F_QUERY_METHOD einsetzen oder short() passend ueberschreiben.
48
49BEISPIELE
50---------
Zesstrad8673202020-06-13 16:26:59 +020051
52.. code-block:: pike
Zesstra18626972017-01-31 10:38:27 +010053
54 // eine Axt sieht natuerlich so aus:
55 SetProp(P_SHORT, "Eine Axt");
56
57SIEHE AUCH
58----------
Zesstra18626972017-01-31 10:38:27 +010059
Zesstrad8673202020-06-13 16:26:59 +020060 Aehnliches: :doc:`P_LONG`, :doc:`../lfun/short`, :doc:`P_INT_SHORT`
Zesstra18626972017-01-31 10:38:27 +010061
62
Zesstrad8673202020-06-13 16:26:59 +02006313.06.2020, Zesstra
Zesstra18626972017-01-31 10:38:27 +010064