1 | /* |
1 | /* |
2 | * CrossFire, A Multiplayer Online RPG |
2 | * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game. |
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 it |
9 | * it under the terms of the GNU General Public License as published by |
9 | * under the terms of the GNU General Public License as published by the Free |
10 | * the Free Software Foundation; either version 2 of the License, or |
10 | * Software Foundation; either version 2 of the License, or (at your option) |
11 | * (at your option) any later version. |
11 | * 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, but |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 | * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
16 | * GNU General Public License for more details. |
16 | * 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 along |
19 | * along with this program; if not, write to the Free Software |
19 | * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51 |
20 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
20 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
21 | * |
21 | * |
22 | * The authors can be reached via e-mail at crossfire@schmorp.de |
22 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
23 | */ |
23 | */ |
24 | |
24 | |
25 | #ifndef OBJECT_H |
25 | #ifndef OBJECT_H |
26 | #define OBJECT_H |
26 | #define OBJECT_H |
27 | |
27 | |
… | |
… | |
30 | #include "cfperl.h" |
30 | #include "cfperl.h" |
31 | #include "shstr.h" |
31 | #include "shstr.h" |
32 | |
32 | |
33 | typedef int tag_t; |
33 | typedef int tag_t; |
34 | |
34 | |
35 | #define NUM_BODY_LOCATIONS 14 |
35 | enum { |
36 | #define BODY_ARMS 1 |
36 | body_skill, |
|
|
37 | body_combat, |
|
|
38 | body_range, |
|
|
39 | body_shield, |
|
|
40 | body_arm, |
|
|
41 | body_torso, |
|
|
42 | body_head, |
|
|
43 | body_neck, |
|
|
44 | body_finger, |
|
|
45 | body_shoulder, |
|
|
46 | body_foot, |
|
|
47 | body_hand, |
|
|
48 | body_wrist, |
|
|
49 | body_waist, |
|
|
50 | NUM_BODY_LOCATIONS |
|
|
51 | }; |
|
|
52 | |
|
|
53 | enum slottype_t |
|
|
54 | { |
|
|
55 | slot_none, |
|
|
56 | slot_combat, |
|
|
57 | slot_ranged, |
|
|
58 | }; |
37 | |
59 | |
38 | /* See common/item.c */ |
60 | /* See common/item.c */ |
39 | |
61 | |
40 | typedef struct Body_Locations |
62 | typedef struct Body_Locations |
41 | { |
63 | { |
42 | const char *save_name; /* Name used to load/save it to disk */ |
64 | keyword save_name; /* Name used to load/save it to disk */ |
43 | const char *use_name; /* Name used when describing an item we can use */ |
65 | const char *use_name; /* Name used when describing an item we can use */ |
44 | const char *nonuse_name; /* Name to describe objects we can't use */ |
66 | const char *nonuse_name; /* Name to describe objects we can't use */ |
45 | } Body_Locations; |
67 | } Body_Locations; |
46 | |
68 | |
47 | extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; |
69 | extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; |
… | |
… | |
85 | #define WILL_APPLY_TREASURE 0x02 |
107 | #define WILL_APPLY_TREASURE 0x02 |
86 | #define WILL_APPLY_EARTHWALL 0x04 |
108 | #define WILL_APPLY_EARTHWALL 0x04 |
87 | #define WILL_APPLY_DOOR 0x08 |
109 | #define WILL_APPLY_DOOR 0x08 |
88 | #define WILL_APPLY_FOOD 0x10 |
110 | #define WILL_APPLY_FOOD 0x10 |
89 | |
111 | |
90 | /* However, if you're keeping a pointer of some sort, you probably |
|
|
91 | * don't just want it copied, so you'll need to add to common/object.C, |
|
|
92 | * e.g. ->copy_to () |
|
|
93 | */ |
|
|
94 | |
|
|
95 | struct body_slot |
112 | struct body_slot |
96 | { |
113 | { |
97 | sint8 info:4; /* body info as loaded from the file */ |
114 | signed char info:4; /* body info as loaded from the file */ |
98 | sint8 used:4; /* Calculated value based on items equipped */ |
115 | signed char used:4; /* Calculated value based on items equipped */ |
99 | }; |
116 | }; |
100 | |
117 | |
101 | INTERFACE_CLASS (object) |
118 | INTERFACE_CLASS (object) |
102 | // these are being copied |
119 | // these are being copied |
103 | struct object_copy : attachable |
120 | struct object_copy : attachable |
104 | { |
121 | { |
105 | typedef bitset<NUM_FLAGS> flags_t; |
122 | typedef bitset<NUM_FLAGS> flags_t; |
106 | |
123 | |
107 | sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */ |
124 | sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */ |
|
|
125 | |
|
|
126 | uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */ |
|
|
127 | uint8 ACC (RW, subtype); /* subtype of object */ |
108 | sint8 ACC (RW, direction); /* Means the object is moving that way. */ |
128 | sint8 ACC (RW, direction); /* Means the object is moving that way. */ |
109 | sint8 ACC (RW, facing); /* Object is oriented/facing that way. */ |
129 | sint8 ACC (RW, facing); /* Object is oriented/facing that way. */ |
|
|
130 | |
110 | shstr ACC (RW, name); /* The name of the object, obviously... */ |
131 | shstr ACC (RW, name); /* The name of the object, obviously... */ |
111 | shstr ACC (RW, name_pl); /* The plural name of the object */ |
132 | shstr ACC (RW, name_pl); /* The plural name of the object */ |
112 | shstr ACC (RW, title); /* Of foo, etc */ |
133 | shstr ACC (RW, title); /* Of foo, etc */ |
113 | shstr ACC (RW, race); /* human, goblin, dragon, etc */ |
134 | shstr ACC (RW, race); /* human, goblin, dragon, etc */ |
114 | shstr ACC (RW, slaying); /* Which race to do double damage to */ |
135 | shstr ACC (RW, slaying); /* Which race to do double damage to */ |
… | |
… | |
133 | float ACC (RW, speed); /* The overall speed of this object */ |
154 | float ACC (RW, speed); /* The overall speed of this object */ |
134 | float ACC (RW, speed_left); /* How much speed is left to spend this round */ |
155 | float ACC (RW, speed_left); /* How much speed is left to spend this round */ |
135 | uint32 ACC (RW, nrof); /* How many of the objects */ |
156 | uint32 ACC (RW, nrof); /* How many of the objects */ |
136 | |
157 | |
137 | /* This next big block are basically used for monsters and equipment */ |
158 | /* This next big block are basically used for monsters and equipment */ |
138 | uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */ |
|
|
139 | uint8 ACC (RW, subtype); /* subtype of object */ |
|
|
140 | uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */ |
159 | uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */ |
|
|
160 | |
141 | sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ |
161 | sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ |
142 | uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ |
162 | uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ |
143 | uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ |
163 | uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ |
144 | uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */ |
164 | uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */ |
145 | uint32 ACC (RW, path_denied); /* Paths the object is denied access to */ |
165 | uint32 ACC (RW, path_denied); /* Paths the object is denied access to */ |
… | |
… | |
185 | * Note that other fields are used - these files are basically |
205 | * Note that other fields are used - these files are basically |
186 | * only used in spells. |
206 | * only used in spells. |
187 | */ |
207 | */ |
188 | sint16 ACC (RW, duration); /* How long the spell lasts */ |
208 | sint16 ACC (RW, duration); /* How long the spell lasts */ |
189 | sint16 ACC (RW, casting_time);/* time left before spell goes off */ |
209 | sint16 ACC (RW, casting_time);/* time left before spell goes off */ |
|
|
210 | |
190 | uint16 ACC (RW, start_holding); |
211 | uint16 ACC (RW, start_holding); |
191 | uint8 ACC (RW, duration_modifier); /* how level modifies duration */ |
212 | uint8 ACC (RW, duration_modifier); /* how level modifies duration */ |
192 | uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */ |
213 | uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */ |
|
|
214 | |
193 | sint8 ACC (RW, range); /* Range of the spell */ |
215 | sint8 ACC (RW, range); /* Range of the spell */ |
194 | uint8 ACC (RW, range_modifier); /* How going up in level effects range */ |
216 | uint8 ACC (RW, range_modifier); /* How going up in level effects range */ |
195 | |
|
|
196 | MoveType ACC (RW, move_type); /* Type of movement this object uses */ |
217 | MoveType ACC (RW, move_type); /* Type of movement this object uses */ |
197 | MoveType ACC (RW, move_block);/* What movement types this blocks */ |
218 | MoveType ACC (RW, move_block);/* What movement types this blocks */ |
|
|
219 | |
198 | MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */ |
220 | MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */ |
199 | MoveType ACC (RW, move_on); /* Move types affected moving on to this space */ |
221 | MoveType ACC (RW, move_on); /* Move types affected moving on to this space */ |
200 | MoveType ACC (RW, move_off); /* Move types affected moving off this space */ |
222 | MoveType ACC (RW, move_off); /* Move types affected moving off this space */ |
201 | MoveType ACC (RW, move_slow); /* Movement types this slows down */ |
223 | MoveType ACC (RW, move_slow); /* Movement types this slows down */ |
|
|
224 | |
202 | float ACC (RW, move_slow_penalty); /* How much this slows down the object */ |
225 | float ACC (RW, move_slow_penalty); /* How much this slows down the object */ |
203 | |
226 | |
204 | char *ACC (RW, spellarg); |
227 | char *ACC (RW, spellarg); |
205 | |
228 | |
206 | /* Following are values used by any object */ |
229 | /* Following are values used by any object */ |
… | |
… | |
246 | object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different |
269 | object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different |
247 | client_container *seen_by; // seen by which player/container currently? |
270 | client_container *seen_by; // seen by which player/container currently? |
248 | key_value *key_values; /* Fields not explictly known by the loader. */ |
271 | key_value *key_values; /* Fields not explictly known by the loader. */ |
249 | |
272 | |
250 | bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all |
273 | 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 |
251 | static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. |
275 | static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. |
252 | bool write (object_freezer &f); |
276 | bool write (object_freezer &f); |
253 | |
277 | |
|
|
278 | MTH int slottype () const; |
254 | MTH static object *create (); |
279 | MTH static object *create (); |
255 | object &operator =(const object &src); |
280 | object &operator =(const object &src); |
256 | MTH void copy_to (object *dst); |
281 | MTH void copy_to (object *dst); |
257 | MTH object *clone (); // create + copy_to |
282 | MTH object *clone (); // create + copy_to |
258 | void do_destroy (); |
283 | void do_destroy (); |
… | |
… | |
279 | && can_merge_slow (op1, op2); |
304 | && can_merge_slow (op1, op2); |
280 | } |
305 | } |
281 | |
306 | |
282 | MTH void set_owner (object *owner); |
307 | MTH void set_owner (object *owner); |
283 | MTH void set_speed (float speed); |
308 | MTH void set_speed (float speed); |
284 | MTH void set_weapon (object *ob); |
309 | MTH bool change_weapon (object *ob); |
|
|
310 | MTH bool change_skill (object *ob); |
285 | |
311 | |
286 | MTH void open_container (object *new_container); |
312 | MTH void open_container (object *new_container); |
287 | MTH void close_container () |
313 | MTH void close_container () |
288 | { |
314 | { |
289 | open_container (0); |
315 | open_container (0); |
|
|
316 | } |
|
|
317 | |
|
|
318 | // overwrite the attachable should_invoke function with a version that also checks ev_want_type |
|
|
319 | bool should_invoke (event_type event) |
|
|
320 | { |
|
|
321 | return ev_want_event [event] || ev_want_type [type] || cb; |
290 | } |
322 | } |
291 | |
323 | |
292 | MTH void instantiate (); |
324 | MTH void instantiate (); |
293 | |
325 | |
294 | // recalculate all stats |
326 | // recalculate all stats |
… | |
… | |
368 | MTH object *head_ () |
400 | MTH object *head_ () |
369 | { |
401 | { |
370 | return head ? head : this; |
402 | return head ? head : this; |
371 | } |
403 | } |
372 | |
404 | |
|
|
405 | MTH bool is_head () |
|
|
406 | { |
|
|
407 | return head_ () == this; |
|
|
408 | } |
|
|
409 | |
373 | MTH std::string long_desc (object *who = 0); |
410 | MTH std::string long_desc (object *who = 0); |
374 | MTH std::string describe_monster (object *who = 0); |
411 | MTH std::string describe_monster (object *who = 0); |
375 | MTH std::string describe_item (object *who = 0); |
412 | MTH std::string describe_item (object *who = 0); |
376 | MTH std::string describe (object *who = 0); |
413 | MTH std::string describe (object *who = 0); |
377 | |
414 | |
… | |
… | |
450 | } |
487 | } |
451 | |
488 | |
452 | MTH struct region *region () const; |
489 | MTH struct region *region () const; |
453 | |
490 | |
454 | protected: |
491 | protected: |
455 | friend struct archetype; |
|
|
456 | |
|
|
457 | void link (); |
492 | void link (); |
458 | void unlink (); |
493 | void unlink (); |
459 | |
494 | |
460 | object (); |
495 | object (); |
461 | ~object (); |
496 | ~object (); |
462 | }; |
497 | }; |
463 | |
498 | |
464 | typedef object_vector<object, &object::index > objectvec; |
499 | // move this object to the top of its env's inventory to speed up |
465 | typedef object_vector<object, &object::active> activevec; |
500 | // searches for it. |
|
|
501 | static object * |
|
|
502 | splay (object *ob) |
|
|
503 | { |
|
|
504 | if (ob->env && ob->env->inv != ob) |
|
|
505 | { |
|
|
506 | if (ob->above) ob->above->below = ob->below; |
|
|
507 | if (ob->below) ob->below->above = ob->above; |
466 | |
508 | |
467 | extern objectvec objects; |
509 | ob->above = 0; |
468 | extern activevec actives; |
510 | ob->below = ob->env->inv; |
|
|
511 | ob->below->above = ob; |
|
|
512 | ob->env->inv = ob; |
|
|
513 | } |
469 | |
514 | |
470 | #define for_all_objects(var) \ |
515 | return ob; |
471 | for (unsigned _i = 0; _i < objects.size (); ++_i) \ |
516 | } |
472 | declvar (object *, var, objects [_i]) |
|
|
473 | |
|
|
474 | #define for_all_actives(var) \ |
|
|
475 | for (unsigned _i = 0; _i < actives.size (); ++_i) \ |
|
|
476 | declvar (object *, var, actives [_i]) |
|
|
477 | |
517 | |
478 | typedef struct oblnk |
518 | typedef struct oblnk |
479 | { /* Used to link together several objects */ |
519 | { /* Used to link together several objects */ |
480 | object_ptr ob; |
520 | object_ptr ob; |
481 | struct oblnk *next; |
521 | struct oblnk *next; |
… | |
… | |
485 | { /* Used to link together several object links */ |
525 | { /* Used to link together several object links */ |
486 | struct oblnk *link; |
526 | struct oblnk *link; |
487 | long value; /* Used as connected value in buttons/gates */ |
527 | long value; /* Used as connected value in buttons/gates */ |
488 | struct oblinkpt *next; |
528 | struct oblinkpt *next; |
489 | } oblinkpt; |
529 | } oblinkpt; |
|
|
530 | |
|
|
531 | object *find_skill_by_name (object *who, const char *name); |
|
|
532 | object *find_skill_by_name (object *who, const shstr &sh); |
|
|
533 | object *find_skill_by_number (object *who, int skillno); |
490 | |
534 | |
491 | /* |
535 | /* |
492 | * The archetype structure is a set of rules on how to generate and manipulate |
536 | * The archetype structure is a set of rules on how to generate and manipulate |
493 | * objects which point to archetypes. |
537 | * objects which point to archetypes. |
494 | * This probably belongs in arch.h, but there really doesn't appear to |
538 | * This probably belongs in arch.h, but there really doesn't appear to |
… | |
… | |
496 | * object and pointers. This structure should get removed, and just replaced |
540 | * object and pointers. This structure should get removed, and just replaced |
497 | * by the object structure |
541 | * by the object structure |
498 | */ |
542 | */ |
499 | |
543 | |
500 | INTERFACE_CLASS (archetype) |
544 | INTERFACE_CLASS (archetype) |
501 | struct archetype : zero_initialised, attachable |
545 | struct archetype : object |
502 | { |
546 | { |
503 | archetype (); |
547 | archetype (const char *name); |
504 | ~archetype (); |
548 | ~archetype (); |
505 | void gather_callbacks (AV *&callbacks, event_type event) const; |
549 | void gather_callbacks (AV *&callbacks, event_type event) const; |
506 | |
550 | |
507 | static archetype *read (object_thawer &f); |
551 | static archetype *read (object_thawer &f); |
508 | static archetype *get (const char *name); // find or create |
552 | static archetype *get (const char *name); // find or create |
509 | static archetype *find (const char *name); |
553 | static archetype *find (const char *name); |
510 | |
554 | |
511 | void hash_add (); // add to hashtable |
555 | void link (); |
512 | void hash_del (); // remove from hashtable |
556 | void unlink (); |
513 | |
557 | |
|
|
558 | int ACC (RW, archid); // index in archvector |
514 | shstr ACC (RW, name); /* More definite name, like "generate_kobold" */ |
559 | shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ |
|
|
560 | bool ACC (RW, stub); // if true, this is an invalid archetype |
515 | struct archetype *ACC (RW, next); /* Next archetype in a linked list */ |
561 | struct archetype *ACC (RW, next); /* Next archetype in a linked list */ |
516 | struct archetype *ACC (RW, head); /* The main part of a linked object */ |
562 | struct archetype *ACC (RW, head); /* The main part of a linked object */ |
517 | struct archetype *ACC (RW, more); /* Next part of a linked object */ |
563 | struct archetype *ACC (RW, more); /* Next part of a linked object */ |
518 | object ACC (RO, clone); /* An object from which to do ->copy_to () */ |
|
|
519 | uint32 ACC (RW, editable); /* editable flags (mainly for editor) */ |
564 | uint32 ACC (RW, editable); /* editable flags (mainly for editor) */ |
520 | bool ACC (RW, linked); // linked into list of heads |
565 | |
521 | sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is |
566 | sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ |
522 | * in comparison to the head. |
567 | sint8 ACC (RW, max_x), ACC (RW, max_y); |
523 | */ |
|
|
524 | }; |
568 | }; |
|
|
569 | |
|
|
570 | typedef object_vector<object, &object::index > objectvec; |
|
|
571 | typedef object_vector<object, &object::active> activevec; |
|
|
572 | typedef object_vector<archetype, &archetype::archid> archvec; |
|
|
573 | |
|
|
574 | extern objectvec objects; |
|
|
575 | extern activevec actives; |
|
|
576 | extern archvec archetypes; |
|
|
577 | |
|
|
578 | #define for_all_objects(var) \ |
|
|
579 | for (unsigned _i = 0; _i < objects.size (); ++_i) \ |
|
|
580 | statementvar (object *, var, objects [_i]) |
|
|
581 | |
|
|
582 | #define for_all_actives(var) \ |
|
|
583 | for (unsigned _i = 0; _i < actives.size (); ++_i) \ |
|
|
584 | statementvar (object *, var, actives [_i]) |
|
|
585 | |
|
|
586 | #define for_all_archetypes(var) \ |
|
|
587 | for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ |
|
|
588 | statementvar (archetype *, var, archetypes [_i]) |
525 | |
589 | |
526 | /* Used by update_object to know if the object being passed is |
590 | /* Used by update_object to know if the object being passed is |
527 | * being added or removed. |
591 | * being added or removed. |
528 | */ |
592 | */ |
529 | #define UP_OBJ_INSERT 1 |
593 | #define UP_OBJ_INSERT 1 |