ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/object.h
Revision: 1.117
Committed: Mon May 7 04:21:11 2007 UTC (17 years ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.116: +11 -5 lines
Log Message:
some more structure optimisations saving lots of code

File Contents

# Content
1 /*
2 * CrossFire, A Multiplayer Online RPG
3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
5 * Copyright (C) 2001 Mark Wedel & Crossfire Development Team
6 * Copyright (C) 1992 Frank Tore Johansen
7 *
8 * This program is free software; you can redistribute it and/or modify
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
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
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
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 *
22 * The authors can be reached via e-mail at crossfire@schmorp.de
23 */
24
25 #ifndef OBJECT_H
26 #define OBJECT_H
27
28 #include <bitset>
29
30 #include "cfperl.h"
31 #include "shstr.h"
32
33 typedef int tag_t;
34
35 #define NUM_BODY_LOCATIONS 14
36 #define BODY_ARMS 1
37
38 /* See common/item.c */
39
40 typedef struct Body_Locations
41 {
42 const char *save_name; /* Name used to load/save it to disk */
43 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 */
45 } Body_Locations;
46
47 extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
48
49 /*
50 * Each object (this also means archetypes!) could have a few of these
51 * "dangling" from it; this could also end up containing 'parse errors'.
52 *
53 * key and value are shared-strings.
54 *
55 * Please use get_ob_key_value(), set_ob_key_value() from object.c rather than
56 * accessing the list directly.
57 * Exception is if you want to walk this list for some reason.
58 */
59 struct key_value
60 {
61 key_value *next;
62 shstr key, value;
63 };
64
65 struct UUID
66 {
67 uint64 seq;
68
69 UUID () { }
70 UUID (uint64 seq) : seq(seq) { }
71 operator uint64() { return seq; }
72 void operator =(uint64 seq) { this->seq = seq; }
73 };
74
75 extern void init_uuid ();
76 extern UUID gen_uuid ();
77 extern const uint64 UUID_SKIP;
78
79 /* Definition for WILL_APPLY values. Replaces having harcoded values
80 * sprinkled in the code. Note that some of these also replace fields
81 * that were in the can_apply area. What is the point of having both
82 * can_apply and will_apply?
83 */
84 #define WILL_APPLY_HANDLE 0x01
85 #define WILL_APPLY_TREASURE 0x02
86 #define WILL_APPLY_EARTHWALL 0x04
87 #define WILL_APPLY_DOOR 0x08
88 #define WILL_APPLY_FOOD 0x10
89
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
96 {
97 signed char info:4; /* body info as loaded from the file */
98 signed char used:4; /* Calculated value based on items equipped */
99 };
100
101 INTERFACE_CLASS (object)
102 // these are being copied
103 struct object_copy : attachable
104 {
105 typedef bitset<NUM_FLAGS> flags_t;
106
107 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
108
109 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
110 uint8 ACC (RW, subtype); /* subtype of object */
111 sint8 ACC (RW, direction); /* Means the object is moving that way. */
112 sint8 ACC (RW, facing); /* Object is oriented/facing that way. */
113
114 shstr ACC (RW, name); /* The name of the object, obviously... */
115 shstr ACC (RW, name_pl); /* The plural name of the object */
116 shstr ACC (RW, title); /* Of foo, etc */
117 shstr ACC (RW, race); /* human, goblin, dragon, etc */
118 shstr ACC (RW, slaying); /* Which race to do double damage to */
119 /* If this is an exit, this is the filename */
120 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
121 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
122 shstr ACC (RW, lore); /* Obscure information about this object, */
123 /* To get put into books and the like. */
124 shstr ACC (RW, materialname); /* specific material name */
125 shstr ACC (RW, custom_name); /* Custom name assigned by player */
126 // materialtype_t *ACC (RW, material); /* What material this object consists of */
127 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
128 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
129 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
130 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
131 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
132 object_ptr ACC (RW, spell); /* Spell that was being cast */
133 object_ptr ACC (RW, current_weapon); /* Pointer to the weapon currently used */
134 arch_ptr ACC (RW, arch); /* Pointer to archetype */
135 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
136
137 float ACC (RW, speed); /* The overall speed of this object */
138 float ACC (RW, speed_left); /* How much speed is left to spend this round */
139 uint32 ACC (RW, nrof); /* How many of the objects */
140
141 /* This next big block are basically used for monsters and equipment */
142 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
143
144 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
145 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
146 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
147 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
148 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
149 uint16 ACC (RW, materials); /* What materials this object consists of */
150 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
151 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
152 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
153 /* Note that the last_.. values are sometimes used for non obvious
154 * meanings by some objects, eg, sp penalty, permanent exp.
155 */
156 sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */
157 sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */
158 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
159 sint16 ACC (RW, last_eat); /* How long since we last ate */
160 sint16 ACC (RW, invisible); /* How much longer the object will be invis */
161 sint16 ACC (RW, level); /* Level of creature or object */
162 uint8 ACC (RW, pick_up); /* See crossfire.doc */
163 sint8 ACC (RW, item_power); /* power rating of the object */
164 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
165 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
166 sint32 ACC (RW, weight); /* Attributes of the object */
167 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
168 sint32 ACC (RW, carrying); /* How much weight this object contains */
169 sint64 ACC (RW, perm_exp); /* Permanent exp */
170 uint32 ACC (RW, weapontype); /* type of weapon */
171 uint32 ACC (RW, tooltype); /* type of tool or build facility */
172 body_slot slot [NUM_BODY_LOCATIONS];
173 faceidx ACC (RW, face); /* Face with colors */
174 living ACC (RO, stats); /* Str, Con, Dex, etc */
175 /* See the pod/objects.pod for more info about body locations */
176
177 /* Following mostly refers to fields only used for monsters */
178 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
179
180 /* allows different movement patterns for attackers */
181 sint32 ACC (RW, move_status); /* What stage in attack mode */
182 uint16 ACC (RW, attack_movement); /* What kind of attack movement */
183 uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
184 float ACC (RW, expmul); /* needed experience = (calc_exp*expmul) - means some */
185 /* races/classes can need less/more exp to gain levels */
186
187 /* Spell related information, may be useful elsewhere
188 * Note that other fields are used - these files are basically
189 * only used in spells.
190 */
191 sint16 ACC (RW, duration); /* How long the spell lasts */
192 sint16 ACC (RW, casting_time);/* time left before spell goes off */
193
194 uint16 ACC (RW, start_holding);
195 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
196 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
197
198 sint8 ACC (RW, range); /* Range of the spell */
199 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
200 MoveType ACC (RW, move_type); /* Type of movement this object uses */
201 MoveType ACC (RW, move_block);/* What movement types this blocks */
202
203 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
204 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
205 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
206 MoveType ACC (RW, move_slow); /* Movement types this slows down */
207
208 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
209
210 char *ACC (RW, spellarg);
211
212 /* Following are values used by any object */
213 /* this objects turns into or what this object creates */
214 treasurelist *ACC (RW, randomitems); /* Items to be generated */
215 flags_t flag; /* various flags */
216 #if FOR_PERL
217 bool ACC (RW, flag[NUM_FLAGS]);
218 #endif
219 uint16 ACC (RW, animation_id);/* An index into the animation array */
220 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
221 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
222 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */
223 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
224 uint8 ACC (RW, will_apply); /* See crossfire.doc */
225 };
226
227 struct object : zero_initialised, object_copy
228 {
229 // These variables are not changed by ->copy_to
230 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */
231
232 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
233 int ACC (RO, count);
234 int ACC (RO, index); // index into objects
235 int ACC (RO, active); // index into actives
236
237 player_ptr ACC (RW, contr); /* Pointer to the player which control this object */
238
239 object *ACC (RW, below); /* Pointer to the object stacked below this one */
240 object *ACC (RW, above); /* Pointer to the object stacked above this one */
241 /* Note: stacked in the *same* environment */
242 object *inv; /* Pointer to the first object in the inventory */
243
244 //TODO: container must move into client
245 object_ptr ACC (RW, container); /* Current container being used. I think this
246 * is only used by the player right now.
247 */
248 object *ACC (RW, env); /* Pointer to the object which is the environment.
249 * This is typically the container that the object is in.
250 */
251 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
252 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
253 client_container *seen_by; // seen by which player/container currently?
254 key_value *key_values; /* Fields not explictly known by the loader. */
255
256 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
257 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
258 bool write (object_freezer &f);
259
260 MTH static object *create ();
261 object &operator =(const object &src);
262 MTH void copy_to (object *dst);
263 MTH object *clone (); // create + copy_to
264 void do_destroy ();
265 void gather_callbacks (AV *&callbacks, event_type event) const;
266 MTH void destroy (bool destroy_inventory = false);
267
268 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
269 MTH void destroy_inv (bool drop_to_ground = false);
270 MTH object *insert (object *item); // insert into inventory
271 void do_remove ();
272 MTH void remove ()
273 {
274 if (!flag [FLAG_REMOVED])
275 do_remove ();
276 }
277
278 static bool can_merge_slow (object *op1, object *op2);
279
280 // this is often used in time-critical code, so optimise
281 MTH static bool can_merge (object *op1, object *op2)
282 {
283 return op1->value == op2->value
284 && op1->name == op2->name
285 && can_merge_slow (op1, op2);
286 }
287
288 MTH void set_owner (object *owner);
289 MTH void set_speed (float speed);
290 MTH void set_weapon (object *ob);
291
292 MTH void open_container (object *new_container);
293 MTH void close_container ()
294 {
295 open_container (0);
296 }
297
298 MTH void instantiate ();
299
300 // recalculate all stats
301 MTH void update_stats ();
302 MTH void roll_stats ();
303 MTH void swap_stats (int a, int b);
304 MTH void add_statbonus ();
305 MTH void remove_statbonus ();
306 MTH void drain_stat ();
307 MTH void drain_specific_stat (int deplete_stats);
308 MTH void change_luck (int value);
309
310 // info must hold 256 * 3 bytes currently
311 const char *debug_desc (char *info) const;
312 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
313 const char *flag_desc (char *desc, int len) const;
314
315 int number_of () const
316 {
317 return nrof ? nrof : 1;
318 }
319
320 uint64 total_weight () const
321 {
322 return weight * number_of ();
323 }
324
325 // return the dominant material of this item, always return something
326 const materialtype_t *dominant_material () const;
327
328 // return the volume of this object in cm³
329 uint64 volume () const
330 {
331 return total_weight ()
332 * 1000
333 * (type == CONTAINER ? 1000 : 1)
334 / dominant_material ()->density;
335 }
336
337 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
338 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
339 || type == CLOAK || type == BOOTS || type == GLOVES
340 || type == BRACERS || type == GIRDLE; }
341 MTH bool is_alive () const { return (type == PLAYER
342 || flag [FLAG_MONSTER]
343 || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR))
344 && !flag [FLAG_IS_A_TEMPLATE]; }
345 MTH bool is_arrow () const { return type == ARROW
346 || (type == SPELL_EFFECT
347 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
348 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
349
350 MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; }
351
352 // temporary: wether the object can be saved in a map file
353 // contr => is a player
354 // head => only save head of a multitile object
355 // owner => can not reference owner yet
356 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; }
357
358 /* This return true if object has still randomitems which
359 * could be expanded.
360 */
361 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
362
363 // returns the player that has this object in his inventory, or 0
364 MTH object *in_player () const
365 {
366 for (object *op = env; op; op = op->env)
367 if (op->type == PLAYER)
368 return op;
369
370 return 0;
371 }
372
373 // "temporary" helper function
374 MTH object *head_ ()
375 {
376 return head ? head : this;
377 }
378
379 MTH std::string long_desc (object *who = 0);
380 MTH std::string describe_monster (object *who = 0);
381 MTH std::string describe_item (object *who = 0);
382 MTH std::string describe (object *who = 0);
383
384 // If this object has no extra parts but should have them,
385 // add them, effectively expanding heads into multipart
386 // objects. This method only works on objects not inserted
387 // anywhere.
388 MTH void expand_tail ();
389
390 MTH void create_treasure (treasurelist *tl, int flags = 0);
391
392 // insert object at same map position as 'where'
393 // handles both inventory and map "positions"
394 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
395
396 MTH void activate ();
397 MTH void deactivate ();
398 MTH void activate_recursive ();
399 MTH void deactivate_recursive ();
400
401 // set the givne flag on all objects in the inventory recursively
402 MTH void set_flag_inv (int flag, int value = 1);
403
404 void enter_exit (object *exit);//Perl
405 MTH void enter_map (maptile *newmap, int x, int y);
406
407 // returns the mapspace this object is in
408 mapspace &ms () const;
409
410 // fully recursive iterator
411 struct iterator_base
412 {
413 object *item;
414
415 iterator_base (object *container)
416 : item (container)
417 {
418 }
419
420 operator object *() const { return item; }
421
422 object *operator ->() const { return item; }
423 object &operator * () const { return *item; }
424 };
425
426 MTH unsigned int random_seed () const
427 {
428 return (unsigned int)uuid.seq;
429 }
430
431 // depth-first recursive iterator
432 struct depth_iterator : iterator_base
433 {
434 depth_iterator (object *container);
435 void next ();
436 object *operator ++( ) { next (); return item; }
437 object *operator ++(int) { object *i = item; next (); return i; }
438 };
439
440 object *begin ()
441 {
442 return this;
443 }
444
445 object *end ()
446 {
447 return this;
448 }
449
450 /* This returns TRUE if the object is something that
451 * should be displayed in the floorbox/inventory window
452 */
453 MTH bool client_visible () const
454 {
455 return !invisible && type != PLAYER;
456 }
457
458 MTH struct region *region () const;
459
460 protected:
461 friend struct archetype;
462
463 void link ();
464 void unlink ();
465
466 object ();
467 ~object ();
468 };
469
470 typedef object_vector<object, &object::index > objectvec;
471 typedef object_vector<object, &object::active> activevec;
472
473 extern objectvec objects;
474 extern activevec actives;
475
476 #define for_all_objects(var) \
477 for (unsigned _i = 0; _i < objects.size (); ++_i) \
478 declvar (object *, var, objects [_i])
479
480 #define for_all_actives(var) \
481 for (unsigned _i = 0; _i < actives.size (); ++_i) \
482 declvar (object *, var, actives [_i])
483
484 typedef struct oblnk
485 { /* Used to link together several objects */
486 object_ptr ob;
487 struct oblnk *next;
488 } objectlink;
489
490 typedef struct oblinkpt
491 { /* Used to link together several object links */
492 struct oblnk *link;
493 long value; /* Used as connected value in buttons/gates */
494 struct oblinkpt *next;
495 } oblinkpt;
496
497 /*
498 * The archetype structure is a set of rules on how to generate and manipulate
499 * objects which point to archetypes.
500 * This probably belongs in arch.h, but there really doesn't appear to
501 * be much left in the archetype - all it really is is a holder for the
502 * object and pointers. This structure should get removed, and just replaced
503 * by the object structure
504 */
505
506 INTERFACE_CLASS (archetype)
507 struct archetype : zero_initialised, attachable
508 {
509 archetype ();
510 ~archetype ();
511 void gather_callbacks (AV *&callbacks, event_type event) const;
512
513 static archetype *read (object_thawer &f);
514 static archetype *get (const char *name); // find or create
515 static archetype *find (const char *name);
516
517 void hash_add (); // add to hashtable
518 void hash_del (); // remove from hashtable
519
520 shstr ACC (RW, name); /* More definite name, like "generate_kobold" */
521 struct archetype *ACC (RW, next); /* Next archetype in a linked list */
522 struct archetype *ACC (RW, head); /* The main part of a linked object */
523 struct archetype *ACC (RW, more); /* Next part of a linked object */
524 object ACC (RO, clone); /* An object from which to do ->copy_to () */
525 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
526 bool ACC (RW, linked); // linked into list of heads
527 sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is
528 * in comparison to the head.
529 */
530 };
531
532 /* Used by update_object to know if the object being passed is
533 * being added or removed.
534 */
535 #define UP_OBJ_INSERT 1
536 #define UP_OBJ_REMOVE 2
537 #define UP_OBJ_CHANGE 3
538 #define UP_OBJ_FACE 4 /* Only thing that changed was the face */
539
540 /* These are flags passed to insert_ob_in_map and
541 * insert_ob_in_ob. Note that all flags may not be meaningful
542 * for both functions.
543 * Most are fairly explanatory:
544 * INS_NO_MERGE: don't try to merge inserted object with ones alrady
545 * on space.
546 * INS_ABOVE_FLOOR_ONLY: Put object immediatly above the floor.
547 * INS_NO_WALK_ON: Don't call check_walk_on against the
548 * originator - saves cpu time if you know the inserted object
549 * is not meaningful in terms of having an effect.
550 * INS_ON_TOP: Always put object on top. Generally only needed when loading
551 * files from disk and ordering needs to be preserved.
552 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
553 * Use for treasure chests so the new object is the highest thing
554 * beneath the player, but not actually above it. Note - the
555 * map and x,y coordinates for the object to be inserted must
556 * match the originator.
557 * INS_MAP_LOAD: disable lots of checkings done at insertion to
558 * speed up map loading process, as we assume the ordering in
559 * loaded map is correct.
560 *
561 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
562 * are mutually exclusive. The behaviour for passing more than one
563 * should be considered undefined - while you may notice what happens
564 * right now if you pass more than one, that could very well change
565 * in future revisions of the code.
566 */
567 #define INS_NO_MERGE 0x0001
568 #define INS_ABOVE_FLOOR_ONLY 0x0002
569 #define INS_NO_WALK_ON 0x0004
570 #define INS_ON_TOP 0x0008
571 #define INS_BELOW_ORIGINATOR 0x0010
572 #define INS_MAP_LOAD 0x0020
573
574 #define ARCH_SINGULARITY "singularity"
575 #define ARCH_DETECT_MAGIC "detect_magic"
576 #define ARCH_DEPLETION "depletion"
577 #define ARCH_SYMPTOM "symptom"
578
579 #endif
580