1 | /* |
1 | /* |
2 | * CrossFire, A Multiplayer Online RPG |
2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
3 | * |
3 | * |
4 | * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT 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 | * Crossfire TRT 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 <crossfire@schmorp.de> |
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 | |
62 | typedef struct Body_Locations |
61 | typedef 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 | |
69 | extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; |
68 | extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; |
… | |
… | |
107 | #define WILL_APPLY_TREASURE 0x02 |
106 | #define WILL_APPLY_TREASURE 0x02 |
108 | #define WILL_APPLY_EARTHWALL 0x04 |
107 | #define WILL_APPLY_EARTHWALL 0x04 |
109 | #define WILL_APPLY_DOOR 0x08 |
108 | #define WILL_APPLY_DOOR 0x08 |
110 | #define WILL_APPLY_FOOD 0x10 |
109 | #define WILL_APPLY_FOOD 0x10 |
111 | |
110 | |
112 | /* However, if you're keeping a pointer of some sort, you probably |
|
|
113 | * don't just want it copied, so you'll need to add to common/object.C, |
|
|
114 | * e.g. ->copy_to () |
|
|
115 | */ |
|
|
116 | |
|
|
117 | struct body_slot |
111 | struct body_slot |
118 | { |
112 | { |
119 | signed char info:4; /* body info as loaded from the file */ |
113 | signed char info:4; /* body info as loaded from the file */ |
120 | signed char used:4; /* Calculated value based on items equipped */ |
114 | signed char used:4; /* Calculated value based on items equipped */ |
121 | }; |
115 | }; |
… | |
… | |
137 | shstr ACC (RW, name_pl); /* The plural name of the object */ |
131 | shstr ACC (RW, name_pl); /* The plural name of the object */ |
138 | shstr ACC (RW, title); /* Of foo, etc */ |
132 | shstr ACC (RW, title); /* Of foo, etc */ |
139 | shstr ACC (RW, race); /* human, goblin, dragon, etc */ |
133 | shstr ACC (RW, race); /* human, goblin, dragon, etc */ |
140 | shstr ACC (RW, slaying); /* Which race to do double damage to */ |
134 | shstr ACC (RW, slaying); /* Which race to do double damage to */ |
141 | /* If this is an exit, this is the filename */ |
135 | /* If this is an exit, this is the filename */ |
|
|
136 | shstr ACC (RW, tag); // a tag used to tracking this object |
142 | shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ |
137 | shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ |
143 | shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */ |
138 | shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */ |
144 | shstr ACC (RW, lore); /* Obscure information about this object, */ |
139 | shstr ACC (RW, lore); /* Obscure information about this object, */ |
145 | /* To get put into books and the like. */ |
140 | /* To get put into books and the like. */ |
146 | shstr ACC (RW, materialname); /* specific material name */ |
141 | shstr ACC (RW, materialname); /* specific material name */ |
… | |
… | |
190 | sint32 ACC (RW, carrying); /* How much weight this object contains */ |
185 | sint32 ACC (RW, carrying); /* How much weight this object contains */ |
191 | sint64 ACC (RW, perm_exp); /* Permanent exp */ |
186 | sint64 ACC (RW, perm_exp); /* Permanent exp */ |
192 | uint32 ACC (RW, weapontype); /* type of weapon */ |
187 | uint32 ACC (RW, weapontype); /* type of weapon */ |
193 | uint32 ACC (RW, tooltype); /* type of tool or build facility */ |
188 | uint32 ACC (RW, tooltype); /* type of tool or build facility */ |
194 | body_slot slot [NUM_BODY_LOCATIONS]; |
189 | body_slot slot [NUM_BODY_LOCATIONS]; |
195 | faceidx ACC (RW, face); /* Face with colors */ |
190 | faceidx ACC (RW, face); /* the graphical face */ |
|
|
191 | faceidx ACC (RW, sound); /* the sound face */ |
|
|
192 | faceidx ACC (RW, sound_destroy); /* played on destroy */ |
196 | living ACC (RO, stats); /* Str, Con, Dex, etc */ |
193 | living ACC (RO, stats); /* Str, Con, Dex, etc */ |
197 | /* See the pod/objects.pod for more info about body locations */ |
194 | /* See the pod/objects.pod for more info about body locations */ |
198 | |
195 | |
199 | /* Following mostly refers to fields only used for monsters */ |
196 | /* Following mostly refers to fields only used for monsters */ |
200 | uint32 ACC (RW, hide); /* The object is hidden, not invisible */ |
197 | uint32 ACC (RW, hide); /* The object is hidden, not invisible */ |
… | |
… | |
251 | // These variables are not changed by ->copy_to |
248 | // These variables are not changed by ->copy_to |
252 | maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ |
249 | maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ |
253 | |
250 | |
254 | UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. |
251 | UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. |
255 | int ACC (RO, count); |
252 | int ACC (RO, count); |
256 | int ACC (RO, index); // index into objects |
253 | object_vector_index ACC (RO, index); // index into objects |
257 | int ACC (RO, active); // index into actives |
254 | object_vector_index ACC (RO, active); // index into actives |
258 | |
255 | |
259 | player_ptr ACC (RW, contr); /* Pointer to the player which control this object */ |
256 | player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */ |
260 | |
257 | |
261 | object *ACC (RW, below); /* Pointer to the object stacked below this one */ |
258 | object *ACC (RW, below); /* Pointer to the object stacked below this one */ |
262 | object *ACC (RW, above); /* Pointer to the object stacked above this one */ |
259 | object *ACC (RW, above); /* Pointer to the object stacked above this one */ |
263 | /* Note: stacked in the *same* environment */ |
260 | /* Note: stacked in the *same* environment */ |
264 | object *inv; /* Pointer to the first object in the inventory */ |
261 | object *inv; /* Pointer to the first object in the inventory */ |
… | |
… | |
274 | object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different |
271 | object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different |
275 | client_container *seen_by; // seen by which player/container currently? |
272 | client_container *seen_by; // seen by which player/container currently? |
276 | key_value *key_values; /* Fields not explictly known by the loader. */ |
273 | key_value *key_values; /* Fields not explictly known by the loader. */ |
277 | |
274 | |
278 | bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all |
275 | bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all |
279 | void post_load_check (); // do some adjustments after parsing |
276 | MTH void post_load_check (); // do some adjustments after parsing |
280 | static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. |
277 | static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. |
281 | bool write (object_freezer &f); |
278 | bool write (object_freezer &f); |
282 | |
279 | |
283 | MTH int slottype () const; |
280 | MTH int slottype () const; |
284 | MTH static object *create (); |
281 | MTH static object *create (); |
|
|
282 | const mapxy &operator =(const mapxy &pos); |
285 | object &operator =(const object &src); |
283 | object &operator =(const object &src); |
286 | MTH void copy_to (object *dst); |
284 | MTH void copy_to (object *dst); |
287 | MTH object *clone (); // create + copy_to |
285 | MTH object *clone (); // create + copy_to |
288 | void do_destroy (); |
286 | void do_destroy (); |
289 | void gather_callbacks (AV *&callbacks, event_type event) const; |
287 | void gather_callbacks (AV *&callbacks, event_type event) const; |
290 | MTH void destroy (bool destroy_inventory = false); |
288 | MTH void destroy (bool destroy_inventory = false); |
291 | |
289 | |
292 | // recursively destroy all objects in inventory, optionally dropping them to the ground instead |
290 | // recursively destroy all objects in inventory, optionally dropping them to the ground instead |
293 | MTH void destroy_inv (bool drop_to_ground = false); |
291 | MTH void destroy_inv (bool drop_to_ground = false); |
294 | MTH object *insert (object *item); // insert into inventory |
292 | MTH object *insert (object *item); // insert into inventory |
|
|
293 | MTH void play_sound (faceidx sound) const; |
|
|
294 | |
295 | void do_remove (); |
295 | void do_remove (); |
296 | MTH void remove () |
296 | MTH void remove () |
297 | { |
297 | { |
298 | if (!flag [FLAG_REMOVED]) |
298 | if (!flag [FLAG_REMOVED]) |
299 | do_remove (); |
299 | do_remove (); |
|
|
300 | } |
|
|
301 | |
|
|
302 | void move_to (const mapxy &pos) |
|
|
303 | { |
|
|
304 | remove (); |
|
|
305 | *this = pos; |
|
|
306 | insert_at (this, this); |
300 | } |
307 | } |
301 | |
308 | |
302 | static bool can_merge_slow (object *op1, object *op2); |
309 | static bool can_merge_slow (object *op1, object *op2); |
303 | |
310 | |
304 | // this is often used in time-critical code, so optimise |
311 | // this is often used in time-critical code, so optimise |
… | |
… | |
318 | MTH void close_container () |
325 | MTH void close_container () |
319 | { |
326 | { |
320 | open_container (0); |
327 | open_container (0); |
321 | } |
328 | } |
322 | |
329 | |
|
|
330 | MTH object *force_find (const shstr name); |
|
|
331 | MTH void force_add (const shstr name, int duration = 0); |
|
|
332 | |
323 | // overwrite the attachable invoke function with a version that also checks ev_want_type |
333 | // overwrite the attachable should_invoke function with a version that also checks ev_want_type |
324 | bool invoke (event_type event, ...) |
334 | bool should_invoke (event_type event) |
325 | { |
335 | { |
326 | if (ev_want_event [event] || ev_want_type [type] || cb) |
336 | return ev_want_event [event] || ev_want_type [type] || cb; |
327 | { |
|
|
328 | va_list ap; |
|
|
329 | va_start (ap, event); |
|
|
330 | vinvoke (event, ap); |
|
|
331 | va_end (ap); |
|
|
332 | } |
|
|
333 | } |
337 | } |
334 | |
338 | |
335 | MTH void instantiate (); |
339 | MTH void instantiate (); |
336 | |
340 | |
337 | // recalculate all stats |
341 | // recalculate all stats |
… | |
… | |
388 | |
392 | |
389 | // temporary: wether the object can be saved in a map file |
393 | // temporary: wether the object can be saved in a map file |
390 | // contr => is a player |
394 | // contr => is a player |
391 | // head => only save head of a multitile object |
395 | // head => only save head of a multitile object |
392 | // owner => can not reference owner yet |
396 | // owner => can not reference owner yet |
393 | MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } |
397 | MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; } |
394 | |
398 | |
395 | /* This return true if object has still randomitems which |
399 | /* This return true if object has still randomitems which |
396 | * could be expanded. |
400 | * could be expanded. |
397 | */ |
401 | */ |
398 | MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } |
402 | MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } |
… | |
… | |
409 | |
413 | |
410 | // "temporary" helper function |
414 | // "temporary" helper function |
411 | MTH object *head_ () |
415 | MTH object *head_ () |
412 | { |
416 | { |
413 | return head ? head : this; |
417 | return head ? head : this; |
|
|
418 | } |
|
|
419 | |
|
|
420 | MTH bool is_head () |
|
|
421 | { |
|
|
422 | return head_ () == this; |
414 | } |
423 | } |
415 | |
424 | |
416 | MTH std::string long_desc (object *who = 0); |
425 | MTH std::string long_desc (object *who = 0); |
417 | MTH std::string describe_monster (object *who = 0); |
426 | MTH std::string describe_monster (object *who = 0); |
418 | MTH std::string describe_item (object *who = 0); |
427 | MTH std::string describe_item (object *who = 0); |
… | |
… | |
427 | MTH void create_treasure (treasurelist *tl, int flags = 0); |
436 | MTH void create_treasure (treasurelist *tl, int flags = 0); |
428 | |
437 | |
429 | // insert object at same map position as 'where' |
438 | // insert object at same map position as 'where' |
430 | // handles both inventory and map "positions" |
439 | // handles both inventory and map "positions" |
431 | MTH object *insert_at (object *where, object *originator = 0, int flags = 0); |
440 | MTH object *insert_at (object *where, object *originator = 0, int flags = 0); |
|
|
441 | MTH void drop_unpaid_items (); |
432 | |
442 | |
433 | MTH void activate (); |
443 | MTH void activate (); |
434 | MTH void deactivate (); |
444 | MTH void deactivate (); |
435 | MTH void activate_recursive (); |
445 | MTH void activate_recursive (); |
436 | MTH void deactivate_recursive (); |
446 | MTH void deactivate_recursive (); |
… | |
… | |
492 | return !invisible && type != PLAYER; |
502 | return !invisible && type != PLAYER; |
493 | } |
503 | } |
494 | |
504 | |
495 | MTH struct region *region () const; |
505 | MTH struct region *region () const; |
496 | |
506 | |
|
|
507 | void statusmsg (const char *msg, int color = NDI_BLACK); |
|
|
508 | void failmsg (const char *msg, int color = NDI_RED); |
|
|
509 | |
|
|
510 | MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference |
|
|
511 | static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible |
|
|
512 | |
497 | protected: |
513 | protected: |
498 | friend struct archetype; |
|
|
499 | |
|
|
500 | void link (); |
514 | void link (); |
501 | void unlink (); |
515 | void unlink (); |
502 | |
516 | |
503 | object (); |
517 | object (); |
504 | ~object (); |
518 | ~object (); |
505 | }; |
519 | }; |
… | |
… | |
520 | ob->env->inv = ob; |
534 | ob->env->inv = ob; |
521 | } |
535 | } |
522 | |
536 | |
523 | return ob; |
537 | return ob; |
524 | } |
538 | } |
525 | |
|
|
526 | typedef object_vector<object, &object::index > objectvec; |
|
|
527 | typedef object_vector<object, &object::active> activevec; |
|
|
528 | |
|
|
529 | extern objectvec objects; |
|
|
530 | extern activevec actives; |
|
|
531 | |
|
|
532 | #define for_all_objects(var) \ |
|
|
533 | for (unsigned _i = 0; _i < objects.size (); ++_i) \ |
|
|
534 | declvar (object *, var, objects [_i]) |
|
|
535 | |
|
|
536 | #define for_all_actives(var) \ |
|
|
537 | for (unsigned _i = 0; _i < actives.size (); ++_i) \ |
|
|
538 | declvar (object *, var, actives [_i]) |
|
|
539 | |
539 | |
540 | typedef struct oblnk |
540 | typedef struct oblnk |
541 | { /* Used to link together several objects */ |
541 | { /* Used to link together several objects */ |
542 | object_ptr ob; |
542 | object_ptr ob; |
543 | struct oblnk *next; |
543 | struct oblnk *next; |
… | |
… | |
562 | * object and pointers. This structure should get removed, and just replaced |
562 | * object and pointers. This structure should get removed, and just replaced |
563 | * by the object structure |
563 | * by the object structure |
564 | */ |
564 | */ |
565 | |
565 | |
566 | INTERFACE_CLASS (archetype) |
566 | INTERFACE_CLASS (archetype) |
567 | struct archetype : zero_initialised, attachable |
567 | struct archetype : object |
568 | { |
568 | { |
569 | archetype (); |
569 | archetype (const char *name); |
570 | ~archetype (); |
570 | ~archetype (); |
571 | void gather_callbacks (AV *&callbacks, event_type event) const; |
571 | void gather_callbacks (AV *&callbacks, event_type event) const; |
572 | |
572 | |
573 | static archetype *read (object_thawer &f); |
573 | static archetype *read (object_thawer &f); |
|
|
574 | |
574 | static archetype *get (const char *name); // find or create |
575 | MTH static archetype *get (const_utf8_string name); // find or create |
575 | static archetype *find (const char *name); |
576 | MTH static archetype *find (const_utf8_string name); |
576 | |
577 | |
577 | void hash_add (); // add to hashtable |
578 | MTH void link (); |
578 | void hash_del (); // remove from hashtable |
579 | MTH void unlink (); |
579 | |
580 | |
|
|
581 | object_vector_index ACC (RW, archid); // index in archvector |
580 | shstr ACC (RW, name); /* More definite name, like "generate_kobold" */ |
582 | shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ |
581 | struct archetype *ACC (RW, next); /* Next archetype in a linked list */ |
583 | bool ACC (RW, stub); // if true, this is an invalid archetype |
582 | struct archetype *ACC (RW, head); /* The main part of a linked object */ |
584 | |
583 | struct archetype *ACC (RW, more); /* Next part of a linked object */ |
585 | sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ |
584 | object ACC (RO, clone); /* An object from which to do ->copy_to () */ |
586 | sint8 ACC (RW, max_x), ACC (RW, max_y); |
585 | uint32 ACC (RW, editable); /* editable flags (mainly for editor) */ |
|
|
586 | bool ACC (RW, linked); // linked into list of heads |
|
|
587 | sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is |
|
|
588 | * in comparison to the head. |
|
|
589 | */ |
|
|
590 | }; |
587 | }; |
|
|
588 | |
|
|
589 | inline void |
|
|
590 | object_freezer::put (keyword k, archetype *v) |
|
|
591 | { |
|
|
592 | put (k, v ? &v->archname : (const char *)0); |
|
|
593 | } |
|
|
594 | |
|
|
595 | typedef object_vector<object, &object::index > objectvec; |
|
|
596 | typedef object_vector<object, &object::active> activevec; |
|
|
597 | typedef object_vector<archetype, &archetype::archid> archvec; |
|
|
598 | |
|
|
599 | extern objectvec objects; |
|
|
600 | extern activevec actives; |
|
|
601 | extern archvec archetypes; |
|
|
602 | |
|
|
603 | #define for_all_objects(var) \ |
|
|
604 | for (unsigned _i = 0; _i < objects.size (); ++_i) \ |
|
|
605 | statementvar (object *, var, objects [_i]) |
|
|
606 | |
|
|
607 | #define for_all_actives(var) \ |
|
|
608 | for (unsigned _i = 0; _i < actives.size (); ++_i) \ |
|
|
609 | statementvar (object *, var, actives [_i]) |
|
|
610 | |
|
|
611 | #define for_all_archetypes(var) \ |
|
|
612 | for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ |
|
|
613 | statementvar (archetype *, var, archetypes [_i]) |
591 | |
614 | |
592 | /* Used by update_object to know if the object being passed is |
615 | /* Used by update_object to know if the object being passed is |
593 | * being added or removed. |
616 | * being added or removed. |
594 | */ |
617 | */ |
595 | #define UP_OBJ_INSERT 1 |
618 | #define UP_OBJ_INSERT 1 |
… | |
… | |
629 | #define INS_NO_WALK_ON 0x0004 |
652 | #define INS_NO_WALK_ON 0x0004 |
630 | #define INS_ON_TOP 0x0008 |
653 | #define INS_ON_TOP 0x0008 |
631 | #define INS_BELOW_ORIGINATOR 0x0010 |
654 | #define INS_BELOW_ORIGINATOR 0x0010 |
632 | #define INS_MAP_LOAD 0x0020 |
655 | #define INS_MAP_LOAD 0x0020 |
633 | |
656 | |
634 | #define ARCH_SINGULARITY "singularity" |
|
|
635 | #define ARCH_DETECT_MAGIC "detect_magic" |
|
|
636 | #define ARCH_DEPLETION "depletion" |
657 | #define ARCH_DEPLETION "depletion" |
637 | #define ARCH_SYMPTOM "symptom" |
|
|
638 | |
658 | |
639 | #endif |
659 | #endif |
640 | |
660 | |