blob: 951b48a95032466eb35b3c11b1b960224212e85b [file] [log] [blame]
Zesstra953f9972017-02-18 15:37:36 +01001
2AddDetail()
3***********
4
5
6FUNKTION
7========
8
9 void AddDetail(string|string* keys,
10 string|string*|mapping|closure desc);
11
12
13DEFINIERT IN
14============
15
16 /std/thing/description.c
17
18
19ARGUMENTE
20=========
21
22 keys
23 String oder Array von Strings mit den Namen der Details.
24 desc
25 String, Mapping, String-Array oder Closure mit/zur Beschreibung.
26
27
28BESCHREIBUNG
29============
30
31 Die Beschreibung der Details <keys> wird gesetzt. Wie die Details
32 bei der Untersuchung aussehen, haengt im wesentlichen vom Typ der
33 Beschreibung <desc> ab:
34 <desc> ist ein String.
35 Beim Untersuchen wird dieser String zurueckgegeben.
36 <desc> ist ein String-Array.
37 Beim Untersuchen wird zufaellig einer der Strings zurueckgegeben.
38 <desc> ist ein Mapping.
39 Das Mapping muss folgenden Aufbau haben:
40 ([0: "Defaulttext",
41 "rasse1": "r1text", ...]).
42
43 Falls fuer die Rasse des das Detail untersuchenden Spielers ein
44 Eintrag im Mapping existiert, wird der entsprechende Text
45 zurueckgegeben, ansonsten der Defaulttext. Auf diese Weise sind
46 rassenabhaengige Details moeglich. Siehe auch die Beispiele.
47 <desc> ist eine Closure.
48 In diesem Fall wird die Closure ausgefuehrt und das Ergebnis
49 zurueckgegeben. Die Closure bekommt dabei den Namen des Details
50 als Parameter uebergeben.
51
52 Fuer Details koennen Forscherpunkte eingetragen werden.
53
54
55BEISPIELE
56=========
57
58 Ein schlichtes Detail:
59
60 AddDetail(({"sofa","couch"}), "Eine kleine Couch.\n");
61
62 Laengere Details sollten hierbei nicht per Hand umgebrochen werden,
63 sondern man kann hierzu die Funktion break_string() nutzen:
64
65 AddDetail("detail", break_string(
66 "Du wolltest es ja nicht anders, jetzt musst Du Dir dieses "
67 "fuerchterlich lange Detail durchlesen!!!", 78));
68
69 Noetige Zeilenumbrueche bei Zeilenlaengen groesser 77 werden so
70 automatisch generiert.
71 Ein rassenabhaengiges Detail:
72
73 AddDetail(({"bett","bettchen"}),
74 ([0 :"Eine kleines Bett.\n", // Der Defaulttext
75 "zwerg": // Die Rasse klein schreiben
76 "Das Bett laedt geradezu zu einem Nickerchen ein.\n"]));
77
78 Und nun ein Detail mit Closure (diese Version ersetzt das Verhalten
79 von AddSpecialDetail).
80
81 int hebel_betaetigt;
82 ...
83 string hebel(string str); // Funktion bekannt machen (Prototyping)
84 ...
85 AddDetail(({"hebel","schalter"}), #'hebel);
86 ...
87 string hebel(string key) {
88 if(hebel_betaetigt)
89 return "Der "+capitalize(key)+" steht auf EIN.\n";
90 else
91 return "Der "+capitalize(key)+" steht auf AUS.\n";
92 }
93
94 Man erhaelt verschiedene Ergebnisse beim Untersuchen, je nachdem
95 ob das Flag hebel_betaetigt gesetzt ist oder nicht.
96
97
98SIEHE AUCH
99==========
100
101 Setzen: AddReadDetail(), AddSmells(), AddSounds(),
102 AddTouchDetail()
103 Loeschen: RemoveDetail(), RemoveReadDetail(), RemoveSmells(),
104 RemoveSounds(), RemoveTouchDetail()
105 Daten: P_DETAILS, P_READ_DETAILS, P_SMELLS, P_SOUNDS,
106 P_TOUCH_DETAILS, P_SPECIAL_DETAILS
107 Veraltet: AddSpecialDetail(), RemoveSpecialDetail(), P_READ_MSG
108 Sonstiges: GetDetail(), break_string()
109
11020.01.2015, Zesstra