ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/object.h
Revision: 1.106
Committed: Mon Apr 16 12:37:08 2007 UTC (17 years, 1 month ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.105: +1 -1 lines
Log Message:
rewrote archetype loader to try harder to cleanly replace archetypes

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