Gitiles
Code Review Sign In
gerrit.morgengrauen.info / mudlib-public / a28520846457fed0d688dabcfee12dfa34512fe3 / . / doc / lfun / GetDetail
blob: 7e5a09297c707e3b782eaa0601a2b4317ff60650 [file] [log] [blame]
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]1
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]2GetDetail()
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]3***********
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]4
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]5
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]6FUNKTION
7========
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]8
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]9 varargs string GetDetail(string key, string race, int sense)
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]10
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]11
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]12DEFINIERT IN
13============
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]14
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]15 /std/thing/description.c
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]16
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]17
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]18ARGUMENTE
19=========
20
21 key
22 Das zu ermittelnde Detail.
23 race
24 Rasse des ermittelnden Objektes (falls es ein Lebewesen ist).
25 sense
26 Die Art des zu untersuchenden Details:
27 Untersuchen, Riechen, Hoeren, Tasten.
28
29
30BESCHREIBUNG
31============
32
33 Die Beschreibung des gewuenschten Details wird ermittelt. Dabei
34 werden rassenspezifische Details beruecksichtigt. Es gibt hierbei
35 verschiedene Detailarten, deren Typ man in <sense> angibt:
36 SENSE_VIEW - Fuer Defaultdetails zum Untersuchen.
37 SENSE_SMELL - Fuer Details, die man riechen kann.
38 SENSE_SOUND - Fuer Details, die man hoeren kann.
39 SENSE_TOUCH - Fuer Details, die man abtasten kann.
40 SENSE_READ - Fuer Details, die man lesen kann.
41
42 Dabei ist 0 == SENSE_VIEW.
43
44
45RUeCKGABEWERT
46=============
47
48 Die Beschreibung des Details oder 0, wenn es dieses Detail nicht
49 gibt.
50
51
52BEISPIEL
53========
54
55 Im folgenden wird ein kleines Testdetail generiert:
56 AddDetail("test","Das ist ein Test!\n");
57 Im folgenden wird das Detail entfernt, wenn es existiert. Dies ist
58 eigentlich nicht noetig, da RemoveDetail() damit zurechtkommt, aber
59 eventuell sind ja noch weitere Aktionen noetig.
60 if(GetDetail("test"))
61 { RemoveDetail("test");
62 ...
63 }
64 Ein Geruch kann man folgendermassen erzeugen:
65 AddSmells("gold",
66 ([0 :"Gold kann man nicht riechen!\n",
67 "zwerg":"Deine trainierte Nase riecht es muehelos!\n"]));
68 Die Abfrage des Details gestaltet sich recht einfach:
69 GetDetail("gold","zwerg",SENSE_SMELL);
70 Die Funktion liefert das Detail fuer den Zwerg.
71 GetDetail("gold",0,SENSE_SMELL);
72 Die Funktion liefert das Detail fuer die restlichen Rassen.
73 GetDetail("gold",0,SENSE_SOUND);
74 Ein Sounddetail mit dem Namen "gold" existiert nicht, die Funktion
75 liefert 0 zurueck.
76
77
78SIEHE AUCH
79==========
80
81 Setzen: AddDetail(), AddReadDetail(), AddSmells(), AddSounds(),
82 AddTouchDetail()
83 Loeschen: RemoveReadDetail(), RemoveSmells(), RemoveDetail(),
84 RemoveSounds(), RemoveTouchDetail()
85 Daten: P_DETAILS, P_READ_DETAILS, P_SMELLS, P_SOUNDS,
86 P_TOUCH_DETAILS, P_SPECIAL_DETAILS
87 Veraltet: AddSpecialDetail(), RemoveSpecialDetail(), P_READ_MSG
88 Sonstiges: break_string()
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]89
9027. Jan 2013 Gloinson