ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/object.h
(Generate patch)

Comparing deliantra/server/include/object.h (file contents):
Revision 1.135 by root, Sun Jul 1 05:00:18 2007 UTC vs.
Revision 1.199 by elmex, Mon Jan 12 00:17:23 2009 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team 4 * Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 7 *
8 * Crossfire TRT is free software: you can redistribute it and/or modify 8 * Deliantra is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by 9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or 10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version. 11 * (at your option) any later version.
12 * 12 *
13 * This program is distributed in the hope that it will be useful, 13 * This program is distributed in the hope that it will be useful,
16 * GNU General Public License for more details. 16 * GNU General Public License for more details.
17 * 17 *
18 * You should have received a copy of the GNU General Public License 18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * 20 *
21 * The authors can be reached via e-mail to <crossfire@schmorp.de> 21 * The authors can be reached via e-mail to <support@deliantra.net>
22 */ 22 */
23 23
24#ifndef OBJECT_H 24#ifndef OBJECT_H
25#define OBJECT_H 25#define OBJECT_H
26 26
65 const char *nonuse_name; /* Name to describe objects we can't use */ 65 const char *nonuse_name; /* Name to describe objects we can't use */
66} Body_Locations; 66} Body_Locations;
67 67
68extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 68extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
69 69
70#define NUM_COINS 4 /* number of coin types */
71extern const char *const coins[NUM_COINS + 1];
72
70/* 73/*
71 * Each object (this also means archetypes!) could have a few of these 74 * Each object (this also means archetypes!) could have a few of these
72 * "dangling" from it; this could also end up containing 'parse errors'. 75 * "dangling" from it; this could also end up containing 'parse errors'.
73 * 76 *
74 * key and value are shared-strings. 77 * key and value are shared-strings.
75 * 78 *
76 * Please use get_ob_key_value(), set_ob_key_value() from object.c rather than 79 * Please use kv_get/kv_set/kv_del from object rather than
77 * accessing the list directly. 80 * accessing the list directly.
78 * Exception is if you want to walk this list for some reason. 81 * Exception is if you want to walk this list for some reason.
79 */ 82 */
80struct key_value 83struct key_value : slice_allocated
81{ 84{
82 key_value *next; 85 key_value *next;
83 shstr key, value; 86 shstr key, value;
84}; 87};
85 88
86struct UUID 89struct UUID
87{ 90{
88 uint64 seq; 91 uint64 seq;
92
93 static UUID cur; // last uuid generated
94 static void init ();
95 static UUID gen ();
89 96
90 UUID () { } 97 UUID () { }
91 UUID (uint64 seq) : seq(seq) { } 98 UUID (uint64 seq) : seq(seq) { }
92 operator uint64() { return seq; } 99 operator uint64() { return seq; }
93 void operator =(uint64 seq) { this->seq = seq; } 100 void operator =(uint64 seq) { this->seq = seq; }
101
102 typedef char BUF [32];
103
104 bool parse (const char *s)
105 {
106 return sscanf (s, "<1.%" SCNx64 ">", &seq) == 1;
107 }
108
109 const char *c_str (char *buf, int len) const
110 {
111 snprintf (buf, len, "<1.%" PRIx64 ">", seq);
112
113 return buf;
114 }
115
116 const char *c_str () const
117 {
118 static BUF buf;
119
120 return c_str (buf, sizeof (buf));
121 }
94}; 122};
95
96extern void init_uuid ();
97extern UUID gen_uuid ();
98extern const uint64 UUID_SKIP;
99 123
100/* Definition for WILL_APPLY values. Replaces having harcoded values 124/* Definition for WILL_APPLY values. Replaces having harcoded values
101 * sprinkled in the code. Note that some of these also replace fields 125 * sprinkled in the code. Note that some of these also replace fields
102 * that were in the can_apply area. What is the point of having both 126 * that were in the can_apply area. What is the point of having both
103 * can_apply and will_apply? 127 * can_apply and will_apply?
112{ 136{
113 signed char info:4; /* body info as loaded from the file */ 137 signed char info:4; /* body info as loaded from the file */
114 signed char used:4; /* Calculated value based on items equipped */ 138 signed char used:4; /* Calculated value based on items equipped */
115}; 139};
116 140
141typedef struct oblnk
142{ /* Used to link together several objects */
143 object_ptr ob;
144 struct oblnk *next;
145} objectlink;
146
147typedef struct oblinkpt
148{ /* Used to link together several object links */
149 struct oblnk *link;
150 struct oblinkpt *next;
151 shstr id; /* Used as connected value in buttons/gates */
152} oblinkpt;
153
117INTERFACE_CLASS (object) 154INTERFACE_CLASS (object)
118// these are being copied 155// these are being copied
119struct object_copy : attachable 156struct object_copy : attachable
120{ 157{
121 typedef bitset<NUM_FLAGS> flags_t;
122
123 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */ 158 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
124 159
125 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */ 160 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
126 uint8 ACC (RW, subtype); /* subtype of object */ 161 uint8 ACC (RW, subtype); /* subtype of object */
127 sint8 ACC (RW, direction); /* Means the object is moving that way. */ 162 sint8 ACC (RW, direction); /* Means the object is moving that way. */
131 shstr ACC (RW, name_pl); /* The plural name of the object */ 166 shstr ACC (RW, name_pl); /* The plural name of the object */
132 shstr ACC (RW, title); /* Of foo, etc */ 167 shstr ACC (RW, title); /* Of foo, etc */
133 shstr ACC (RW, race); /* human, goblin, dragon, etc */ 168 shstr ACC (RW, race); /* human, goblin, dragon, etc */
134 shstr ACC (RW, slaying); /* Which race to do double damage to */ 169 shstr ACC (RW, slaying); /* Which race to do double damage to */
135 /* If this is an exit, this is the filename */ 170 /* If this is an exit, this is the filename */
171
172 typedef bitset<NUM_FLAGS> flags_t;
173 flags_t flag; /* various flags */
174#if FOR_PERL
175 bool ACC (RW, flag[NUM_FLAGS]);
176#endif
177
178 shstr ACC (RW, materialname); /* specific material name */
136 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ 179 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
137 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
138 shstr ACC (RW, lore); /* Obscure information about this object, */
139 /* To get put into books and the like. */
140 shstr ACC (RW, materialname); /* specific material name */
141 shstr ACC (RW, custom_name); /* Custom name assigned by player */
142// materialtype_t *ACC (RW, material); /* What material this object consists of */ 180// materialtype_t *ACC (RW, material); /* What material this object consists of */
143 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */ 181 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
144 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */ 182 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
145 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */ 183 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
146 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */ 184 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
150 arch_ptr ACC (RW, arch); /* Pointer to archetype */ 188 arch_ptr ACC (RW, arch); /* Pointer to archetype */
151 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */ 189 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
152 190
153 float ACC (RW, speed); /* The overall speed of this object */ 191 float ACC (RW, speed); /* The overall speed of this object */
154 float ACC (RW, speed_left); /* How much speed is left to spend this round */ 192 float ACC (RW, speed_left); /* How much speed is left to spend this round */
155 uint32 ACC (RW, nrof); /* How many of the objects */ 193 sint32 ACC (RW, nrof); /* How many of the objects */
156 194
157 /* This next big block are basically used for monsters and equipment */ 195 /* This next big block is basically used for monsters and equipment */
158 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */ 196 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
159
160 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 197 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
198
161 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 199 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
162 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 200 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
163 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */ 201 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
164 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */ 202 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
203
165 uint16 ACC (RW, materials); /* What materials this object consists of */ 204 uint16 ACC (RW, materials); /* What materials this object consists of */
166 sint8 ACC (RW, magic); /* Any magical bonuses to this item */ 205 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
167 uint8 ACC (RW, state); /* How the object was last drawn (animation) */ 206 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
207
168 sint32 ACC (RW, value); /* How much money it is worth (or contains) */ 208 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
169 /* Note that the last_.. values are sometimes used for non obvious 209 /* Note that the last_.. values are sometimes used for non obvious
170 * meanings by some objects, eg, sp penalty, permanent exp. 210 * meanings by some objects, eg, sp penalty, permanent exp.
171 */ 211 */
172 sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */ 212 sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */
173 sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */ 213 sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */
174 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */ 214 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
175 sint16 ACC (RW, last_eat); /* How long since we last ate */ 215 sint16 ACC (RW, last_eat); /* How long since we last ate */
176 sint16 ACC (RW, invisible); /* How much longer the object will be invis */ 216 sint16 ACC (RW, invisible); /* How much longer the object will be invis */
177 sint16 ACC (RW, level); /* Level of creature or object */ 217 sint16 ACC (RW, level); /* Level of creature or object */
218
178 uint8 ACC (RW, pick_up); /* See crossfire.doc */ 219 uint8 ACC (RW, pick_up); /* See crossfire.doc */
179 sint8 ACC (RW, item_power); /* power rating of the object */
180 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */ 220 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
181 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */ 221 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
222 uint8 ACC (RW, weapontype); /* type of weapon */
223
224 faceidx ACC (RW, face); /* the graphical face */
225
226 faceidx ACC (RW, sound); /* the sound face */
227 faceidx ACC (RW, sound_destroy); /* played on destroy */
228
229 body_slot slot [NUM_BODY_LOCATIONS];
230
182 sint32 ACC (RW, weight); /* Attributes of the object */ 231 sint32 ACC (RW, weight); /* Attributes of the object */
183 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 232 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
184 sint32 ACC (RW, carrying); /* How much weight this object contains */ 233 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
185 sint64 ACC (RW, perm_exp); /* Permanent exp */ 234 sint64 ACC (RW, perm_exp); /* Permanent exp */
186 uint32 ACC (RW, weapontype); /* type of weapon */
187 uint32 ACC (RW, tooltype); /* type of tool or build facility */
188 body_slot slot [NUM_BODY_LOCATIONS];
189 faceidx ACC (RW, face); /* Face with colors */
190 living ACC (RO, stats); /* Str, Con, Dex, etc */ 235 living ACC (RO, stats); /* Str, Con, Dex, etc */
191 /* See the pod/objects.pod for more info about body locations */ 236 /* See the pod/objects.pod for more info about body locations */
192 237
193 /* Following mostly refers to fields only used for monsters */ 238 /* Following mostly refers to fields only used for monsters */
194 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
195 239
196 /* allows different movement patterns for attackers */ 240 /* allows different movement patterns for attackers */
197 sint32 ACC (RW, move_status); /* What stage in attack mode */ 241 sint32 ACC (RW, move_status); /* What stage in attack mode */
198 uint16 ACC (RW, attack_movement); /* What kind of attack movement */ 242 uint16 ACC (RW, attack_movement); /* What kind of attack movement */
199 uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */ 243 uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
205 * only used in spells. 249 * only used in spells.
206 */ 250 */
207 sint16 ACC (RW, duration); /* How long the spell lasts */ 251 sint16 ACC (RW, duration); /* How long the spell lasts */
208 sint16 ACC (RW, casting_time);/* time left before spell goes off */ 252 sint16 ACC (RW, casting_time);/* time left before spell goes off */
209 253
210 uint16 ACC (RW, start_holding);
211 uint8 ACC (RW, duration_modifier); /* how level modifies duration */ 254 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
212 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */ 255 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
213
214 sint8 ACC (RW, range); /* Range of the spell */ 256 sint8 ACC (RW, range); /* Range of the spell */
215 uint8 ACC (RW, range_modifier); /* How going up in level effects range */ 257 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
258
216 MoveType ACC (RW, move_type); /* Type of movement this object uses */ 259 MoveType ACC (RW, move_type); /* Type of movement this object uses */
217 MoveType ACC (RW, move_block);/* What movement types this blocks */ 260 MoveType ACC (RW, move_block);/* What movement types this blocks */
218
219 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */ 261 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
220 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */ 262 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
263
221 MoveType ACC (RW, move_off); /* Move types affected moving off this space */ 264 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
222 MoveType ACC (RW, move_slow); /* Movement types this slows down */ 265 MoveType ACC (RW, move_slow); /* Movement types this slows down */
223 266
267 sint8 ACC (RW, item_power); /* power rating of the object */
268 // 8 free bits
269
224 float ACC (RW, move_slow_penalty); /* How much this slows down the object */ 270 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
225
226 char *ACC (RW, spellarg); 271 char *ACC (RW, spellarg);
227 272
228 /* Following are values used by any object */ 273 /* Following are values used by any object */
229 /* this objects turns into or what this object creates */ 274 /* this objects turns into or what this object creates */
230 treasurelist *ACC (RW, randomitems); /* Items to be generated */ 275 treasurelist *ACC (RW, randomitems); /* Items to be generated */
231 flags_t flag; /* various flags */ 276
232#if FOR_PERL
233 bool ACC (RW, flag[NUM_FLAGS]);
234#endif
235 uint16 ACC (RW, animation_id);/* An index into the animation array */ 277 uint16 ACC (RW, animation_id);/* An index into the animation array */
236 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */ 278 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
237 uint8 ACC (RW, last_anim); /* last sequence used to draw face */ 279 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
238 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */ 280
239 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */ 281 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
240 uint8 ACC (RW, will_apply); /* See crossfire.doc */ 282 uint8 ACC (RW, will_apply); /* See crossfire.doc */
283 uint16 ACC (RW, cached_sp); /* cached spell points used for a spell, used by esrv_update_spells */
284
285 uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
286 uint16 ACC (RW, cached_eat); /* cached food, used by esrv_update_spells */
287
288 // rarely-accessed members should be at the end
289 shstr ACC (RW, tag); // a tag used to tracking this object
290 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
291 shstr ACC (RW, lore); /* Obscure information about this object, */
292 /* To get put into books and the like. */
293 shstr ACC (RW, custom_name); /* Custom name assigned by player */
241}; 294};
242 295
296const char *query_weight (const object *op);
297const char *query_short_name (const object *op);
298const char *query_name (const object *op);
299const char *query_base_name (const object *op, int plural);
300
243struct object : zero_initialised, object_copy 301struct object : zero_initialised, object_copy
244{ 302{
245 // These variables are not changed by ->copy_to 303 // These variables are not changed by ->copy_to
246 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ 304 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
247 305
248 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 306 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
249 int ACC (RO, count); 307 int ACC (RO, count);
250 object_vector_index ACC (RO, index); // index into objects 308 object_vector_index ACC (RO, index); // index into objects
251 object_vector_index ACC (RO, active); // index into actives 309 object_vector_index ACC (RO, active); // index into actives
252 310
253 player_ptr ACC (RW, contr); /* Pointer to the player which control this object */ 311 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
254 312
255 object *ACC (RW, below); /* Pointer to the object stacked below this one */ 313 object *ACC (RW, below); /* Pointer to the object stacked below this one */
256 object *ACC (RW, above); /* Pointer to the object stacked above this one */ 314 object *ACC (RW, above); /* Pointer to the object stacked above this one */
257 /* Note: stacked in the *same* environment */ 315 /* Note: stacked in the *same* environment */
258 object *inv; /* Pointer to the first object in the inventory */ 316 object *inv; /* Pointer to the first object in the inventory */
267 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 325 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
268 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 326 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
269 client_container *seen_by; // seen by which player/container currently? 327 client_container *seen_by; // seen by which player/container currently?
270 key_value *key_values; /* Fields not explictly known by the loader. */ 328 key_value *key_values; /* Fields not explictly known by the loader. */
271 329
330 // privates / perl
331 shstr_tmp kv_get (shstr_tmp key) const;
332 void kv_del (shstr_tmp key);
333 void kv_set (shstr_tmp key, shstr_tmp value);
334
335 // custom extra fields management
336 struct key_value_access_proxy
337 {
338 object &ob;
339 shstr_tmp key;
340
341 key_value_access_proxy (object &ob, shstr_tmp key)
342 : ob (ob), key (key)
343 {
344 }
345
346 const key_value_access_proxy &operator =(shstr_tmp value) const
347 {
348 ob.kv_set (key, value);
349 return *this;
350 }
351
352 operator const shstr_tmp () const { return ob.kv_get (key); }
353 operator const char *() const { return ob.kv_get (key); }
354
355 private:
356 void operator =(int);
357 };
358
359 // operator [] is too annoying to use
360 const key_value_access_proxy kv (shstr_tmp key)
361 {
362 return key_value_access_proxy (*this, key);
363 }
364
272 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 365 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
273 void post_load_check (); // do some adjustments after parsing 366 MTH void post_load_check (); // do some adjustments after parsing
274 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. 367 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
275 bool write (object_freezer &f); 368 bool write (object_freezer &f);
276 369
277 MTH int slottype () const; 370 MTH int slottype () const;
278 MTH static object *create (); 371 MTH static object *create ();
279 object &operator =(const object &src); 372 const mapxy &operator =(const mapxy &pos);
280 MTH void copy_to (object *dst); 373 MTH void copy_to (object *dst);
281 MTH object *clone (); // create + copy_to 374 MTH object *clone (); // create + copy_to a single object
375 MTH object *deep_clone (); // copy whole more chain and inventory
282 void do_destroy (); 376 void do_destroy ();
283 void gather_callbacks (AV *&callbacks, event_type event) const; 377 void gather_callbacks (AV *&callbacks, event_type event) const;
284 MTH void destroy (bool destroy_inventory = false); 378 MTH void destroy ();
379 MTH void drop_and_destroy ()
380 {
381 destroy_inv (true);
382 destroy ();
383 }
285 384
286 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 385 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
287 MTH void destroy_inv (bool drop_to_ground = false); 386 MTH void destroy_inv (bool drop_to_ground = false);
288 MTH object *insert (object *item); // insert into inventory 387 MTH object *insert (object *item); // insert into inventory
388 MTH void play_sound (faceidx sound) const;
389 MTH void say_msg (const char *msg) const;
390
289 void do_remove (); 391 void do_remove ();
290 MTH void remove () 392 MTH void remove ()
291 { 393 {
292 if (!flag [FLAG_REMOVED]) 394 if (!flag [FLAG_REMOVED])
293 do_remove (); 395 do_remove ();
396 }
397
398 MTH bool blocked (maptile *m, int x, int y) const;
399
400 void move_to (const mapxy &pos)
401 {
402 remove ();
403 *this = pos;
404 insert_at (this, this);
405 }
406
407 // high-level move functions, return true if successful
408 int move (int dir, object *originator);
409
410 int move (int dir)
411 {
412 return move (dir, this);
294 } 413 }
295 414
296 static bool can_merge_slow (object *op1, object *op2); 415 static bool can_merge_slow (object *op1, object *op2);
297 416
298 // this is often used in time-critical code, so optimise 417 // this is often used in time-critical code, so optimise
303 && can_merge_slow (op1, op2); 422 && can_merge_slow (op1, op2);
304 } 423 }
305 424
306 MTH void set_owner (object *owner); 425 MTH void set_owner (object *owner);
307 MTH void set_speed (float speed); 426 MTH void set_speed (float speed);
427 MTH void set_glow_radius (sint8 rad);
308 MTH bool change_weapon (object *ob); 428 MTH bool change_weapon (object *ob);
309 MTH bool change_skill (object *ob); 429 MTH bool change_skill (object *ob);
310 430
311 MTH void open_container (object *new_container); 431 MTH void open_container (object *new_container);
312 MTH void close_container () 432 MTH void close_container ()
313 { 433 {
314 open_container (0); 434 open_container (0);
315 } 435 }
436
437 MTH object *force_find (shstr_tmp name);
438 MTH object *force_add (shstr_tmp name, int duration = 0);
439
440 oblinkpt *find_link () const;
441 MTH void add_link (maptile *map, shstr_tmp id);
442 MTH void remove_link ();
316 443
317 // overwrite the attachable should_invoke function with a version that also checks ev_want_type 444 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
318 bool should_invoke (event_type event) 445 bool should_invoke (event_type event)
319 { 446 {
320 return ev_want_event [event] || ev_want_type [type] || cb; 447 return ev_want_event [event] || ev_want_type [type] || cb;
335 // info must hold 256 * 3 bytes currently 462 // info must hold 256 * 3 bytes currently
336 const char *debug_desc (char *info) const; 463 const char *debug_desc (char *info) const;
337 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 464 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
338 const char *flag_desc (char *desc, int len) const; 465 const char *flag_desc (char *desc, int len) const;
339 466
467 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
468 MTH object *split (sint32 nr = 1); // return 0 on failure
469
340 int number_of () const 470 MTH int number_of () const
341 { 471 {
342 return nrof ? nrof : 1; 472 return nrof ? nrof : 1;
343 } 473 }
344 474
345 uint64 total_weight () const 475 MTH sint32 total_weight () const
346 { 476 {
347 return weight * number_of (); 477 return (weight + carrying) * number_of ();
348 } 478 }
479
480 MTH void update_weight ();
349 481
350 // return the dominant material of this item, always return something 482 // return the dominant material of this item, always return something
351 const materialtype_t *dominant_material () const; 483 const materialtype_t *dominant_material () const;
352 484
353 // return the volume of this object in cm³ 485 // return the volume of this object in cm³
354 uint64 volume () const 486 MTH uint64 volume () const
355 { 487 {
356 return total_weight () 488 return (uint64)total_weight ()
357 * 1000 489 * 1000
358 * (type == CONTAINER ? 1000 : 1) 490 * (type == CONTAINER ? 1000 : 1)
359 / dominant_material ()->density; 491 / dominant_material ()->density;
360 } 492 }
361 493
494 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
362 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; } 495 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
363 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET 496 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
364 || type == CLOAK || type == BOOTS || type == GLOVES 497 || type == CLOAK || type == BOOTS || type == GLOVES
365 || type == BRACERS || type == GIRDLE; } 498 || type == BRACERS || type == GIRDLE; }
366 MTH bool is_alive () const { return (type == PLAYER 499 MTH bool is_alive () const { return (type == PLAYER
376 509
377 // temporary: wether the object can be saved in a map file 510 // temporary: wether the object can be saved in a map file
378 // contr => is a player 511 // contr => is a player
379 // head => only save head of a multitile object 512 // head => only save head of a multitile object
380 // owner => can not reference owner yet 513 // owner => can not reference owner yet
381 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } 514 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
382 515
383 /* This return true if object has still randomitems which 516 /* This return true if object has still randomitems which
384 * could be expanded. 517 * could be expanded.
385 */ 518 */
386 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 519 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
387 520
521 MTH bool has_dialogue () const { return *&msg == '@'; }
522
523 // returns the outermost owner, never returns 0
524 MTH object *outer_owner ()
525 {
526 object *op;
527
528 for (op = this; op->owner; op = op->owner)
529 ;
530
531 return op;
532 }
533
534 // returns the outermost environment, never returns 0
535 MTH object *outer_env () const
536 {
537 const object *op;
538
539 for (op = this; op->env; op = op->env)
540 ;
541
542 return const_cast<object *>(op);
543 }
544
388 // returns the player that has this object in his inventory, or 0 545 // returns the player that has this object in his inventory, or 0
546 // we assume the player is always the outer env
389 MTH object *in_player () const 547 MTH object *in_player () const
390 { 548 {
391 for (object *op = env; op; op = op->env) 549 object *op = outer_env ();
392 if (op->type == PLAYER)
393 return op;
394 550
395 return 0; 551 return op->type == PLAYER ? op : 0;
396 } 552 }
397 553
398 // "temporary" helper function 554 // "temporary" helper function
399 MTH object *head_ () 555 MTH object *head_ () const
400 { 556 {
401 return head ? head : this; 557 return head ? head : const_cast<object *>(this);
402 } 558 }
403 559
404 MTH bool is_head () 560 MTH bool is_head () const
405 { 561 {
406 return head_ () == this; 562 return head_ () == this;
407 } 563 }
564
565 MTH bool is_on_map () const
566 {
567 return !env && !flag [FLAG_REMOVED];
568 }
569
570 MTH bool is_inserted () const
571 {
572 return !flag [FLAG_REMOVED];
573 }
574
575 MTH bool is_player () const
576 {
577 return !!contr;
578 }
579
580 MTH bool affects_los () const
581 {
582 return glow_radius || flag [FLAG_BLOCKSVIEW];
583 }
584
585 MTH bool has_carried_lights () const
586 {
587 return glow_radius;
588 }
589
590 // returns the player that cna see this object, if any
591 MTH object *visible_to () const;
408 592
409 MTH std::string long_desc (object *who = 0); 593 MTH std::string long_desc (object *who = 0);
410 MTH std::string describe_monster (object *who = 0); 594 MTH std::string describe_monster (object *who = 0);
411 MTH std::string describe_item (object *who = 0); 595 MTH std::string describe_item (object *who = 0);
412 MTH std::string describe (object *who = 0); 596 MTH std::string describe (object *who = 0);
597
598 MTH const char *query_weight () { return ::query_weight (this); }
599 MTH const char *query_name () { return ::query_name (this); }
600 MTH const char *query_short_name () { return ::query_short_name (this); }
601 MTH const char *query_base_name (bool plural) { return ::query_base_name (this, plural); }
413 602
414 // If this object has no extra parts but should have them, 603 // If this object has no extra parts but should have them,
415 // add them, effectively expanding heads into multipart 604 // add them, effectively expanding heads into multipart
416 // objects. This method only works on objects not inserted 605 // objects. This method only works on objects not inserted
417 // anywhere. 606 // anywhere.
420 MTH void create_treasure (treasurelist *tl, int flags = 0); 609 MTH void create_treasure (treasurelist *tl, int flags = 0);
421 610
422 // insert object at same map position as 'where' 611 // insert object at same map position as 'where'
423 // handles both inventory and map "positions" 612 // handles both inventory and map "positions"
424 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 613 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
614 MTH void drop_unpaid_items ();
425 615
426 MTH void activate (); 616 MTH void activate ();
427 MTH void deactivate (); 617 MTH void deactivate ();
428 MTH void activate_recursive (); 618 MTH void activate_recursive ();
429 MTH void deactivate_recursive (); 619 MTH void deactivate_recursive ();
430 620
431 // set the givne flag on all objects in the inventory recursively 621 // set the given flag on all objects in the inventory recursively
432 MTH void set_flag_inv (int flag, int value = 1); 622 MTH void set_flag_inv (int flag, int value = 1);
433 623
434 void enter_exit (object *exit);//Perl 624 void enter_exit (object *exit);//Perl
435 MTH void enter_map (maptile *newmap, int x, int y); 625 MTH void enter_map (maptile *newmap, int x, int y);
626 void player_goto (const char *path, int x, int y); // only for players
436 627
437 // returns the mapspace this object is in 628 // returns the mapspace this object is in
438 mapspace &ms () const; 629 mapspace &ms () const;
439 630
440 // fully recursive iterator 631 // fully recursive iterator
476 { 667 {
477 return this; 668 return this;
478 } 669 }
479 670
480 /* This returns TRUE if the object is something that 671 /* This returns TRUE if the object is something that
481 * should be displayed in the floorbox/inventory window 672 * a client might want to know about.
482 */ 673 */
483 MTH bool client_visible () const 674 MTH bool client_visible () const
484 { 675 {
485 return !invisible && type != PLAYER; 676 return !invisible && type != PLAYER;
486 } 677 }
487 678
679 // the client does nrof * this weight
680 MTH sint32 client_weight () const
681 {
682 return weight + carrying;
683 }
684
488 MTH struct region *region () const; 685 MTH struct region *region () const;
686
687 void statusmsg (const char *msg, int color = NDI_BLACK);
688 void failmsg (const char *msg, int color = NDI_RED);
689
690 const char *query_inventory (object *who = 0, const char *indent = "");
691
692 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
693 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
694
695 // make some noise with given item into direction dir,
696 // currently only used for players to make them temporarily visible
697 // when they are invisible.
698 MTH void make_noise ();
489 699
490protected: 700protected:
491 void link (); 701 void link ();
492 void unlink (); 702 void unlink ();
493 703
494 object (); 704 object ();
495 ~object (); 705 ~object ();
706
707private:
708 object &operator =(const object &);
709 object (const object &);
496}; 710};
497 711
498// move this object to the top of its env's inventory to speed up 712// move this object to the top of its env's inventory to speed up
499// searches for it. 713// searches for it.
500static object * 714static object *
512 } 726 }
513 727
514 return ob; 728 return ob;
515} 729}
516 730
517typedef struct oblnk
518{ /* Used to link together several objects */
519 object_ptr ob;
520 struct oblnk *next;
521} objectlink;
522
523typedef struct oblinkpt
524{ /* Used to link together several object links */
525 struct oblnk *link;
526 long value; /* Used as connected value in buttons/gates */
527 struct oblinkpt *next;
528} oblinkpt;
529
530object *find_skill_by_name (object *who, const char *name); 731object *find_skill_by_name_fuzzy (object *who, const char *name);
531object *find_skill_by_name (object *who, const shstr &sh); 732object *find_skill_by_name (object *who, shstr_cmp sh);
532object *find_skill_by_number (object *who, int skillno); 733object *find_skill_by_number (object *who, int skillno);
533 734
534/* 735/*
535 * The archetype structure is a set of rules on how to generate and manipulate 736 * The archetype structure is a set of rules on how to generate and manipulate
536 * objects which point to archetypes. 737 * objects which point to archetypes.
541 */ 742 */
542 743
543INTERFACE_CLASS (archetype) 744INTERFACE_CLASS (archetype)
544struct archetype : object 745struct archetype : object
545{ 746{
747 static arch_ptr empty; // the empty_archetype
748 MTH static void gc ();
749
546 archetype (const char *name); 750 archetype (const char *name);
547 ~archetype (); 751 ~archetype ();
548 void gather_callbacks (AV *&callbacks, event_type event) const; 752 void gather_callbacks (AV *&callbacks, event_type event) const;
549 753
550 static archetype *read (object_thawer &f);
551 static archetype *get (const char *name); // find or create
552 static archetype *find (const char *name); 754 MTH static archetype *find (const_utf8_string name);
553 755
554 void link (); 756 MTH void link ();
555 void unlink (); 757 MTH void unlink ();
758
759 MTH static object *get (const char *name); // (find() || singularity)->instance()
760 MTH object *instance ();
556 761
557 object_vector_index ACC (RW, archid); // index in archvector 762 object_vector_index ACC (RW, archid); // index in archvector
558 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 763 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
559 bool ACC (RW, stub); // if true, this is an invalid archetype
560 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
561 764
562 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 765 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
563 sint8 ACC (RW, max_x), ACC (RW, max_y); 766 sint8 ACC (RW, max_x), ACC (RW, max_y);
767
768 // support for archetype loading
769 static archetype *read (object_thawer &f);
770 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
771 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
564}; 772};
773
774// compatbiility, remove once replaced by ->instance
775inline object *
776arch_to_object (archetype *at)
777{
778 return at->instance ();
779}
565 780
566inline void 781inline void
567object_freezer::put (keyword k, archetype *v) 782object_freezer::put (keyword k, archetype *v)
568{ 783{
569 put (k, v ? &v->archname : (const char *)0); 784 put (k, v ? &v->archname : (const char *)0);
575 790
576extern objectvec objects; 791extern objectvec objects;
577extern activevec actives; 792extern activevec actives;
578extern archvec archetypes; 793extern archvec archetypes;
579 794
795// "safely" iterate over inv in a way such that the current item is removable
796// quite horrible, that's why its hidden in some macro
797#define for_inv_removable(op,var) \
798 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
799
580#define for_all_objects(var) \ 800#define for_all_objects(var) \
581 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 801 for (unsigned _i = 0; _i < objects.size (); ++_i) \
582 statementvar (object *, var, objects [_i]) 802 statementvar (object *, var, objects [_i])
583 803
584#define for_all_actives(var) \ 804#define for_all_actives(var) \
585 for (unsigned _i = 0; _i < actives.size (); ++_i) \ 805 for (unsigned _i = 0; _i < actives.size (); ++_i) \
586 statementvar (object *, var, actives [_i]) 806 statementvar (object *, var, actives [_i])
587 807
588#define for_all_archetypes(var) \ 808#define for_all_archetypes(var) \
589 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ 809 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
590 statementvar (archetype *, var, archetypes [_i]) 810 statementvar (archetype *, var, archetypes [_i])
591 811
592/* Used by update_object to know if the object being passed is 812/* Used by update_object to know if the object being passed is
593 * being added or removed. 813 * being added or removed.
612 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 832 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
613 * Use for treasure chests so the new object is the highest thing 833 * Use for treasure chests so the new object is the highest thing
614 * beneath the player, but not actually above it. Note - the 834 * beneath the player, but not actually above it. Note - the
615 * map and x,y coordinates for the object to be inserted must 835 * map and x,y coordinates for the object to be inserted must
616 * match the originator. 836 * match the originator.
617 * INS_MAP_LOAD: disable lots of checkings done at insertion to
618 * speed up map loading process, as we assume the ordering in
619 * loaded map is correct.
620 * 837 *
621 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 838 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
622 * are mutually exclusive. The behaviour for passing more than one 839 * are mutually exclusive. The behaviour for passing more than one
623 * should be considered undefined - while you may notice what happens 840 * should be considered undefined - while you may notice what happens
624 * right now if you pass more than one, that could very well change 841 * right now if you pass more than one, that could very well change
627#define INS_NO_MERGE 0x0001 844#define INS_NO_MERGE 0x0001
628#define INS_ABOVE_FLOOR_ONLY 0x0002 845#define INS_ABOVE_FLOOR_ONLY 0x0002
629#define INS_NO_WALK_ON 0x0004 846#define INS_NO_WALK_ON 0x0004
630#define INS_ON_TOP 0x0008 847#define INS_ON_TOP 0x0008
631#define INS_BELOW_ORIGINATOR 0x0010 848#define INS_BELOW_ORIGINATOR 0x0010
632#define INS_MAP_LOAD 0x0020
633 849
634#define ARCH_DEPLETION "depletion" 850#define ARCH_DEPLETION "depletion"
635 851
636#endif 852#endif
637 853

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines