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.126 by root, Sat May 26 15:44:04 2007 UTC vs.
Revision 1.183 by root, Mon Sep 29 06:32:08 2008 UTC

1/* 1/*
2 * CrossFire, A Multiplayer Online RPG 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team 4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (C) 2001 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 7 *
8 * This program 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 2 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,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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, write to the Free Software 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * 20 *
22 * The authors can be reached via e-mail at crossfire@schmorp.de 21 * The authors can be reached via e-mail to <support@deliantra.net>
23 */ 22 */
24 23
25#ifndef OBJECT_H 24#ifndef OBJECT_H
26#define OBJECT_H 25#define OBJECT_H
27 26
59 58
60/* See common/item.c */ 59/* See common/item.c */
61 60
62typedef struct Body_Locations 61typedef struct Body_Locations
63{ 62{
64 const char *save_name; /* Name used to load/save it to disk */ 63 keyword save_name; /* Name used to load/save it to disk */
65 const char *use_name; /* Name used when describing an item we can use */ 64 const char *use_name; /* Name used when describing an item we can use */
66 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 */
67} Body_Locations; 66} Body_Locations;
68 67
69extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 68extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
69
70#define NUM_COINS 4 /* number of coin types */
71extern const char *const coins[NUM_COINS + 1];
70 72
71/* 73/*
72 * 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
73 * "dangling" from it; this could also end up containing 'parse errors'. 75 * "dangling" from it; this could also end up containing 'parse errors'.
74 * 76 *
75 * key and value are shared-strings. 77 * key and value are shared-strings.
76 * 78 *
77 * 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
78 * accessing the list directly. 80 * accessing the list directly.
79 * 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.
80 */ 82 */
81struct key_value 83struct key_value : slice_allocated
82{ 84{
83 key_value *next; 85 key_value *next;
84 shstr key, value; 86 shstr key, value;
85}; 87};
86 88
87struct UUID 89struct UUID
88{ 90{
89 uint64 seq; 91 uint64 seq;
92
93 static UUID cur; // last uuid generated
94 static void init ();
95 static UUID gen ();
90 96
91 UUID () { } 97 UUID () { }
92 UUID (uint64 seq) : seq(seq) { } 98 UUID (uint64 seq) : seq(seq) { }
93 operator uint64() { return seq; } 99 operator uint64() { return seq; }
94 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 }
95}; 122};
96
97extern void init_uuid ();
98extern UUID gen_uuid ();
99extern const uint64 UUID_SKIP;
100 123
101/* Definition for WILL_APPLY values. Replaces having harcoded values 124/* Definition for WILL_APPLY values. Replaces having harcoded values
102 * 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
103 * 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
104 * can_apply and will_apply? 127 * can_apply and will_apply?
132 shstr ACC (RW, name_pl); /* The plural name of the object */ 155 shstr ACC (RW, name_pl); /* The plural name of the object */
133 shstr ACC (RW, title); /* Of foo, etc */ 156 shstr ACC (RW, title); /* Of foo, etc */
134 shstr ACC (RW, race); /* human, goblin, dragon, etc */ 157 shstr ACC (RW, race); /* human, goblin, dragon, etc */
135 shstr ACC (RW, slaying); /* Which race to do double damage to */ 158 shstr ACC (RW, slaying); /* Which race to do double damage to */
136 /* If this is an exit, this is the filename */ 159 /* If this is an exit, this is the filename */
160 shstr ACC (RW, tag); // a tag used to tracking this object
137 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ 161 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
138 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */ 162 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
139 shstr ACC (RW, lore); /* Obscure information about this object, */ 163 shstr ACC (RW, lore); /* Obscure information about this object, */
140 /* To get put into books and the like. */ 164 /* To get put into books and the like. */
141 shstr ACC (RW, materialname); /* specific material name */ 165 shstr ACC (RW, materialname); /* specific material name */
151 arch_ptr ACC (RW, arch); /* Pointer to archetype */ 175 arch_ptr ACC (RW, arch); /* Pointer to archetype */
152 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */ 176 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
153 177
154 float ACC (RW, speed); /* The overall speed of this object */ 178 float ACC (RW, speed); /* The overall speed of this object */
155 float ACC (RW, speed_left); /* How much speed is left to spend this round */ 179 float ACC (RW, speed_left); /* How much speed is left to spend this round */
156 uint32 ACC (RW, nrof); /* How many of the objects */ 180 sint32 ACC (RW, nrof); /* How many of the objects */
157 181
158 /* This next big block are basically used for monsters and equipment */ 182 /* This next big block is basically used for monsters and equipment */
159 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */ 183 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
160 184
161 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
162 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
163 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
180 sint8 ACC (RW, item_power); /* power rating of the object */ 204 sint8 ACC (RW, item_power); /* power rating of the object */
181 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */ 205 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
182 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */ 206 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
183 sint32 ACC (RW, weight); /* Attributes of the object */ 207 sint32 ACC (RW, weight); /* Attributes of the object */
184 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
185 sint32 ACC (RW, carrying); /* How much weight this object contains */ 209 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
186 sint64 ACC (RW, perm_exp); /* Permanent exp */ 210 sint64 ACC (RW, perm_exp); /* Permanent exp */
187 uint32 ACC (RW, weapontype); /* type of weapon */ 211 uint32 ACC (RW, weapontype); /* type of weapon */
188 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
189 body_slot slot [NUM_BODY_LOCATIONS]; 213 body_slot slot [NUM_BODY_LOCATIONS];
190 faceidx ACC (RW, face); /* Face with colors */ 214 faceidx ACC (RW, face); /* the graphical face */
215 faceidx ACC (RW, sound); /* the sound face */
216 faceidx ACC (RW, sound_destroy); /* played on destroy */
191 living ACC (RO, stats); /* Str, Con, Dex, etc */ 217 living ACC (RO, stats); /* Str, Con, Dex, etc */
192 /* See the pod/objects.pod for more info about body locations */ 218 /* See the pod/objects.pod for more info about body locations */
193 219
194 /* Following mostly refers to fields only used for monsters */ 220 /* Following mostly refers to fields only used for monsters */
195 uint32 ACC (RW, hide); /* The object is hidden, not invisible */ 221 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
234 bool ACC (RW, flag[NUM_FLAGS]); 260 bool ACC (RW, flag[NUM_FLAGS]);
235#endif 261#endif
236 uint16 ACC (RW, animation_id);/* An index into the animation array */ 262 uint16 ACC (RW, animation_id);/* An index into the animation array */
237 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */ 263 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
238 uint8 ACC (RW, last_anim); /* last sequence used to draw face */ 264 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
239 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */
240 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */ 265 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
241 uint8 ACC (RW, will_apply); /* See crossfire.doc */ 266 uint8 ACC (RW, will_apply); /* See crossfire.doc */
267 uint16 ACC (RW, cached_sp); /* cached spell points used for a spell, used by esrv_update_spells */
268 uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
269 uint16 ACC (RW, cached_eat); /* cached food, used by esrv_update_spells */
242}; 270};
243 271
244struct object : zero_initialised, object_copy 272struct object : zero_initialised, object_copy
245{ 273{
246 // These variables are not changed by ->copy_to 274 // These variables are not changed by ->copy_to
247 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ 275 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
248 276
249 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 277 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
250 int ACC (RO, count); 278 int ACC (RO, count);
251 int ACC (RO, index); // index into objects 279 object_vector_index ACC (RO, index); // index into objects
252 int ACC (RO, active); // index into actives 280 object_vector_index ACC (RO, active); // index into actives
253 281
254 player_ptr ACC (RW, contr); /* Pointer to the player which control this object */ 282 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
255 283
256 object *ACC (RW, below); /* Pointer to the object stacked below this one */ 284 object *ACC (RW, below); /* Pointer to the object stacked below this one */
257 object *ACC (RW, above); /* Pointer to the object stacked above this one */ 285 object *ACC (RW, above); /* Pointer to the object stacked above this one */
258 /* Note: stacked in the *same* environment */ 286 /* Note: stacked in the *same* environment */
259 object *inv; /* Pointer to the first object in the inventory */ 287 object *inv; /* Pointer to the first object in the inventory */
268 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 296 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
269 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 297 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
270 client_container *seen_by; // seen by which player/container currently? 298 client_container *seen_by; // seen by which player/container currently?
271 key_value *key_values; /* Fields not explictly known by the loader. */ 299 key_value *key_values; /* Fields not explictly known by the loader. */
272 300
301 // privates / perl
302 const shstr &kv_get (const shstr &key) const;
303 void kv_del (const shstr &key);
304 void kv_set (const shstr &key, const shstr &value);
305
306 // custom extra fields management
307 struct key_value_access_proxy
308 {
309 object &ob;
310 shstr key;
311
312 key_value_access_proxy (object &ob, const shstr &key)
313 : ob (ob), key (key)
314 {
315 }
316
317 const key_value_access_proxy &operator =(const shstr &value) const
318 {
319 ob.kv_set (key, value);
320 return *this;
321 }
322
323 operator const shstr &() const { return ob.kv_get (key); }
324 operator const char *() const { return ob.kv_get (key); }
325
326 private:
327 void operator =(int);
328 };
329
330 // operator [] is too annoying to use
331 const key_value_access_proxy kv (const shstr &key)
332 {
333 return key_value_access_proxy (*this, key);
334 }
335
273 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 336 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
274 void post_load_check (); // do some adjustments after parsing 337 MTH void post_load_check (); // do some adjustments after parsing
275 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. 338 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
276 bool write (object_freezer &f); 339 bool write (object_freezer &f);
277 340
278 MTH int slottype () const; 341 MTH int slottype () const;
279 MTH static object *create (); 342 MTH static object *create ();
280 object &operator =(const object &src); 343 const mapxy &operator =(const mapxy &pos);
281 MTH void copy_to (object *dst); 344 MTH void copy_to (object *dst);
282 MTH object *clone (); // create + copy_to 345 MTH object *clone (); // create + copy_to a single object
346 MTH object *deep_clone (); // copy whole more chain and inventory
283 void do_destroy (); 347 void do_destroy ();
284 void gather_callbacks (AV *&callbacks, event_type event) const; 348 void gather_callbacks (AV *&callbacks, event_type event) const;
285 MTH void destroy (bool destroy_inventory = false); 349 MTH void destroy (bool destroy_inventory = false);
286 350
287 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 351 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
288 MTH void destroy_inv (bool drop_to_ground = false); 352 MTH void destroy_inv (bool drop_to_ground = false);
289 MTH object *insert (object *item); // insert into inventory 353 MTH object *insert (object *item); // insert into inventory
354 MTH void play_sound (faceidx sound);
355
290 void do_remove (); 356 void do_remove ();
291 MTH void remove () 357 MTH void remove ()
292 { 358 {
293 if (!flag [FLAG_REMOVED]) 359 if (!flag [FLAG_REMOVED])
294 do_remove (); 360 do_remove ();
361 }
362
363 MTH bool blocked (maptile *m, int x, int y) const;
364
365 void move_to (const mapxy &pos)
366 {
367 remove ();
368 *this = pos;
369 insert_at (this, this);
295 } 370 }
296 371
297 static bool can_merge_slow (object *op1, object *op2); 372 static bool can_merge_slow (object *op1, object *op2);
298 373
299 // this is often used in time-critical code, so optimise 374 // this is often used in time-critical code, so optimise
312 MTH void open_container (object *new_container); 387 MTH void open_container (object *new_container);
313 MTH void close_container () 388 MTH void close_container ()
314 { 389 {
315 open_container (0); 390 open_container (0);
316 } 391 }
392
393 MTH object *force_find (const shstr name);
394 MTH void force_add (const shstr name, int duration = 0);
317 395
318 // overwrite the attachable should_invoke function with a version that also checks ev_want_type 396 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
319 bool should_invoke (event_type event) 397 bool should_invoke (event_type event)
320 { 398 {
321 return ev_want_event [event] || ev_want_type [type] || cb; 399 return ev_want_event [event] || ev_want_type [type] || cb;
336 // info must hold 256 * 3 bytes currently 414 // info must hold 256 * 3 bytes currently
337 const char *debug_desc (char *info) const; 415 const char *debug_desc (char *info) const;
338 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 416 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
339 const char *flag_desc (char *desc, int len) const; 417 const char *flag_desc (char *desc, int len) const;
340 418
419 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
420 MTH object *split (sint32 nr = 1); // return 0 on failure
421
341 int number_of () const 422 MTH int number_of () const
342 { 423 {
343 return nrof ? nrof : 1; 424 return nrof ? nrof : 1;
344 } 425 }
345 426
346 uint64 total_weight () const 427 MTH sint32 total_weight () const
347 { 428 {
348 return weight * number_of (); 429 return (weight + carrying) * number_of ();
349 } 430 }
431
432 MTH void update_weight ();
350 433
351 // return the dominant material of this item, always return something 434 // return the dominant material of this item, always return something
352 const materialtype_t *dominant_material () const; 435 const materialtype_t *dominant_material () const;
353 436
354 // return the volume of this object in cm³ 437 // return the volume of this object in cm³
355 uint64 volume () const 438 MTH uint64 volume () const
356 { 439 {
357 return total_weight () 440 return total_weight ()
358 * 1000 441 * 1000
359 * (type == CONTAINER ? 1000 : 1) 442 * (type == CONTAINER ? 1000 : 1)
360 / dominant_material ()->density; 443 / dominant_material ()->density;
361 } 444 }
362 445
446 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
363 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; } 447 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
364 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET 448 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
365 || type == CLOAK || type == BOOTS || type == GLOVES 449 || type == CLOAK || type == BOOTS || type == GLOVES
366 || type == BRACERS || type == GIRDLE; } 450 || type == BRACERS || type == GIRDLE; }
367 MTH bool is_alive () const { return (type == PLAYER 451 MTH bool is_alive () const { return (type == PLAYER
377 461
378 // temporary: wether the object can be saved in a map file 462 // temporary: wether the object can be saved in a map file
379 // contr => is a player 463 // contr => is a player
380 // head => only save head of a multitile object 464 // head => only save head of a multitile object
381 // owner => can not reference owner yet 465 // owner => can not reference owner yet
382 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } 466 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
383 467
384 /* This return true if object has still randomitems which 468 /* This return true if object has still randomitems which
385 * could be expanded. 469 * could be expanded.
386 */ 470 */
387 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 471 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
388 472
473 MTH bool has_dialogue () const { return *&msg == '@'; }
474
475 // returns the outermost owner, never returns 0
476 MTH object *outer_owner ()
477 {
478 object *op;
479
480 for (op = this; op->owner; op = op->owner)
481 ;
482
483 return op;
484 }
485
486 // returns the outermost environment, never returns 0
487 MTH object *outer_env ()
488 {
489 object *op;
490
491 for (op = this; op->env; op = op->env)
492 ;
493
494 return op;
495 }
496
389 // returns the player that has this object in his inventory, or 0 497 // returns the player that has this object in his inventory, or 0
498 // we assume the player is always the outer env
390 MTH object *in_player () const 499 MTH object *in_player ()
391 { 500 {
392 for (object *op = env; op; op = op->env) 501 object *op = outer_env ();
393 if (op->type == PLAYER)
394 return op;
395 502
396 return 0; 503 return op->type == PLAYER ? op : 0;
397 } 504 }
398 505
399 // "temporary" helper function 506 // "temporary" helper function
400 MTH object *head_ () 507 MTH object *head_ ()
401 { 508 {
402 return head ? head : this; 509 return head ? head : this;
403 } 510 }
511
512 MTH bool is_head ()
513 {
514 return head_ () == this;
515 }
516
517 MTH bool is_on_map () const
518 {
519 return !env && !flag [FLAG_REMOVED];
520 }
521
522 // returns the player that cna see this object, if any
523 MTH object *visible_to () const;
404 524
405 MTH std::string long_desc (object *who = 0); 525 MTH std::string long_desc (object *who = 0);
406 MTH std::string describe_monster (object *who = 0); 526 MTH std::string describe_monster (object *who = 0);
407 MTH std::string describe_item (object *who = 0); 527 MTH std::string describe_item (object *who = 0);
408 MTH std::string describe (object *who = 0); 528 MTH std::string describe (object *who = 0);
416 MTH void create_treasure (treasurelist *tl, int flags = 0); 536 MTH void create_treasure (treasurelist *tl, int flags = 0);
417 537
418 // insert object at same map position as 'where' 538 // insert object at same map position as 'where'
419 // handles both inventory and map "positions" 539 // handles both inventory and map "positions"
420 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 540 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
541 MTH void drop_unpaid_items ();
421 542
422 MTH void activate (); 543 MTH void activate ();
423 MTH void deactivate (); 544 MTH void deactivate ();
424 MTH void activate_recursive (); 545 MTH void activate_recursive ();
425 MTH void deactivate_recursive (); 546 MTH void deactivate_recursive ();
426 547
427 // set the givne flag on all objects in the inventory recursively 548 // set the given flag on all objects in the inventory recursively
428 MTH void set_flag_inv (int flag, int value = 1); 549 MTH void set_flag_inv (int flag, int value = 1);
429 550
430 void enter_exit (object *exit);//Perl 551 void enter_exit (object *exit);//Perl
431 MTH void enter_map (maptile *newmap, int x, int y); 552 MTH void enter_map (maptile *newmap, int x, int y);
553 void player_goto (const char *path, int x, int y); // only for players
432 554
433 // returns the mapspace this object is in 555 // returns the mapspace this object is in
434 mapspace &ms () const; 556 mapspace &ms () const;
435 557
436 // fully recursive iterator 558 // fully recursive iterator
472 { 594 {
473 return this; 595 return this;
474 } 596 }
475 597
476 /* This returns TRUE if the object is something that 598 /* This returns TRUE if the object is something that
477 * should be displayed in the floorbox/inventory window 599 * a client might want to know about.
478 */ 600 */
479 MTH bool client_visible () const 601 MTH bool client_visible () const
480 { 602 {
481 return !invisible && type != PLAYER; 603 return !invisible && type != PLAYER;
482 } 604 }
483 605
606 // the client does nrof * this weight
607 MTH sint32 client_weight () const
608 {
609 return weight + carrying;
610 }
611
484 MTH struct region *region () const; 612 MTH struct region *region () const;
485 613
614 void statusmsg (const char *msg, int color = NDI_BLACK);
615 void failmsg (const char *msg, int color = NDI_RED);
616
617 const char *query_inventory (object *who = 0, const char *indent = "");
618
619 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
620 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
621
486protected: 622protected:
487 friend struct archetype;
488
489 void link (); 623 void link ();
490 void unlink (); 624 void unlink ();
491 625
492 object (); 626 object ();
493 ~object (); 627 ~object ();
628
629private:
630 object &operator =(const object &);
631 object (const object &);
494}; 632};
495 633
496// move this object to the top of its env's inventory to speed up 634// move this object to the top of its env's inventory to speed up
497// searches for it. 635// searches for it.
498static object * 636static object *
510 } 648 }
511 649
512 return ob; 650 return ob;
513} 651}
514 652
515typedef object_vector<object, &object::index > objectvec;
516typedef object_vector<object, &object::active> activevec;
517
518extern objectvec objects;
519extern activevec actives;
520
521#define for_all_objects(var) \
522 for (unsigned _i = 0; _i < objects.size (); ++_i) \
523 declvar (object *, var, objects [_i])
524
525#define for_all_actives(var) \
526 for (unsigned _i = 0; _i < actives.size (); ++_i) \
527 declvar (object *, var, actives [_i])
528
529typedef struct oblnk 653typedef struct oblnk
530{ /* Used to link together several objects */ 654{ /* Used to link together several objects */
531 object_ptr ob; 655 object_ptr ob;
532 struct oblnk *next; 656 struct oblnk *next;
533} objectlink; 657} objectlink;
534 658
535typedef struct oblinkpt 659typedef struct oblinkpt
536{ /* Used to link together several object links */ 660{ /* Used to link together several object links */
537 struct oblnk *link; 661 struct oblnk *link;
538 long value; /* Used as connected value in buttons/gates */ 662 sint32 value; /* Used as connected value in buttons/gates */
539 struct oblinkpt *next; 663 struct oblinkpt *next;
540} oblinkpt; 664} oblinkpt;
541 665
542object *find_skill_by_name (object *who, const char *name); 666object *find_skill_by_name (object *who, const char *name);
543object *find_skill_by_name (object *who, const shstr &sh); 667object *find_skill_by_name (object *who, const shstr &sh);
551 * object and pointers. This structure should get removed, and just replaced 675 * object and pointers. This structure should get removed, and just replaced
552 * by the object structure 676 * by the object structure
553 */ 677 */
554 678
555INTERFACE_CLASS (archetype) 679INTERFACE_CLASS (archetype)
556struct archetype : zero_initialised, attachable 680struct archetype : object
557{ 681{
558 archetype (); 682 static arch_ptr empty; // the empty_archetype
683 MTH static void gc ();
684
685 archetype (const char *name);
559 ~archetype (); 686 ~archetype ();
560 void gather_callbacks (AV *&callbacks, event_type event) const; 687 void gather_callbacks (AV *&callbacks, event_type event) const;
561 688
689 MTH static archetype *find (const_utf8_string name);
690
691 MTH void link ();
692 MTH void unlink ();
693
694 MTH static object *get (const char *name); // (find() || singularity)->instance()
695 MTH object *instance ();
696
697 object_vector_index ACC (RW, archid); // index in archvector
698 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
699
700 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
701 sint8 ACC (RW, max_x), ACC (RW, max_y);
702
703 // support for archetype loading
562 static archetype *read (object_thawer &f); 704 static archetype *read (object_thawer &f);
563 static archetype *get (const char *name); // find or create 705 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
564 static archetype *find (const char *name); 706 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
565
566 void hash_add (); // add to hashtable
567 void hash_del (); // remove from hashtable
568
569 shstr ACC (RW, name); /* More definite name, like "generate_kobold" */
570 struct archetype *ACC (RW, next); /* Next archetype in a linked list */
571 struct archetype *ACC (RW, head); /* The main part of a linked object */
572 struct archetype *ACC (RW, more); /* Next part of a linked object */
573 object ACC (RO, clone); /* An object from which to do ->copy_to () */
574 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
575 bool ACC (RW, linked); // linked into list of heads
576 sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is
577 * in comparison to the head.
578 */
579}; 707};
708
709// compatbiility, remove once replaced by ->instance
710inline object *
711arch_to_object (archetype *at)
712{
713 return at->instance ();
714}
715
716inline void
717object_freezer::put (keyword k, archetype *v)
718{
719 put (k, v ? &v->archname : (const char *)0);
720}
721
722typedef object_vector<object, &object::index > objectvec;
723typedef object_vector<object, &object::active> activevec;
724typedef object_vector<archetype, &archetype::archid> archvec;
725
726extern objectvec objects;
727extern activevec actives;
728extern archvec archetypes;
729
730// "safely" iterate over inv in a way such that the current item is removable
731// quite horrible, thats why its hidden in some macro
732#define for_inv_removable(op,var) \
733 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
734
735#define for_all_objects(var) \
736 for (unsigned _i = 0; _i < objects.size (); ++_i) \
737 statementvar (object *, var, objects [_i])
738
739#define for_all_actives(var) \
740 for (unsigned _i = 0; _i < actives.size (); ++_i) \
741 statementvar (object *, var, actives [_i])
742
743#define for_all_archetypes(var) \
744 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
745 statementvar (archetype *, var, archetypes [_i])
580 746
581/* Used by update_object to know if the object being passed is 747/* Used by update_object to know if the object being passed is
582 * being added or removed. 748 * being added or removed.
583 */ 749 */
584#define UP_OBJ_INSERT 1 750#define UP_OBJ_INSERT 1
601 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 767 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
602 * Use for treasure chests so the new object is the highest thing 768 * Use for treasure chests so the new object is the highest thing
603 * beneath the player, but not actually above it. Note - the 769 * beneath the player, but not actually above it. Note - the
604 * map and x,y coordinates for the object to be inserted must 770 * map and x,y coordinates for the object to be inserted must
605 * match the originator. 771 * match the originator.
606 * INS_MAP_LOAD: disable lots of checkings done at insertion to
607 * speed up map loading process, as we assume the ordering in
608 * loaded map is correct.
609 * 772 *
610 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 773 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
611 * are mutually exclusive. The behaviour for passing more than one 774 * are mutually exclusive. The behaviour for passing more than one
612 * should be considered undefined - while you may notice what happens 775 * should be considered undefined - while you may notice what happens
613 * right now if you pass more than one, that could very well change 776 * right now if you pass more than one, that could very well change
616#define INS_NO_MERGE 0x0001 779#define INS_NO_MERGE 0x0001
617#define INS_ABOVE_FLOOR_ONLY 0x0002 780#define INS_ABOVE_FLOOR_ONLY 0x0002
618#define INS_NO_WALK_ON 0x0004 781#define INS_NO_WALK_ON 0x0004
619#define INS_ON_TOP 0x0008 782#define INS_ON_TOP 0x0008
620#define INS_BELOW_ORIGINATOR 0x0010 783#define INS_BELOW_ORIGINATOR 0x0010
621#define INS_MAP_LOAD 0x0020
622 784
623#define ARCH_SINGULARITY "singularity"
624#define ARCH_DETECT_MAGIC "detect_magic"
625#define ARCH_DEPLETION "depletion" 785#define ARCH_DEPLETION "depletion"
626#define ARCH_SYMPTOM "symptom"
627 786
628#endif 787#endif
629 788

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines