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.8 by root, Sun Aug 27 16:15:12 2006 UTC vs.
Revision 1.242 by root, Tue Apr 13 03:44:21 2010 UTC

1/* 1/*
2 * static char *rcsid_object_h = 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * "$Id: object.h,v 1.8 2006/08/27 16:15:12 root Exp $"; 3 *
4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992 Frank Tore Johansen
7 *
8 * Deliantra is free software: you can redistribute it and/or modify it under
9 * the terms of the Affero GNU General Public License as published by the
10 * Free Software Foundation, either version 3 of the License, or (at your
11 * 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 Affero GNU General Public License
19 * and the GNU General Public License along with this program. If not, see
20 * <http://www.gnu.org/licenses/>.
21 *
22 * The authors can be reached via e-mail to <support@deliantra.net>
4 */ 23 */
5
6/*
7 CrossFire, A Multiplayer game for X-windows
8
9 Copyright (C) 2001 Mark Wedel & Crossfire Development Team
10 Copyright (C) 1992 Frank Tore Johansen
11
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or
15 (at your option) any later version.
16
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
21
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25
26 The authors can be reached via e-mail at crossfire-devel@real-time.com
27*/
28 24
29#ifndef OBJECT_H 25#ifndef OBJECT_H
30#define OBJECT_H 26#define OBJECT_H
31 27
32#include "cfperl.h" 28#include "cfperl.h"
33#include "shstr.h" 29#include "shstr.h"
34 30
31//+GPL
32
35typedef uint32 tag_t; 33typedef int tag_t;
34
35// also see common/item.C
36enum
37{
38 body_skill,
39 body_combat,
40 body_range,
41 body_shield,
42 body_arm,
43 body_torso,
44 body_head,
45 body_neck,
46 body_finger,
47 body_shoulder,
48 body_foot,
49 body_hand,
50 body_wrist,
51 body_waist,
36#define NUM_BODY_LOCATIONS 12 52 NUM_BODY_LOCATIONS
37#define BODY_ARMS 1 53};
38 54
39/* See common/item.c */ 55/* See common/item.c */
40 56
41typedef struct Body_Locations { 57typedef struct Body_Locations
58{
42 const char *save_name; /* Name used to load/save it to disk */ 59 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 */ 60 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 */ 61 const char *nonuse_name; /* Name to describe objects we can't use */
45} Body_Locations; 62} Body_Locations;
46 63
47extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 64extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
48 65
49typedef struct _event 66#define NUM_COINS 4 /* number of coin types */
50{ 67extern const char *const coins[NUM_COINS + 1];
51 int type;
52 const char *hook;
53 const char *plugin;
54 const char *options;
55 struct _event *next;
56} event;
57 68
58/* 69/*
59 * Each object (this also means archetypes!) could have a few of these 70 * Each object (this also means archetypes!) could have a few of these
60 * "dangling" from it; this could also end up containing 'parse errors'. 71 * "dangling" from it; this could also end up containing 'parse errors'.
61 * 72 *
62 * key and value are shared-strings. 73 * key and value are shared-strings.
63 * 74 *
64 * Please use get_ob_key_value(), set_ob_key_value() from object.c rather than 75 * Please use kv_get/kv_set/kv_del from object rather than
65 * accessing the list directly. 76 * accessing the list directly.
66 * Exception is if you want to walk this list for some reason. 77 * Exception is if you want to walk this list for some reason.
67 */ 78 */
68typedef struct _key_value { 79struct key_value : slice_allocated
69 const char * key; 80{
70 const char * value;
71 struct _key_value * next; 81 key_value *next;
72} key_value; 82 shstr key, value;
83};
73 84
85//-GPL
86
87struct UUID
88{
89 uint64 seq;
90
91 enum { MAX_LEN = 3 + 16 + 1 + 1 }; // <1. + hex + > + \0
92
93 static UUID cur; // last uuid generated
94 static void init ();
95 static UUID gen ();
96
97 UUID () { }
98 UUID (uint64 seq) : seq(seq) { }
99 operator uint64() { return seq; }
100 void operator =(uint64 seq) { this->seq = seq; }
101
102 bool parse (const char *s);
103 char *append (char *buf) const;
104 char *c_str () const;
105};
106
107//+GPL
74 108
75/* Definition for WILL_APPLY values. Replaces having harcoded values 109/* Definition for WILL_APPLY values. Replaces having harcoded values
76 * sprinkled in the code. Note that some of these also replace fields 110 * sprinkled in the code. Note that some of these also replace fields
77 * that were in the can_apply area. What is the point of having both 111 * that were in the can_apply area. What is the point of having both
78 * can_apply and will_apply? 112 * can_apply and will_apply?
79 */ 113 */
80#define WILL_APPLY_HANDLE 0x1 114#define WILL_APPLY_HANDLE 0x01
81#define WILL_APPLY_TREASURE 0x2 115#define WILL_APPLY_TREASURE 0x02
82#define WILL_APPLY_EARTHWALL 0x4 116#define WILL_APPLY_EARTHWALL 0x04
83#define WILL_APPLY_DOOR 0x8 117#define WILL_APPLY_DOOR 0x08
84#define WILL_APPLY_FOOD 0x10 118#define WILL_APPLY_FOOD 0x10
85 119
120struct body_slot
121{
122 signed char used:4; /* Calculated value based on items equipped */
123 signed char info:4; /* body info as loaded from the file */
124};
86 125
87/* Note that the ordering of this structure is sort of relevent - 126typedef struct oblnk
88 * copy_object copies everything over beyond 'name' using memcpy. 127{ /* Used to link together several objects */
89 * Thus, values that need to be copied need to be located beyond that 128 object_ptr ob;
90 * point. 129 struct oblnk *next;
91 * 130} objectlink;
92 * However, if you're keeping a pointer of some sort, you probably 131
93 * don't just want it copied, so you'll need to add to common/object.c, 132typedef struct oblinkpt
94 * e.g. copy-object 133{ /* Used to link together several object links */
95 * 134 struct oblnk *link;
96 * I've tried to clean up this structure a bit (in terms of formatting) 135 struct oblinkpt *next;
97 * by making it more consistent. I've also tried to locate some of the fields 136 shstr id; /* Used as connected value in buttons/gates */
98 * more logically together (put the item related ones together, the monster 137} oblinkpt;
99 * related ones, etc. 138
100 * This structure is best viewed with about a 100 width screen. 139INTERFACE_CLASS (object)
101 * MSW 2002-07-05 140// these are being copied
141struct object_copy : attachable
142{
143 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
144
145 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
146 uint8 ACC (RW, subtype); /* subtype of object */
147 sint8 ACC (RW, direction); /* Means the object is moving that way. */
148 sint8 ACC (RW, facing); /* Object is oriented/facing that way. */
149
150 shstr ACC (RW, name); /* The name of the object, obviously... */
151 shstr ACC (RW, name_pl); /* The plural name of the object */
152 shstr ACC (RW, title); /* Of foo, etc */
153 shstr ACC (RW, race); /* human, goblin, dragon, etc */
154 shstr ACC (RW, slaying); /* Which race to do double damage to */
155 /* If this is an exit, this is the filename */
156
157 typedef bitset<NUM_FLAGS> flags_t;
158 flags_t flag; /* various flags */
159#if FOR_PERL
160 bool ACC (RW, flag[NUM_FLAGS]);
161#endif
162
163 materialtype_t *material; // What material this object consists of //TODO, make perl-accessible
164 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
165 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
166 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
167 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
168 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
169 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
170 object_ptr ACC (RW, spell); /* Spell that was being cast */
171 object_ptr ACC (RW, current_weapon); /* Pointer to the weapon currently used */
172 arch_ptr ACC (RW, arch); /* Pointer to archetype */
173 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
174
175 float ACC (RW, speed); /* The overall speed of this object */
176 float ACC (RW, speed_left); /* How much speed is left to spend this round */
177
178 sint32 ACC (RW, nrof); /* How many of the objects */
179 /* This next big block is basically used for monsters and equipment */
180 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
181 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
182
183 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
184 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
185 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
186 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
187
188 uint16 ACC (RW, materials); /* What materials this object consists of */
189 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
190 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
191 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
192
193 /* Note that the last_.. values are sometimes used for non obvious
194 * meanings by some objects, eg, sp penalty, permanent exp.
102 */ 195 */
196 sint16 ACC (RW, last_heal); /* Last healed. Depends on constitution */
197 sint16 ACC (RW, last_sp); /* As last_heal, but for spell points */
198 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
199 sint16 ACC (RW, last_eat); /* How long since we last ate */
103 200
104struct object_simple : extendable<object> { 201 sint16 ACC (RW, invisible); /* How much longer the object will be invis */
105 static data_type get_dt () { return DT_OBJECT; } 202 sint16 ACC (RW, level); /* Level of creature or object */
106 203
204 uint8 ACC (RW, pick_up); /* See crossfire.doc */
205 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
206 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
207 uint8 ACC (RW, weapontype); /* type of weapon */
208
209 body_slot slot [NUM_BODY_LOCATIONS];
210
211 faceidx ACC (RW, face); /* the graphical face */
212
213 faceidx ACC (RW, sound); /* the sound face */
214 faceidx ACC (RW, sound_destroy); /* played on destroy */
215
216 sint32 ACC (RW, weight); /* Attributes of the object */
217 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
218
219 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
220
221 sint64 ACC (RW, perm_exp); /* Permanent exp */
222 living ACC (RO, stats); /* Str, Con, Dex, etc */
223 /* See the pod/objects.pod for more info about body locations */
224
225 /* Following mostly refers to fields only used for monsters */
226
227 /* Spell related information, may be useful elsewhere
228 * Note that other fields are used - these files are basically
229 * only used in spells.
230 */
231 sint16 ACC (RW, duration); /* How long the spell lasts */
232 uint8 ACC (RW, casting_time); /* time left before spell goes off */
233 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
234
235 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
236 sint8 ACC (RW, range); /* Range of the spell */
237 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
238 sint8 ACC (RW, item_power); /* power rating of the object */
239
240 uint8 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
241 MoveType ACC (RW, move_type); /* Type of movement this object uses */
242 MoveType ACC (RW, move_block);/* What movement types this blocks */
243 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
244
245 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
246 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
247 MoveType ACC (RW, move_slow); /* Movement types this slows down */
248
249 // 8 free bits
250
251 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */
252 // /* races/classes can need less/more exp to gain levels */
253 static const float expmul = 1.0;//D
254 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
255
256 /* Following are values used by any object */
257 /* this objects turns into or what this object creates */
258 treasurelist *ACC (RW, randomitems); /* Items to be generated */
259
260 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
261 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
262 uint8 ACC (RW, will_apply); /* See crossfire.doc */
263 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
264 uint16 ACC (RW, animation_id);/* An index into the animation array */
265 uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
266
267 uint16 ACC (RW, cached_eat); /* cached food, used by esrv_update_spells */
268 uint16 ACC (RW, cached_sp); /* cached spell points used for a spell, used by esrv_update_spells */
269 /* allows different movement patterns for attackers */
270 uint8 ACC (RW, move_status); /* What stage in attack mode */
271 uint8 ACC (RW, attack_movement);/* What kind of attack movement */
272
273 //16+ free bits
274
275 // rarely-accessed members should be at the end
276 shstr ACC (RW, tag); // a tag used to tracking this object
277 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
278 shstr ACC (RW, lore); /* Obscure information about this object, */
279 /* To get put into books and the like. */
280 shstr ACC (RW, custom_name); /* Custom name assigned by player */
281};
282
283const_utf8_string query_weight (const object *op);
284const_utf8_string query_short_name (const object *op);
285const_utf8_string query_name (const object *op);
286const_utf8_string query_base_name (const object *op, int plural);
287sint64 query_cost (const object *tmp, object *who, int flag);
288const char *query_cost_string (const object *tmp, object *who, int flag);
289
290int change_ability_duration (object *spell, object *caster);
291int min_casting_level (object *caster, object *spell);
292int casting_level (object *caster, object *spell);
293sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
294int SP_level_dam_adjust (object *caster, object *spob);
295int SP_level_duration_adjust (object *caster, object *spob);
296int SP_level_range_adjust (object *caster, object *spob);
297
298struct freelist_item
299{
300 freelist_item *next;
301 uint32_t count;
302};
303
304struct object : object_copy
305{
107 /* These variables are not changed by copy_object() */ 306 // These variables are not changed by ->copy_to
108 struct pl *contr; /* Pointer to the player which control this object */ 307 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
109 struct object *next; /* Pointer to the next object in the free/used list */ 308
110 struct object *prev; /* Pointer to the previous object in the free/used list*/ 309 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
111 struct object *active_next; /* Next & previous object in the 'active' */ 310 uint32_t ACC (RO, count);
112 struct object *active_prev; /* List. This is used in process_events */ 311 object_vector_index ACC (RO, index); // index into objects
113 /* so that the entire object list does not */ 312 object_vector_index ACC (RO, active); // index into actives
114 /* need to be gone through. */ 313
314 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
315
115 struct object *below; /* Pointer to the object stacked below this one */ 316 object *ACC (RW, below); /* Pointer to the object stacked below this one */
116 struct object *above; /* Pointer to the object stacked above this one */ 317 object *ACC (RW, above); /* Pointer to the object stacked above this one */
117 /* Note: stacked in the *same* environment*/ 318 /* Note: stacked in the *same* environment */
118 struct object *inv; /* Pointer to the first object in the inventory */ 319 object *inv; /* Pointer to the first object in the inventory */
119 struct object *container; /* Current container being used. I think this 320
321 //TODO: container must move into client
322 object_ptr ACC (RW, container);/* Currently opened container. I think this
120 * is only used by the player right now. 323 * is only used by the player right now.
121 */ 324 */
122 struct object *env; /* Pointer to the object which is the environment. 325 object *ACC (RW, env); /* Pointer to the object which is the environment.
123 * This is typically the container that the object is in. 326 * This is typically the container that the object is in.
124 */ 327 */
125 struct object *more; /* Pointer to the rest of a large body of objects */ 328 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
126 struct object *head; /* Points to the main object of a large body */ 329 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
127 struct mapstruct *map; /* Pointer to the map in which this object is present */ 330 key_value *key_values; /* Fields not explictly known by the loader. */
128 331
129 tag_t count; /* Unique object number for this object */ 332 MTH void set_flag (int flagnum)
130 uint16 refcount; /* How many objects points to this object */ 333 {
334 flag [flagnum] = true;
335 }
336
337 MTH void clr_flag (int flagnum)
338 {
339 flag [flagnum] = false;
340 }
341
342 // privates / perl
343 shstr_tmp kv_get (shstr_tmp key) const;
344 void kv_del (shstr_tmp key);
345 void kv_set (shstr_tmp key, shstr_tmp value);
346
347//-GPL
348
349 // custom extra fields management
350 struct key_value_access_proxy
351 {
352 object &ob;
353 shstr_tmp key;
354
355 key_value_access_proxy (object &ob, shstr_tmp key)
356 : ob (ob), key (key)
357 {
358 }
359
360 const key_value_access_proxy &operator =(shstr_tmp value) const
361 {
362 ob.kv_set (key, value);
363 return *this;
364 }
365
366 operator const shstr_tmp () const { return ob.kv_get (key); }
367 operator const char *() const { return ob.kv_get (key); }
368
369 private:
370 void operator =(int);
371 };
372
373 // operator [] is too annoying to use
374 const key_value_access_proxy kv (shstr_tmp key)
375 {
376 return key_value_access_proxy (*this, key);
377 }
378
379 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
380 MTH void post_load_check (); // do some adjustments after parsing
381 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
382 bool write (object_freezer &f);
383
384 MTH static object *create ();
385 const mapxy &operator =(const mapxy &pos);
386 MTH void copy_to (object *dst);
387 MTH object *clone (); // create + copy_to a single object
388 MTH object *deep_clone (); // copy whole more chain and inventory
389 void do_destroy ();
390 void gather_callbacks (AV *&callbacks, event_type event) const;
391 MTH void destroy ();
392 MTH void drop_and_destroy ()
393 {
394 destroy_inv (true);
395 destroy ();
396 }
397
398 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
399 MTH void destroy_inv (bool drop_to_ground = false);
400 MTH void destroy_inv_fast (); // like destroy_inv (false), but only works when *this is destroyed, too
401 MTH object *insert (object *item); // insert into inventory
402 MTH void play_sound (faceidx sound) const;
403 MTH void say_msg (const_utf8_string msg) const;
404
405 void do_remove ();
406 MTH void remove ()
407 {
408 if (!flag [FLAG_REMOVED])
409 do_remove ();
410 }
411
412 MTH bool blocked (maptile *m, int x, int y) const;
413
414 void move_to (const mapxy &pos)
415 {
416 remove ();
417 *this = pos;
418 insert_at (this, this);
419 }
420
421 // high-level move method.
422 // object op is trying to move in direction dir.
423 // originator is typically the same as op, but
424 // can be different if originator is causing op to
425 // move (originator is pushing op)
426 // returns 0 if the object is not able to move to the
427 // desired space, 1 otherwise (in which case we also
428 // move the object accordingly. This function is
429 // very similiar to move_object.
430 int move (int dir, object *originator);
431
432 int move (int dir)
433 {
434 return move (dir, this);
435 }
436
437 // changes move_type to a new value - handles move_on/move_off effects
438 MTH void change_move_type (MoveType mt);
439
440 static bool can_merge_slow (object *op1, object *op2);
441
442 // this is often used in time-critical code, so optimise
443 MTH static bool can_merge (object *op1, object *op2)
444 {
445 return op1->value == op2->value
446 && op1->name == op2->name
447 && can_merge_slow (op1, op2);
448 }
449
450 MTH void set_owner (object *owner);
451 MTH void set_speed (float speed);
452 MTH void set_glow_radius (sint8 rad);
453
454 MTH void open_container (object *new_container);
455 MTH void close_container ()
456 {
457 open_container (0);
458 }
459
460 // potential future accessor for "container"
461 MTH object *container_ () const
462 {
463 return container;
464 }
465
466 MTH bool is_open_container () const
467 {
468 // strangely enough, using ?: here causes code to inflate
469 return type == CONTAINER
470 && ((env && env->container_ () == this)
471 || (!env && flag [FLAG_APPLIED]));
472 }
473
474 MTH object *force_find (shstr_tmp name);
475 MTH void force_set_timer (int duration);
476 MTH object *force_add (shstr_tmp name, int duration = 0);
477
478 oblinkpt *find_link () const;
479 MTH void add_link (maptile *map, shstr_tmp id);
480 MTH void remove_link ();
481
482 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
483 bool should_invoke (event_type event)
484 {
485 return ev_want_event [event] || ev_want_type [type] || cb;
486 }
487
488 MTH void instantiate ();
489
490 // recalculate all stats
491 MTH void update_stats ();
492 MTH void roll_stats ();
493 MTH void swap_stats (int a, int b);
494 MTH void add_statbonus ();
495 MTH void remove_statbonus ();
496 MTH void drain_stat ();
497 MTH void drain_specific_stat (int deplete_stats);
498 MTH void change_luck (int value);
499
500 // info must hold 256 * 3 bytes currently
501 const_utf8_string debug_desc (char *info) const;
502 MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
503 const_utf8_string flag_desc (char *desc, int len) const;
504
505 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
506 MTH object *split (sint32 nr = 1); // return 0 on failure
507
508 MTH int number_of () const
509 {
510 return nrof ? nrof : 1;
511 }
512
513 MTH sint32 total_weight () const
514 {
515 return (weight + carrying) * number_of ();
516 }
517
518 MTH void update_weight ();
519
520 // return the dominant material of this item, always return something
521 const materialtype_t *dominant_material () const
522 {
523 return material;
524 }
525
526 // return the volume of this object in cm³
527 MTH uint64 volume () const
528 {
529 return (uint64)total_weight ()
530 * 1024 // 1000 actually
531 * (type == CONTAINER ? 128 : 1)
532 / dominant_material ()->density; // ugh, division
533 }
534
535 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; }
536
537 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
538 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
539 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
540 || type == CLOAK || type == BOOTS || type == GLOVES
541 || type == BRACERS || type == GIRDLE; }
542 MTH bool is_alive () const { return (type == PLAYER
543 || flag [FLAG_MONSTER]
544 || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR))
545 && !flag [FLAG_IS_A_TEMPLATE]; }
546 MTH bool is_arrow () const { return type == ARROW
547 || (type == SPELL_EFFECT
548 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
549 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
550
551 MTH bool is_dragon () const;
552
553 MTH bool is_immunity () const { return invisible && type == SIGN; }
554
555 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
556
557 // temporary: wether the object can be saved in a map file
558 // contr => is a player
559 // head => only save head of a multitile object
560 // owner => can not reference owner yet
561 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
562
563 /* This return true if object has still randomitems which
564 * could be expanded.
565 */
566 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
567
568 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
569
570 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
571
572 // returns the outermost owner, never returns 0
573 MTH object *outer_owner ()
574 {
575 object *op;
576
577 for (op = this; op->owner; op = op->owner)
578 ;
579
580 return op;
581 }
582
583 // returns the outermost environment, never returns 0
584 MTH object *outer_env_or_self () const
585 {
586 const object *op;
587
588 for (op = this; op->env; op = op->env)
589 ;
590
591 return const_cast<object *>(op);
592 }
593
594 // returns the outermost environment, may return 0
595 MTH object *outer_env () const
596 {
597 return env ? outer_env_or_self () : 0;
598 }
599
600 // returns the player that has this object in his inventory, or 0
601 // we assume the player is always the outer env
602 MTH object *in_player () const
603 {
604 object *op = outer_env_or_self ();
605
606 return op->type == PLAYER ? op : 0;
607 }
608
609 // "temporary" helper function
610 MTH object *head_ () const
611 {
612 return head ? head : const_cast<object *>(this);
613 }
614
615 MTH bool is_head () const
616 {
617 return head_ () == this;
618 }
619
620 MTH bool is_on_map () const
621 {
622 return !env && !flag [FLAG_REMOVED];
623 }
624
625 MTH bool is_inserted () const
626 {
627 return !flag [FLAG_REMOVED];
628 }
629
630 MTH bool is_player () const
631 {
632 return !!contr;
633 }
634
635 /* elmex: this method checks whether the object is in a shop */
636 MTH bool is_in_shop () const;
637
638 MTH bool affects_los () const
639 {
640 return glow_radius || flag [FLAG_BLOCKSVIEW];
641 }
642
643 MTH bool has_carried_lights () const
644 {
645 return glow_radius;
646 }
647
648 // returns the player that cna see this object, if any
649 MTH object *visible_to () const;
650
651 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
652 MTH std::string describe_monster (object *who = 0);
653 MTH std::string describe_item (object *who = 0);
654 MTH std::string describe (object *who = 0); // long description, without name
655
656 MTH const_utf8_string query_weight () { return ::query_weight (this); }
657 MTH const_utf8_string query_name () { return ::query_name (this); }
658 MTH const_utf8_string query_short_name () { return ::query_short_name (this); }
659 MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); }
660
661 // If this object has no extra parts but should have them,
662 // add them, effectively expanding heads into multipart
663 // objects. This method only works on objects not inserted
664 // anywhere.
665 MTH void expand_tail ();
666
667 MTH void create_treasure (treasurelist *tl, int flags = 0);
668
669 // makes sure the player has the named skill,
670 // and also makes it innate if can_use is true.
671 // returns the new skill or 0 if no such skill exists.
672 MTH object *give_skill (shstr_cmp name, bool can_use = false);
673
674 // insert object at same map position as 'where'
675 // handles both inventory and map "positions"
676 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
677 // check whether we can put this into the map, respect max_nrof, max_volume, max_items
678 MTH bool can_drop_at (maptile *m, int x, int y, object *originator = 0);
679 MTH void drop_unpaid_items ();
680
681 MTH void activate ();
682 MTH void deactivate ();
683 MTH void activate_recursive ();
684 MTH void deactivate_recursive ();
685
686 // set the given flag on all objects in the inventory recursively
687 MTH void set_flag_inv (int flag, int value = 1);
688
689 void enter_exit (object *exit);//Perl
690 MTH void enter_map (maptile *newmap, int x, int y);
691 void player_goto (const_utf8_string path, int x, int y); // only for players
692 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
693
694 // returns the mapspace this object is in
695 mapspace &ms () const;
696
697 // fully recursive iterator
698 struct iterator_base
699 {
700 object *item;
701
702 iterator_base (object *container)
703 : item (container)
704 {
705 }
706
707 operator object *() const { return item; }
708
709 object *operator ->() const { return item; }
710 object &operator * () const { return *item; }
711 };
712
713 MTH unsigned int random_seed () const
714 {
715 return (unsigned int)uuid.seq;
716 }
717
718 // depth-first recursive iterator
719 struct depth_iterator : iterator_base
720 {
721 depth_iterator (object *container);
722 void next ();
723 object *operator ++( ) { next (); return item; }
724 object *operator ++(int) { object *i = item; next (); return i; }
725 };
726
727 object *begin ()
728 {
729 return this;
730 }
731
732 object *end ()
733 {
734 return this;
735 }
736
737 /* This returns TRUE if the object is something that
738 * a client might want to know about.
739 */
740 MTH bool client_visible () const
741 {
742 return !invisible && type != PLAYER;
743 }
744
745 // the client does nrof * this weight
746 MTH sint32 client_weight () const
747 {
748 return weight + carrying;
749 }
750
751 MTH struct region *region () const;
752
753 void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
754 void failmsg (const_utf8_string msg, int color = NDI_RED);
755 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
756
757 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
758
759 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
760 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
761
762 // make some noise with given item into direction dir,
763 // currently only used for players to make them temporarily visible
764 // when they are invisible.
765 MTH void make_noise ();
766
767 /* animation */
768 MTH bool has_anim () const { return animation_id; }
769 const animation &anim () const { return animations [animation_id]; }
770 MTH faceidx get_anim_frame (int frame) const { return anim ().faces [frame]; }
771 MTH void set_anim_frame (int frame) { face = get_anim_frame (frame); }
772 /* anim_frames () returns the number of animations allocated. The last
773 * usuable animation will be anim_frames () - 1 (for example, if an object
774 * has 8 animations, anim_frames () will return 8, but the values will
775 * range from 0 through 7.
776 */
777 MTH int anim_frames () const { return anim ().num_animations; }
778 MTH int anim_facings () const { return anim ().facings; }
779
780 MTH utf8_string as_string ();
781
782 // low-level management, statistics, ...
783 static uint32_t ACC (RW, object_count);
784 static uint32_t ACC (RW, free_count);
785 static uint32_t ACC (RW, create_count);
786 static uint32_t ACC (RW, destroy_count);
787 static freelist_item *freelist;
788 MTH static void freelist_free (int count);
789
790protected:
791 void link ();
792 void unlink ();
793
794 void do_delete ();
795
796 object ();
797 ~object ();
798
799private:
800 object &operator =(const object &);
801 object (const object &);
131}; 802};
132 803
133struct object_special { 804// move this object to the top of its env's inventory to speed up
134 /* These get an extra add_refcount(), after having been copied by memcpy(). 805// searches for it.
135 * All fields beow this point are automatically copied by memcpy. If 806static inline object *
136 * adding something that needs a refcount updated, make sure you modify 807splay (object *ob)
137 * copy_object to do so. Everything below here also gets cleared 808{
138 * by clear_object() 809 if (ob->above && ob->env)
139 */
140 const char *name; /* The name of the object, obviously... */
141 const char *name_pl; /* The plural name of the object */
142 const char *title; /* Of foo, etc */
143 const char *race; /* human, goblin, dragon, etc */
144 const char *slaying; /* Which race to do double damage to */
145 /* If this is an exit, this is the filename */
146 const char *skill; /* Name of the skill this object uses/grants */
147 const char *msg; /* If this is a book/sign/magic mouth/etc */
148 const char *lore; /* Obscure information about this object, */
149 /* To get put into books and the like. */
150
151 sint16 x,y; /* Position in the map for this object */
152 sint16 ox,oy; /* For debugging: Where it was last inserted */
153 float speed; /* The overall speed of this object */
154 float speed_left; /* How much speed is left to spend this round */
155 uint32 nrof; /* How many of the objects */
156 New_Face *face; /* Face with colors */
157 sint8 direction; /* Means the object is moving that way. */
158 sint8 facing; /* Object is oriented/facing that way. */
159
160 /* This next big block are basically used for monsters and equipment */
161 uint8 type; /* PLAYER, BULLET, etc. See define.h */
162 uint8 subtype; /* subtype of object */
163 uint16 client_type; /* Public type information. see doc/Developers/objects */
164 sint16 resist[NROFATTACKS]; /* Resistance adjustments for attacks */
165 uint32 attacktype; /* Bitmask of attacks this object does */
166 uint32 path_attuned; /* Paths the object is attuned to */
167 uint32 path_repelled; /* Paths the object is repelled from */
168 uint32 path_denied; /* Paths the object is denied access to */
169 uint16 material; /* What materials this object consist of */
170 const char *materialname; /* specific material name */
171 sint8 magic; /* Any magical bonuses to this item */
172 uint8 state; /* How the object was last drawn (animation) */
173 sint32 value; /* How much money it is worth (or contains) */
174 sint16 level; /* Level of creature or object */
175 /* Note that the last_.. values are sometimes used for non obvious
176 * meanings by some objects, eg, sp penalty, permanent exp.
177 */
178 sint32 last_heal; /* Last healed. Depends on constitution */
179 sint32 last_sp; /* As last_heal, but for spell points */
180 sint16 last_grace; /* as last_sp, except for grace */
181 sint16 last_eat; /* How long since we last ate */
182 sint16 invisible; /* How much longer the object will be invis */
183 uint8 pick_up; /* See crossfire.doc */
184 sint8 item_power; /* power rating of the object */
185 sint8 gen_sp_armour; /* sp regen penalty this object has (was last_heal)*/
186 sint32 weight; /* Attributes of the object */
187 sint32 weight_limit; /* Weight-limit of object */
188 sint32 carrying; /* How much weight this object contains */
189 sint8 glow_radius; /* indicates the glow radius of the object */
190 living stats; /* Str, Con, Dex, etc */
191 sint64 perm_exp; /* Permanent exp */
192 const char *current_weapon_script; /* The script of the currently used weapon. Executed */
193 /* each time the object attacks something */
194 struct object *current_weapon; /* Pointer to the weapon currently used */
195 uint32 weapontype; /* type of weapon */
196 uint32 tooltype; /* type of tool or build facility */
197 sint8 body_info[NUM_BODY_LOCATIONS]; /* body info as loaded from the file */
198 sint8 body_used[NUM_BODY_LOCATIONS]; /* Calculated value based on items equipped */
199 /* See the doc/Developers/objects for more info about body locations */
200
201 /* Following mostly refers to fields only used for monsters */
202 struct object *owner; /* Pointer to the object which controls this one */
203 /* Owner should not be referred to directly - */
204 /* get_owner should be used instead. */
205 tag_t ownercount; /* What count the owner had (in case owner */
206 /* has been freed) */
207 struct object *enemy; /* Monster/player to follow even if not closest */
208 struct object *attacked_by; /* This object start to attack us! only player & monster */
209 tag_t attacked_by_count; /* the tag of attacker, so we can be sure */
210 struct treasureliststruct *randomitems; /* Items to be generated */
211 uint16 run_away; /* Monster runs away if it's hp goes below this percentage. */
212 struct object *chosen_skill; /* the skill chosen to use */
213 uint32 hide; /* The object is hidden, not invisible */
214 /* changes made by kholland@sunlab.cit.cornell.edu */
215 /* allows different movement patterns for attackers */
216 sint32 move_status; /* What stage in attack mode */
217 uint16 attack_movement;/* What kind of attack movement */
218 uint8 will_apply; /* See crossfire.doc */
219 struct object *spellitem; /* Spell ability monster is choosing to use */
220 double expmul; /* needed experience = (calc_exp*expmul) - means some */
221 /* races/classes can need less/more exp to gain levels */
222
223 /* Spell related information, may be useful elsewhere
224 * Note that other fields are used - these files are basically
225 * only used in spells.
226 */
227 sint16 duration; /* How long the spell lasts */
228 uint8 duration_modifier; /* how level modifies duration */
229 sint16 casting_time; /* time left before spell goes off */
230 struct object *spell; /* Spell that was being cast */
231 uint16 start_holding;
232 char *spellarg;
233 uint8 dam_modifier; /* How going up in level effects damage */
234 sint8 range; /* Range of the spell */
235 uint8 range_modifier; /* How going up in level effects range */
236
237 /* Following are values used by any object */
238 struct archt *arch; /* Pointer to archetype */
239 struct archt *other_arch; /* Pointer used for various things - mostly used for what */
240 /* this objects turns into or what this object creates */
241 uint32 flags[4]; /* various flags */
242 uint16 animation_id; /* An index into the animation array */
243 uint8 anim_speed; /* ticks between animation-frames */
244 uint8 last_anim; /* last sequence used to draw face */
245 sint32 elevation; /* elevation of this terrain - not currently used */
246 uint8 smoothlevel; /* how to smooth this square around*/
247
248 MoveType move_type; /* Type of movement this object uses */
249 MoveType move_block; /* What movement types this blocks */
250 MoveType move_allow; /* What movement types explicitly allowd */
251 MoveType move_on; /* Move types affected moving on to this space */
252 MoveType move_off; /* Move types affected moving off this space */
253 MoveType move_slow; /* Movement types this slows down */
254 float move_slow_penalty; /* How much this slows down the object */
255
256 event *events;
257
258 const char *custom_name; /* Custom name assigned by player */
259 key_value *key_values; /* Fields not explictly known by the loader. */
260};
261
262struct object : object_special, object_simple {
263 void instantiate_ ();
264 void instantiate ()
265 {
266 if (attach)
267 { 810 {
268 instantiate_ (); 811 if (ob->above) ob->above->below = ob->below;
269 free_string (attach); 812 if (ob->below) ob->below->above = ob->above;
270 attach = 0; 813
814 ob->above = 0;
815 ob->below = ob->env->inv;
816 ob->below->above = ob;
817 ob->env->inv = ob;
271 } 818 }
272 }
273 void clone (object *destination)
274 {
275 if (attach)
276 destination->attach = add_refcount (attach);
277 819
278 if (self || cb) 820 return ob;
279 INVOKE_OBJECT (CLONE, this, ARG_OBJECT (destination)); 821}
280 }
281};
282 822
283typedef struct oblnk { /* Used to link together several objects */ 823//+GPL
284 object *ob;
285 struct oblnk *next;
286 tag_t id;
287} objectlink;
288 824
289typedef struct oblinkpt { /* Used to link together several object links */ 825object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
290 struct oblnk *link; 826object *find_skill_by_name (object *who, shstr_cmp sh);
291 long value; /* Used as connected value in buttons/gates */ 827object *find_skill_by_number (object *who, int skillno);
292 struct oblinkpt *next;
293} oblinkpt;
294 828
295/* 829/*
296 * The archetype structure is a set of rules on how to generate and manipulate 830 * The archetype structure is a set of rules on how to generate and manipulate
297 * objects which point to archetypes. 831 * objects which point to archetypes.
298 * This probably belongs in arch.h, but there really doesn't appear to 832 * This probably belongs in arch.h, but there really doesn't appear to
299 * be much left in the archetype - all it really is is a holder for the 833 * be much left in the archetype - all it really is is a holder for the
300 * object and pointers. This structure should get removed, and just replaced 834 * object and pointers. This structure should get removed, and just replaced
301 * by the object structure 835 * by the object structure
302 */ 836 */
303 837
304typedef struct archt { 838//-GPL
839
840INTERFACE_CLASS (archetype)
841struct archetype : object, zero_initialised
842{
843 static arch_ptr empty; // the empty_archetype
844 MTH static void gc ();
845
846 archetype (const_utf8_string name);
847 ~archetype ();
848 void gather_callbacks (AV *&callbacks, event_type event) const;
849
850 MTH static archetype *find (const_utf8_string name);
851
852 MTH void link ();
853 MTH void unlink ();
854
855 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
856 MTH object *instance ();
857
858 MTH void post_load_check (); // do some adjustments after parsing
859
860 object_vector_index ACC (RW, archid); // index in archvector
305 const char *name; /* More definite name, like "generate_kobold" */ 861 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
306 struct archt *next; /* Next archetype in a linked list */
307 struct archt *head; /* The main part of a linked object */
308 struct archt *more; /* Next part of a linked object */
309 object clone; /* An object from which to do copy_object() */
310 uint32 editable; /* editable flags (mainly for editor) */
311 sint8 tail_x, tail_y; /* Where the lower right most portion of the object is
312 * in comparison to the head.
313 */
314} archetype;
315 862
863 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
864
865 // support for archetype loading
866 static archetype *read (object_thawer &f);
867 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
868 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
869
870protected:
871 void do_delete ();
872};
873
874// returns whether the object is a dragon player, which are often specialcased
875inline bool
876object::is_dragon () const
877{
878 return arch->race == shstr_dragon && is_player ();
879}
880
881inline void
882object_freezer::put (const keyword_string k, archetype *v)
883{
884 if (expect_true (v))
885 put (k, v->archname);
886 else
887 put (k);
888}
889
890typedef object_vector<object, &object::index > objectvec;
891typedef object_vector<object, &object::active> activevec;
892typedef object_vector<archetype, &archetype::archid> archvec;
893
316extern object *objects; 894extern objectvec objects;
317extern object *active_objects; 895extern activevec actives;
318extern object *free_objects; 896extern archvec archetypes;
319extern object objarray[STARTMAX];
320 897
321extern int nrofallocobjects; 898// "safely" iterate over inv in a way such that the current item is removable
322extern int nroffreeobjects; 899// quite horrible, that's why its hidden in some macro
900#define for_inv_removable(op,var) \
901 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
323 902
324/* This returns TRUE if the object is somethign that 903#define for_all_objects(var) \
325 * should be displayed in the look window 904 for (unsigned _i = 0; _i < objects.size (); ++_i) \
326 */ 905 statementvar (object *, var, objects [_i])
327#define LOOK_OBJ(ob) (!ob->invisible && ob->type!=PLAYER && ob->type!=EVENT_CONNECTOR) 906
907#define for_all_actives(var) \
908 for (unsigned _i = 0; _i < actives.size (); ++_i) \
909 statementvar (object *, var, actives [_i])
910
911#define for_all_archetypes(var) \
912 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
913 statementvar (archetype *, var, archetypes [_i])
914
915//+GPL
328 916
329/* Used by update_object to know if the object being passed is 917/* Used by update_object to know if the object being passed is
330 * being added or removed. 918 * being added or removed.
331 */ 919 */
332#define UP_OBJ_INSERT 1 920#define UP_OBJ_INSERT 1
333#define UP_OBJ_REMOVE 2 921#define UP_OBJ_REMOVE 2
334#define UP_OBJ_CHANGE 3 922#define UP_OBJ_CHANGE 3
335#define UP_OBJ_FACE 4 /* Only thing that changed was the face */ 923#define UP_OBJ_FACE 4 /* Only thing that changed was the face */
336 924
337/* These are flags passed to insert_ob_in_map and 925/* These are flags passed to insert_ob_in_map and
338 * insert_ob_in_ob. Note that all flags may not be meaningful 926 * insert_ob_in_ob. Note that all flags may not be meaningful
339 * for both functions. 927 * for both functions.
340 * Most are fairly explanatory: 928 * Most are fairly explanatory:
349 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 937 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
350 * Use for treasure chests so the new object is the highest thing 938 * Use for treasure chests so the new object is the highest thing
351 * beneath the player, but not actually above it. Note - the 939 * beneath the player, but not actually above it. Note - the
352 * map and x,y coordinates for the object to be inserted must 940 * map and x,y coordinates for the object to be inserted must
353 * match the originator. 941 * match the originator.
354 * INS_MAP_LOAD: disable lots of checkings done at insertion to
355 * speed up map loading process, as we assume the ordering in
356 * loaded map is correct.
357 * 942 *
358 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 943 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
359 * are mutually exclusive. The behaviour for passing more than one 944 * are mutually exclusive. The behaviour for passing more than one
360 * should be considered undefined - while you may notice what happens 945 * should be considered undefined - while you may notice what happens
361 * right now if you pass more than one, that could very well change 946 * right now if you pass more than one, that could very well change
362 * in future revisions of the code. 947 * in future revisions of the code.
363 */ 948 */
364#define INS_NO_MERGE 0x0001 949#define INS_NO_MERGE 0x0001
365#define INS_ABOVE_FLOOR_ONLY 0x0002 950#define INS_ABOVE_FLOOR_ONLY 0x0002
366#define INS_NO_WALK_ON 0x0004 951#define INS_NO_WALK_ON 0x0004
367#define INS_ON_TOP 0x0008 952#define INS_ON_TOP 0x0008
368#define INS_BELOW_ORIGINATOR 0x0010 953#define INS_BELOW_ORIGINATOR 0x0010
369#define INS_MAP_LOAD 0x0020
370 954
371#define ARCH_SINGULARITY "singularity" 955//-GPL
372#define ARCH_SINGULARITY_LEN 11
373#define ARCH_DETECT_MAGIC "detect_magic"
374#define ARCH_DEPLETION "depletion"
375#define ARCH_SYMPTOM "symptom"
376 956
377#endif 957#endif
958

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines