Gitiles
Code Review Sign In
gerrit.morgengrauen.info / mudlib-public / 78a2dda45e8bba37226c390ef3833b2ade7ad246 / . / doc / sphinx / lfun / AddItem.rst
blob: 8f159490b0b68e5980f2df949dcd1ef468f1fbde [file] [log] [blame]
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]1AddItem()
2=========
3
4FUNKTION
5--------
6::
7
8 varargs object AddItem(mixed filename,int refresh,mixed props);
9
10DEFINIERT IN
11------------
12::
13
14 /std/room/items.c
15 /std/npc/items.c
16
17ARGUMENTE
18---------
19::
20
21 filename
22 String mit dem Namen des zu erzeugenden Objektes oder Array von
23 Strings mit den Namen der zu erzeugenden Objekte. Bei einem Array
24 wird ein Name zufaellig ausgewaehlt.
25 refresh
26 Wann und wie soll das Objekt erneuert werden:
27 - REFRESH_NONE - Kein Refresh bis zum Neuladen des Raums
28 - oder NPCs.
29 - REFRESH_DESTRUCT - Refresh bei Reset, wenn Item zerstoert
30 wurde.
31 - REFRESH_REMOVE - Refresh bei Reset, wenn Item entfernt wurde.
32 - REFRESH_ALWAYS - Neuer Clone bei jedem Reset.
33 - REFRESH_MOVE_HOME - Objekt wird bei Reset automatisch
34 zurueckgeholt, wenn es wegbewegt wurde.
35 (nur in Raeumen!)
36 Bei NPC's gilt zusaetzlich:
37 - CLONE_WEAR - Item Anziehen, wenn es eine Ruestung ist.
38 - CLONE_WIELD - Item zuecken, wenn es eine Waffe ist.
39 - CLONE_NO_CHECK - Zuecken oder Anziehen ohne Ueberpruefungen.
40 props (optional)
41 Mapping mit denen in einem geclonten Objekt zu setzenden
42 Properties oder 1 fuer die Erzeugung einer Blueprint.
43
44RUeCKGABEWERT
45-------------
46::
47
48 Innerhalb von Raeumen wird das erzeugte Objekt zurueckgeliefert. Bei
49 NPC's klappt dies leider nicht, da dort die Objekte nicht sofort
50 erzeugt werden, sondern erst, nachdem der NPC an seinen
51 Bestimmungsort transferiert wurde. Daher wird bei NPC immer 0
52 zurueckgegeben.
53
54BESCHREIBUNG
55------------
56::
57
58 Abhaengig von <filename> und <props> wird ein Objekt erzeugt und in
59 den Raum bzw. NPC bewegt. Dabei gibt es folgende Moeglichkeiten:
60 - <filename> ist ein Dateiname.
61 Es wird ein Clone dieser Datei erstellt oder (wenn <props>=1 ist)
62 deren Blueprint verwendet.
63 - <filename> ist ein Array von Dateinamen.
64 Es wird eine Datei zufaellig aus dem Array ausgewaehlt und von
65 dieser Datei ein Clone erstellt oder (wenn <props>=1 ist) deren
66 Blueprint verwendet.
67 Uebergibt man fuer <props> ein Mapping mit dem Aufbau
68 ([prop_name:prop_wert,...]),
69 so werden diese Properties im erzeugten Objekt gesetzt.
70 Der Parameter <refresh> gibt an, was waehrend eines Resets im Raum
71 bzw. in NPC's oder was beim Erzeugen von NPC's geschehen soll:
72 In <rooms.h> sind dazu folgende Moeglichkeiten definiert:
73 - REFRESH_NONE
74 Das Objekt wird niemals erneuert; falls es zerstoert wurde, wird
75 es erst dann wieder erzeugt, wenn der Raum erneut geladen bzw.
76 der NPC neu erzeugt wird. Man beachte, dass nicht jeder NPC
77 wirklich refreshende Objekte benoetigt, REFRESH_NONE spart
78 hierbei sowohl Rechenzeit als auch Speicher!
79 - REFRESH_DESTRUCT
80 Das Objekt wird nur dann erneuert, wenn es in der Zwischenzeit
81 zerstoert wurde (bei NPC's ist das zum Beispiel der Fall, wenn
82 sie getoetet wurden).
83 REFRESH_NONE & REFRESH_DESTRUCT + Blueprint-Objekt bedeutet bei
84 NPC's ein Unique-Objekt, es wird also nicht beim Neuerzeugen des
85 NPC's zurueckgesetzt.
86 - REFRESH_REMOVE
87 Das Objekt wird erneuert, wenn es sich nicht mehr im Raum bzw.
88 im NPC befindet. Das kein sein, weil es zerstoert wurde, aber
89 auch zum Beispiel in folgenden Faellen:
90 * weil es jemand mitgenommen hat
91 (in Raeumen bei Gegenstaenden)
92 * weil es fortgegangen ist
93 (in Raeumen bei NPC's, die herumlaufen)
94 * weil es weggeworfen wurde
95 (in NPC's bei Gegenstaenden)
96 - REFRESH_ALWAYS
97 Das Objekt wird immer erneuert. Von dieser Refreshmethode sollte
98 man allerdings Abstand nehmen, da sich sonst mit der Zeit
99 gewaltige Mengen von Objekten ansammeln koennen!
100 - REFRESH_MOVE_HOME
101 Das Objekt wird in einen Raum zurueckbewegt, sofern es noch
102 existiert, jedoch nicht mehr in dem Raum ist. Sinnvoll ist dies
103 eigentlich nur fuer Lebewesen, funktioniert aber auch bei
104 beliebigen Objekten. Hauptsaechlich geht es hierbei darum,
105 herumlaufende NPCs oder bei erzwungenen Bewegungen nicht von
106 P_GUARD zurueckgehaltene NPCs wieder an einen definierten
107 Ausgangsort zurueckzubringen.
108 Hat man in Raeumen als <filename> ein Array von Dateinamen
109 uebergeben, so wird beim Reset jedesmal aufs Neue ein zufaelliges
110 Objekt aus der Liste ausgewaehlt (nicht in NPC's).
111 In NPC's gilt der Grundsatz der Vermeidung von ueberfluessigen
112 Objekten im MUD. Neu erzeugt werden Objekte beim Erzeugen eines
113 NPC's oder bei einem Reset im selbigen. Anstatt die Objekte gleich
114 neu zu erschaffen, wird erst geschaut, ob sich identische Objekte
115 schon im Raum befinden. Ist dies der Fall, so nimmt der NPC sie auf,
116 ruft jedoch vorher nochmals create() in ihnen auf!
117 (noetig wegen moeglicher Veraenderungen an den Objekten)
118 Was dann passiert, haengt von weiteren Angaben in <refresh> ab.
119 Folgende weitere Moeglichkeiten sind in <npc.h> definiert:
120 - CLONE_WEAR
121 Ist das hinzugefuegte Item eine Ruestung, so wird sie nach
122 Aufnahme oder Neuerzeugung angezogen.
123 - CLONE_WIELD
124 Ist das hinzugefuegte Item eine Waffe, so wird sie nach Aufnahme
125 oder Neuerzeugung gezueckt.
126 - CLONE_NO_CHECK
127 Hiermit verhindert man eine Ueberpruefung, ob eine Ruestung
128 angezogen oder eine Waffe gezueckt werden kann. Es ist jedoch
129 Vorsicht geboten: So kann es ohne weiteres passieren, dass ein NPC
130 mehrere Ruestungen gleichen Typs angezogen oder mehrere Waffen
131 gezueckt hat.
132 Benutzt man Blueprints (<props>=1) mit REFRESH_REMOVE oder
133 REFRESH_ALWAYS, so kann es zu ungewollten Ueberraschungen kommen, da
134 die Blueprint dann unabhaengig von ihrem momentanen Aufenthaltsort
135 wieder in den Raum bzw. NPC bewegt wird, von dem sie erzeugt wurde!
136
137BEMERKUNGEN
138-----------
139::
140
141 Wenn man Blueprints benutzt, sollte man daran denken, dass sich von
142 dieser dann keine Clones mehr erstellen lassen!
143 RemoveItem() zum Entfernen von Items ist nur fuer Raeume definiert!
144
145 Die Option CLONE_NEW ist veraltet. Die Objekte werden nun immer
146 neu erzeugt. Die Option darf noch angegeben werden, hat aber keine
147 Bedeutung mehr.
148
149BEISPIELE
150---------
151::
152
153 // Ein Wuerfel, der sich nach Entfernen erneuert:
154 AddItem("/obj/misc/wuerfel",REFRESH_REMOVE);
155 // Ein etwas veraenderter Wuerfel:
156 AddItem("/obj/misc/wuerfel",
157 REFRESH_REMOVE,
158 ([P_SHORT :"Ein schwerer Wuerfel",
159 P_WEIGHT:100]));
160 // Eine Blueprint, die nur einmal im MUD existiert. Wenn sie
161 // zerstoert wurde, wird sie bei Reset neu erzeugt:
162 AddItem("/mon/angsthase",REFRESH_DESTRUCT,1);
163 // Eine Blueprint, die nur einmal im MUD existiert. Wenn sie aus dem
164 // Raum entfernt wurde, wird sie bei Reset zurueckgeholt:
165 AddItem("/mon/angsthase",REFRESH_MOVE_HOME,1);
166 // Ein zufaelliges Objekt:
167 AddItem(({"/obj/misc/lolli",
168 "/obj/misc/bonbon",
169 "/obj/misc/bier"}),REFRESH_REMOVE);
170 // Eine Ruestung, die auch angezogen wird (nur in NPC's):
171 AddItem("/ruestung/sommerkleid",REFRESH_REMOVE|CLONE_WEAR);
172 // Eine Unique-Waffe, die auch gezueckt wird (nur in NPC's):
173 AddItem("/waffe/zapper",REFRESH_DESTRUCT|CLONE_WIELD,1);
174
175SIEHE AUCH
176----------
177::
178
179 RemoveItem(), replace_program(), create(), P_GUARD,
180 /std/room/items.c, /std/npc/items.c,
181 /sys/rooms.h, /sys/npc.h
182
183
184Last modified: Thu Nov 23 13:43:30 CET 2006 by Rumata
185