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.117 by root, Mon May 7 04:21:11 2007 UTC vs.
Revision 1.146 by root, Mon Aug 27 06:29:17 2007 UTC

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
30#include "cfperl.h" 29#include "cfperl.h"
31#include "shstr.h" 30#include "shstr.h"
32 31
33typedef int tag_t; 32typedef int tag_t;
34 33
35#define NUM_BODY_LOCATIONS 14 34enum {
36#define BODY_ARMS 1 35 body_skill,
36 body_combat,
37 body_range,
38 body_shield,
39 body_arm,
40 body_torso,
41 body_head,
42 body_neck,
43 body_finger,
44 body_shoulder,
45 body_foot,
46 body_hand,
47 body_wrist,
48 body_waist,
49 NUM_BODY_LOCATIONS
50};
51
52enum slottype_t
53{
54 slot_none,
55 slot_combat,
56 slot_ranged,
57};
37 58
38/* See common/item.c */ 59/* See common/item.c */
39 60
40typedef struct Body_Locations 61typedef struct Body_Locations
41{ 62{
42 const char *save_name; /* Name used to load/save it to disk */ 63 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 */ 64 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 */ 65 const char *nonuse_name; /* Name to describe objects we can't use */
45} Body_Locations; 66} Body_Locations;
46 67
47extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 68extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
84#define WILL_APPLY_HANDLE 0x01 105#define WILL_APPLY_HANDLE 0x01
85#define WILL_APPLY_TREASURE 0x02 106#define WILL_APPLY_TREASURE 0x02
86#define WILL_APPLY_EARTHWALL 0x04 107#define WILL_APPLY_EARTHWALL 0x04
87#define WILL_APPLY_DOOR 0x08 108#define WILL_APPLY_DOOR 0x08
88#define WILL_APPLY_FOOD 0x10 109#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 110
95struct body_slot 111struct body_slot
96{ 112{
97 signed char info:4; /* body info as loaded from the file */ 113 signed char info:4; /* body info as loaded from the file */
98 signed char used:4; /* Calculated value based on items equipped */ 114 signed char used:4; /* Calculated value based on items equipped */
168 sint32 ACC (RW, carrying); /* How much weight this object contains */ 184 sint32 ACC (RW, carrying); /* How much weight this object contains */
169 sint64 ACC (RW, perm_exp); /* Permanent exp */ 185 sint64 ACC (RW, perm_exp); /* Permanent exp */
170 uint32 ACC (RW, weapontype); /* type of weapon */ 186 uint32 ACC (RW, weapontype); /* type of weapon */
171 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 187 uint32 ACC (RW, tooltype); /* type of tool or build facility */
172 body_slot slot [NUM_BODY_LOCATIONS]; 188 body_slot slot [NUM_BODY_LOCATIONS];
173 faceidx ACC (RW, face); /* Face with colors */ 189 faceidx ACC (RW, face); /* the graphical face */
190 faceidx ACC (RW, sound); /* the sound face */
191 faceidx ACC (RW, sound_destroy); /* played on destroy */
174 living ACC (RO, stats); /* Str, Con, Dex, etc */ 192 living ACC (RO, stats); /* Str, Con, Dex, etc */
175 /* See the pod/objects.pod for more info about body locations */ 193 /* See the pod/objects.pod for more info about body locations */
176 194
177 /* Following mostly refers to fields only used for monsters */ 195 /* Following mostly refers to fields only used for monsters */
178 uint32 ACC (RW, hide); /* The object is hidden, not invisible */ 196 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
229 // These variables are not changed by ->copy_to 247 // These variables are not changed by ->copy_to
230 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ 248 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */
231 249
232 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 250 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
233 int ACC (RO, count); 251 int ACC (RO, count);
234 int ACC (RO, index); // index into objects 252 object_vector_index ACC (RO, index); // index into objects
235 int ACC (RO, active); // index into actives 253 object_vector_index ACC (RO, active); // index into actives
236 254
237 player_ptr ACC (RW, contr); /* Pointer to the player which control this object */ 255 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
238 256
239 object *ACC (RW, below); /* Pointer to the object stacked below this one */ 257 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 */ 258 object *ACC (RW, above); /* Pointer to the object stacked above this one */
241 /* Note: stacked in the *same* environment */ 259 /* Note: stacked in the *same* environment */
242 object *inv; /* Pointer to the first object in the inventory */ 260 object *inv; /* Pointer to the first object in the inventory */
252 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 270 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? 271 client_container *seen_by; // seen by which player/container currently?
254 key_value *key_values; /* Fields not explictly known by the loader. */ 272 key_value *key_values; /* Fields not explictly known by the loader. */
255 273
256 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 274 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
275 void post_load_check (); // do some adjustments after parsing
257 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. 276 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
258 bool write (object_freezer &f); 277 bool write (object_freezer &f);
259 278
279 MTH int slottype () const;
260 MTH static object *create (); 280 MTH static object *create ();
281 const mapxy &operator =(const mapxy &pos);
261 object &operator =(const object &src); 282 object &operator =(const object &src);
262 MTH void copy_to (object *dst); 283 MTH void copy_to (object *dst);
263 MTH object *clone (); // create + copy_to 284 MTH object *clone (); // create + copy_to
264 void do_destroy (); 285 void do_destroy ();
265 void gather_callbacks (AV *&callbacks, event_type event) const; 286 void gather_callbacks (AV *&callbacks, event_type event) const;
266 MTH void destroy (bool destroy_inventory = false); 287 MTH void destroy (bool destroy_inventory = false);
267 288
268 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 289 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
269 MTH void destroy_inv (bool drop_to_ground = false); 290 MTH void destroy_inv (bool drop_to_ground = false);
270 MTH object *insert (object *item); // insert into inventory 291 MTH object *insert (object *item); // insert into inventory
292 MTH void play_sound (faceidx sound) const;
293
271 void do_remove (); 294 void do_remove ();
272 MTH void remove () 295 MTH void remove ()
273 { 296 {
274 if (!flag [FLAG_REMOVED]) 297 if (!flag [FLAG_REMOVED])
275 do_remove (); 298 do_remove ();
299 }
300
301 void move_to (const mapxy &pos)
302 {
303 remove ();
304 *this = pos;
305 insert_at (this, this);
276 } 306 }
277 307
278 static bool can_merge_slow (object *op1, object *op2); 308 static bool can_merge_slow (object *op1, object *op2);
279 309
280 // this is often used in time-critical code, so optimise 310 // this is often used in time-critical code, so optimise
285 && can_merge_slow (op1, op2); 315 && can_merge_slow (op1, op2);
286 } 316 }
287 317
288 MTH void set_owner (object *owner); 318 MTH void set_owner (object *owner);
289 MTH void set_speed (float speed); 319 MTH void set_speed (float speed);
290 MTH void set_weapon (object *ob); 320 MTH bool change_weapon (object *ob);
321 MTH bool change_skill (object *ob);
291 322
292 MTH void open_container (object *new_container); 323 MTH void open_container (object *new_container);
293 MTH void close_container () 324 MTH void close_container ()
294 { 325 {
295 open_container (0); 326 open_container (0);
327 }
328
329 MTH object *force_find (const shstr name);
330 MTH void force_add (const shstr name, int duration = 0);
331
332 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
333 bool should_invoke (event_type event)
334 {
335 return ev_want_event [event] || ev_want_type [type] || cb;
296 } 336 }
297 337
298 MTH void instantiate (); 338 MTH void instantiate ();
299 339
300 // recalculate all stats 340 // recalculate all stats
351 391
352 // temporary: wether the object can be saved in a map file 392 // temporary: wether the object can be saved in a map file
353 // contr => is a player 393 // contr => is a player
354 // head => only save head of a multitile object 394 // head => only save head of a multitile object
355 // owner => can not reference owner yet 395 // owner => can not reference owner yet
356 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } 396 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
357 397
358 /* This return true if object has still randomitems which 398 /* This return true if object has still randomitems which
359 * could be expanded. 399 * could be expanded.
360 */ 400 */
361 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 401 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
372 412
373 // "temporary" helper function 413 // "temporary" helper function
374 MTH object *head_ () 414 MTH object *head_ ()
375 { 415 {
376 return head ? head : this; 416 return head ? head : this;
417 }
418
419 MTH bool is_head ()
420 {
421 return head_ () == this;
377 } 422 }
378 423
379 MTH std::string long_desc (object *who = 0); 424 MTH std::string long_desc (object *who = 0);
380 MTH std::string describe_monster (object *who = 0); 425 MTH std::string describe_monster (object *who = 0);
381 MTH std::string describe_item (object *who = 0); 426 MTH std::string describe_item (object *who = 0);
390 MTH void create_treasure (treasurelist *tl, int flags = 0); 435 MTH void create_treasure (treasurelist *tl, int flags = 0);
391 436
392 // insert object at same map position as 'where' 437 // insert object at same map position as 'where'
393 // handles both inventory and map "positions" 438 // handles both inventory and map "positions"
394 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 439 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
440 MTH void drop_unpaid_items ();
395 441
396 MTH void activate (); 442 MTH void activate ();
397 MTH void deactivate (); 443 MTH void deactivate ();
398 MTH void activate_recursive (); 444 MTH void activate_recursive ();
399 MTH void deactivate_recursive (); 445 MTH void deactivate_recursive ();
455 return !invisible && type != PLAYER; 501 return !invisible && type != PLAYER;
456 } 502 }
457 503
458 MTH struct region *region () const; 504 MTH struct region *region () const;
459 505
506 void statusmsg (const char *msg, int color = NDI_BLACK);
507 void failmsg (const char *msg, int color = NDI_RED);
508
460protected: 509protected:
461 friend struct archetype;
462
463 void link (); 510 void link ();
464 void unlink (); 511 void unlink ();
465 512
466 object (); 513 object ();
467 ~object (); 514 ~object ();
468}; 515};
469 516
470typedef object_vector<object, &object::index > objectvec; 517// move this object to the top of its env's inventory to speed up
471typedef object_vector<object, &object::active> activevec; 518// searches for it.
519static object *
520splay (object *ob)
521{
522 if (ob->env && ob->env->inv != ob)
523 {
524 if (ob->above) ob->above->below = ob->below;
525 if (ob->below) ob->below->above = ob->above;
472 526
473extern objectvec objects; 527 ob->above = 0;
474extern activevec actives; 528 ob->below = ob->env->inv;
529 ob->below->above = ob;
530 ob->env->inv = ob;
531 }
475 532
476#define for_all_objects(var) \ 533 return ob;
477 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 534}
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 535
484typedef struct oblnk 536typedef struct oblnk
485{ /* Used to link together several objects */ 537{ /* Used to link together several objects */
486 object_ptr ob; 538 object_ptr ob;
487 struct oblnk *next; 539 struct oblnk *next;
491{ /* Used to link together several object links */ 543{ /* Used to link together several object links */
492 struct oblnk *link; 544 struct oblnk *link;
493 long value; /* Used as connected value in buttons/gates */ 545 long value; /* Used as connected value in buttons/gates */
494 struct oblinkpt *next; 546 struct oblinkpt *next;
495} oblinkpt; 547} oblinkpt;
548
549object *find_skill_by_name (object *who, const char *name);
550object *find_skill_by_name (object *who, const shstr &sh);
551object *find_skill_by_number (object *who, int skillno);
496 552
497/* 553/*
498 * The archetype structure is a set of rules on how to generate and manipulate 554 * The archetype structure is a set of rules on how to generate and manipulate
499 * objects which point to archetypes. 555 * objects which point to archetypes.
500 * This probably belongs in arch.h, but there really doesn't appear to 556 * This probably belongs in arch.h, but there really doesn't appear to
502 * object and pointers. This structure should get removed, and just replaced 558 * object and pointers. This structure should get removed, and just replaced
503 * by the object structure 559 * by the object structure
504 */ 560 */
505 561
506INTERFACE_CLASS (archetype) 562INTERFACE_CLASS (archetype)
507struct archetype : zero_initialised, attachable 563struct archetype : object
508{ 564{
509 archetype (); 565 archetype (const char *name);
510 ~archetype (); 566 ~archetype ();
511 void gather_callbacks (AV *&callbacks, event_type event) const; 567 void gather_callbacks (AV *&callbacks, event_type event) const;
512 568
513 static archetype *read (object_thawer &f); 569 static archetype *read (object_thawer &f);
514 static archetype *get (const char *name); // find or create 570 static archetype *get (const char *name); // find or create
515 static archetype *find (const char *name); 571 static archetype *find (const char *name);
516 572
517 void hash_add (); // add to hashtable 573 void link ();
518 void hash_del (); // remove from hashtable 574 void unlink ();
519 575
576 object_vector_index ACC (RW, archid); // index in archvector
520 shstr ACC (RW, name); /* More definite name, like "generate_kobold" */ 577 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
521 struct archetype *ACC (RW, next); /* Next archetype in a linked list */ 578 bool ACC (RW, stub); // if true, this is an invalid archetype
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) */ 579 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
526 bool ACC (RW, linked); // linked into list of heads 580
527 sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is 581 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
528 * in comparison to the head. 582 sint8 ACC (RW, max_x), ACC (RW, max_y);
529 */
530}; 583};
584
585inline void
586object_freezer::put (keyword k, archetype *v)
587{
588 put (k, v ? &v->archname : (const char *)0);
589}
590
591typedef object_vector<object, &object::index > objectvec;
592typedef object_vector<object, &object::active> activevec;
593typedef object_vector<archetype, &archetype::archid> archvec;
594
595extern objectvec objects;
596extern activevec actives;
597extern archvec archetypes;
598
599#define for_all_objects(var) \
600 for (unsigned _i = 0; _i < objects.size (); ++_i) \
601 statementvar (object *, var, objects [_i])
602
603#define for_all_actives(var) \
604 for (unsigned _i = 0; _i < actives.size (); ++_i) \
605 statementvar (object *, var, actives [_i])
606
607#define for_all_archetypes(var) \
608 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
609 statementvar (archetype *, var, archetypes [_i])
531 610
532/* Used by update_object to know if the object being passed is 611/* Used by update_object to know if the object being passed is
533 * being added or removed. 612 * being added or removed.
534 */ 613 */
535#define UP_OBJ_INSERT 1 614#define UP_OBJ_INSERT 1
569#define INS_NO_WALK_ON 0x0004 648#define INS_NO_WALK_ON 0x0004
570#define INS_ON_TOP 0x0008 649#define INS_ON_TOP 0x0008
571#define INS_BELOW_ORIGINATOR 0x0010 650#define INS_BELOW_ORIGINATOR 0x0010
572#define INS_MAP_LOAD 0x0020 651#define INS_MAP_LOAD 0x0020
573 652
574#define ARCH_SINGULARITY "singularity"
575#define ARCH_DETECT_MAGIC "detect_magic"
576#define ARCH_DEPLETION "depletion" 653#define ARCH_DEPLETION "depletion"
577#define ARCH_SYMPTOM "symptom"
578 654
579#endif 655#endif
580 656

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines