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.157 by root, Fri Apr 11 14:09:56 2008 UTC vs.
Revision 1.206 by root, Wed Sep 16 22:50:50 2009 UTC

1/* 1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 7 *
8 * Deliantra is free software: you can redistribute it and/or modify 8 * Deliantra 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
74 * Each object (this also means archetypes!) could have a few of these 74 * Each object (this also means archetypes!) could have a few of these
75 * "dangling" from it; this could also end up containing 'parse errors'. 75 * "dangling" from it; this could also end up containing 'parse errors'.
76 * 76 *
77 * key and value are shared-strings. 77 * key and value are shared-strings.
78 * 78 *
79 * Please use get_ob_key_value(), set_ob_key_value() from object.c rather than 79 * Please use kv_get/kv_set/kv_del from object rather than
80 * accessing the list directly. 80 * accessing the list directly.
81 * Exception is if you want to walk this list for some reason. 81 * Exception is if you want to walk this list for some reason.
82 */ 82 */
83struct key_value 83struct key_value : slice_allocated
84{ 84{
85 key_value *next; 85 key_value *next;
86 shstr key, value; 86 shstr key, value;
87}; 87};
88 88
136{ 136{
137 signed char info:4; /* body info as loaded from the file */ 137 signed char info:4; /* body info as loaded from the file */
138 signed char used:4; /* Calculated value based on items equipped */ 138 signed char used:4; /* Calculated value based on items equipped */
139}; 139};
140 140
141typedef struct oblnk
142{ /* Used to link together several objects */
143 object_ptr ob;
144 struct oblnk *next;
145} objectlink;
146
147typedef struct oblinkpt
148{ /* Used to link together several object links */
149 struct oblnk *link;
150 struct oblinkpt *next;
151 shstr id; /* Used as connected value in buttons/gates */
152} oblinkpt;
153
141INTERFACE_CLASS (object) 154INTERFACE_CLASS (object)
142// these are being copied 155// these are being copied
143struct object_copy : attachable 156struct object_copy : attachable
144{ 157{
145 typedef bitset<NUM_FLAGS> flags_t;
146
147 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */ 158 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
148 159
149 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */ 160 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
150 uint8 ACC (RW, subtype); /* subtype of object */ 161 uint8 ACC (RW, subtype); /* subtype of object */
151 sint8 ACC (RW, direction); /* Means the object is moving that way. */ 162 sint8 ACC (RW, direction); /* Means the object is moving that way. */
155 shstr ACC (RW, name_pl); /* The plural name of the object */ 166 shstr ACC (RW, name_pl); /* The plural name of the object */
156 shstr ACC (RW, title); /* Of foo, etc */ 167 shstr ACC (RW, title); /* Of foo, etc */
157 shstr ACC (RW, race); /* human, goblin, dragon, etc */ 168 shstr ACC (RW, race); /* human, goblin, dragon, etc */
158 shstr ACC (RW, slaying); /* Which race to do double damage to */ 169 shstr ACC (RW, slaying); /* Which race to do double damage to */
159 /* If this is an exit, this is the filename */ 170 /* If this is an exit, this is the filename */
160 shstr ACC (RW, tag); // a tag used to tracking this object 171
172 typedef bitset<NUM_FLAGS> flags_t;
173 flags_t flag; /* various flags */
174#if FOR_PERL
175 bool ACC (RW, flag[NUM_FLAGS]);
176#endif
177
178 shstr ACC (RW, materialname); /* specific material name */
161 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ 179 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
162 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
163 shstr ACC (RW, lore); /* Obscure information about this object, */
164 /* To get put into books and the like. */
165 shstr ACC (RW, materialname); /* specific material name */
166 shstr ACC (RW, custom_name); /* Custom name assigned by player */
167// materialtype_t *ACC (RW, material); /* What material this object consists of */ 180// materialtype_t *ACC (RW, material); /* What material this object consists of */
168 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */ 181 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
169 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */ 182 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
170 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */ 183 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
171 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */ 184 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
175 arch_ptr ACC (RW, arch); /* Pointer to archetype */ 188 arch_ptr ACC (RW, arch); /* Pointer to archetype */
176 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */ 189 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
177 190
178 float ACC (RW, speed); /* The overall speed of this object */ 191 float ACC (RW, speed); /* The overall speed of this object */
179 float ACC (RW, speed_left); /* How much speed is left to spend this round */ 192 float ACC (RW, speed_left); /* How much speed is left to spend this round */
193
180 uint32 ACC (RW, nrof); /* How many of the objects */ 194 sint32 ACC (RW, nrof); /* How many of the objects */
181
182 /* This next big block are basically used for monsters and equipment */ 195 /* This next big block is basically used for monsters and equipment */
183 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */ 196 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
184
185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 197 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
198
186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 199 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 200 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
188 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */ 201 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
189 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */ 202 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
203
190 uint16 ACC (RW, materials); /* What materials this object consists of */ 204 uint16 ACC (RW, materials); /* What materials this object consists of */
191 sint8 ACC (RW, magic); /* Any magical bonuses to this item */ 205 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
192 uint8 ACC (RW, state); /* How the object was last drawn (animation) */ 206 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
193 sint32 ACC (RW, value); /* How much money it is worth (or contains) */ 207 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
208
194 /* Note that the last_.. values are sometimes used for non obvious 209 /* Note that the last_.. values are sometimes used for non obvious
195 * meanings by some objects, eg, sp penalty, permanent exp. 210 * meanings by some objects, eg, sp penalty, permanent exp.
196 */ 211 */
197 sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */ 212 sint16 ACC (RW, last_heal); /* Last healed. Depends on constitution */
198 sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */ 213 sint16 ACC (RW, last_sp); /* As last_heal, but for spell points */
199 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */ 214 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
200 sint16 ACC (RW, last_eat); /* How long since we last ate */ 215 sint16 ACC (RW, last_eat); /* How long since we last ate */
216
201 sint16 ACC (RW, invisible); /* How much longer the object will be invis */ 217 sint16 ACC (RW, invisible); /* How much longer the object will be invis */
202 sint16 ACC (RW, level); /* Level of creature or object */ 218 sint16 ACC (RW, level); /* Level of creature or object */
219
203 uint8 ACC (RW, pick_up); /* See crossfire.doc */ 220 uint8 ACC (RW, pick_up); /* See crossfire.doc */
204 sint8 ACC (RW, item_power); /* power rating of the object */
205 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */ 221 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 */ 222 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
223 uint8 ACC (RW, weapontype); /* type of weapon */
224
225 faceidx ACC (RW, face); /* the graphical face */
226
227 faceidx ACC (RW, sound); /* the sound face */
228 faceidx ACC (RW, sound_destroy); /* played on destroy */
229
230 body_slot slot [NUM_BODY_LOCATIONS];
231
207 sint32 ACC (RW, weight); /* Attributes of the object */ 232 sint32 ACC (RW, weight); /* Attributes of the object */
208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 233 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
234
209 sint32 ACC (RW, carrying); /* How much weight this object contains */ 235 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
236
210 sint64 ACC (RW, perm_exp); /* Permanent exp */ 237 sint64 ACC (RW, perm_exp); /* Permanent exp */
211 uint32 ACC (RW, weapontype); /* type of weapon */
212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
213 body_slot slot [NUM_BODY_LOCATIONS];
214 faceidx ACC (RW, face); /* the graphical face */
215 faceidx ACC (RW, sound); /* the sound face */
216 faceidx ACC (RW, sound_destroy); /* played on destroy */
217 living ACC (RO, stats); /* Str, Con, Dex, etc */ 238 living ACC (RO, stats); /* Str, Con, Dex, etc */
218 /* See the pod/objects.pod for more info about body locations */ 239 /* See the pod/objects.pod for more info about body locations */
219 240
220 /* Following mostly refers to fields only used for monsters */ 241 /* Following mostly refers to fields only used for monsters */
221 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
222
223 /* allows different movement patterns for attackers */
224 sint32 ACC (RW, move_status); /* What stage in attack mode */
225 uint16 ACC (RW, attack_movement); /* What kind of attack movement */
226 uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
227 float ACC (RW, expmul); /* needed experience = (calc_exp*expmul) - means some */
228 /* races/classes can need less/more exp to gain levels */
229 242
230 /* Spell related information, may be useful elsewhere 243 /* Spell related information, may be useful elsewhere
231 * Note that other fields are used - these files are basically 244 * Note that other fields are used - these files are basically
232 * only used in spells. 245 * only used in spells.
233 */ 246 */
234 sint16 ACC (RW, duration); /* How long the spell lasts */ 247 sint16 ACC (RW, duration); /* How long the spell lasts */
235 sint16 ACC (RW, casting_time);/* time left before spell goes off */ 248 uint8 ACC (RW, casting_time); /* time left before spell goes off */
236
237 uint16 ACC (RW, start_holding);
238 uint8 ACC (RW, duration_modifier); /* how level modifies duration */ 249 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
250
239 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */ 251 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
240
241 sint8 ACC (RW, range); /* Range of the spell */ 252 sint8 ACC (RW, range); /* Range of the spell */
242 uint8 ACC (RW, range_modifier); /* How going up in level effects range */ 253 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
254 sint8 ACC (RW, item_power); /* power rating of the object */
255
256 uint8 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
243 MoveType ACC (RW, move_type); /* Type of movement this object uses */ 257 MoveType ACC (RW, move_type); /* Type of movement this object uses */
244 MoveType ACC (RW, move_block);/* What movement types this blocks */ 258 MoveType ACC (RW, move_block);/* What movement types this blocks */
245
246 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */ 259 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
260
247 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */ 261 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
248 MoveType ACC (RW, move_off); /* Move types affected moving off this space */ 262 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
249 MoveType ACC (RW, move_slow); /* Movement types this slows down */ 263 MoveType ACC (RW, move_slow); /* Movement types this slows down */
250 264
265 // 8 free bits
266
267 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */
268 // /* races/classes can need less/more exp to gain levels */
269 static const float expmul = 1.0;//D
251 float ACC (RW, move_slow_penalty); /* How much this slows down the object */ 270 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
252
253 char *ACC (RW, spellarg);
254 271
255 /* Following are values used by any object */ 272 /* Following are values used by any object */
256 /* this objects turns into or what this object creates */ 273 /* this objects turns into or what this object creates */
257 treasurelist *ACC (RW, randomitems); /* Items to be generated */ 274 treasurelist *ACC (RW, randomitems); /* Items to be generated */
258 flags_t flag; /* various flags */ 275
259#if FOR_PERL
260 bool ACC (RW, flag[NUM_FLAGS]);
261#endif
262 uint16 ACC (RW, animation_id);/* An index into the animation array */
263 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
264 uint8 ACC (RW, last_anim); /* last sequence used to draw face */ 276 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
265 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */
266 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */ 277 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
267 uint8 ACC (RW, will_apply); /* See crossfire.doc */ 278 uint8 ACC (RW, will_apply); /* See crossfire.doc */
279 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
280 uint16 ACC (RW, animation_id);/* An index into the animation array */
281 uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
282
283 uint16 ACC (RW, cached_eat); /* cached food, used by esrv_update_spells */
284 uint16 ACC (RW, cached_sp); /* cached spell points used for a spell, used by esrv_update_spells */
285 /* allows different movement patterns for attackers */
286 uint8 ACC (RW, move_status); /* What stage in attack mode */
287 uint8 ACC (RW, attack_movement);/* What kind of attack movement */
288
289 //16+ free bits
290
291 // rarely-accessed members should be at the end
292 shstr ACC (RW, tag); // a tag used to tracking this object
293 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
294 shstr ACC (RW, lore); /* Obscure information about this object, */
295 /* To get put into books and the like. */
296 shstr ACC (RW, custom_name); /* Custom name assigned by player */
268}; 297};
269 298
299const char *query_weight (const object *op);
300const char *query_short_name (const object *op);
301const char *query_name (const object *op);
302const char *query_base_name (const object *op, int plural);
303
270struct object : zero_initialised, object_copy 304struct object : zero_initialised, object_copy
271{ 305{
272 // These variables are not changed by ->copy_to 306 // These variables are not changed by ->copy_to
273 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ 307 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
274 308
275 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 309 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
276 int ACC (RO, count); 310 int ACC (RO, count);
277 object_vector_index ACC (RO, index); // index into objects 311 object_vector_index ACC (RO, index); // index into objects
278 object_vector_index ACC (RO, active); // index into actives 312 object_vector_index ACC (RO, active); // index into actives
294 object *ACC (RW, 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 */
295 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 329 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
296 client_container *seen_by; // seen by which player/container currently? 330 client_container *seen_by; // seen by which player/container currently?
297 key_value *key_values; /* Fields not explictly known by the loader. */ 331 key_value *key_values; /* Fields not explictly known by the loader. */
298 332
333 // privates / perl
334 shstr_tmp kv_get (shstr_tmp key) const;
335 void kv_del (shstr_tmp key);
336 void kv_set (shstr_tmp key, shstr_tmp value);
337
338 // custom extra fields management
339 struct key_value_access_proxy
340 {
341 object &ob;
342 shstr_tmp key;
343
344 key_value_access_proxy (object &ob, shstr_tmp key)
345 : ob (ob), key (key)
346 {
347 }
348
349 const key_value_access_proxy &operator =(shstr_tmp value) const
350 {
351 ob.kv_set (key, value);
352 return *this;
353 }
354
355 operator const shstr_tmp () const { return ob.kv_get (key); }
356 operator const char *() const { return ob.kv_get (key); }
357
358 private:
359 void operator =(int);
360 };
361
362 // operator [] is too annoying to use
363 const key_value_access_proxy kv (shstr_tmp key)
364 {
365 return key_value_access_proxy (*this, key);
366 }
367
299 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 368 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
300 MTH void post_load_check (); // do some adjustments after parsing 369 MTH void post_load_check (); // do some adjustments after parsing
301 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. 370 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
302 bool write (object_freezer &f); 371 bool write (object_freezer &f);
303 372
304 MTH int slottype () const; 373 MTH int slottype () const;
305 MTH static object *create (); 374 MTH static object *create ();
306 const mapxy &operator =(const mapxy &pos); 375 const mapxy &operator =(const mapxy &pos);
307 object &operator =(const object &src);
308 MTH void copy_to (object *dst); 376 MTH void copy_to (object *dst);
309 MTH object *clone (); // create + copy_to 377 MTH object *clone (); // create + copy_to a single object
378 MTH object *deep_clone (); // copy whole more chain and inventory
310 void do_destroy (); 379 void do_destroy ();
311 void gather_callbacks (AV *&callbacks, event_type event) const; 380 void gather_callbacks (AV *&callbacks, event_type event) const;
312 MTH void destroy (bool destroy_inventory = false); 381 MTH void destroy ();
382 MTH void drop_and_destroy ()
383 {
384 destroy_inv (true);
385 destroy ();
386 }
313 387
314 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 388 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
315 MTH void destroy_inv (bool drop_to_ground = false); 389 MTH void destroy_inv (bool drop_to_ground = false);
316 MTH object *insert (object *item); // insert into inventory 390 MTH object *insert (object *item); // insert into inventory
317 MTH void play_sound (faceidx sound) const; 391 MTH void play_sound (faceidx sound) const;
392 MTH void say_msg (const char *msg) const;
318 393
319 void do_remove (); 394 void do_remove ();
320 MTH void remove () 395 MTH void remove ()
321 { 396 {
322 if (!flag [FLAG_REMOVED]) 397 if (!flag [FLAG_REMOVED])
330 remove (); 405 remove ();
331 *this = pos; 406 *this = pos;
332 insert_at (this, this); 407 insert_at (this, this);
333 } 408 }
334 409
410 // high-level move functions, return true if successful
411 int move (int dir, object *originator);
412
413 int move (int dir)
414 {
415 return move (dir, this);
416 }
417
335 static bool can_merge_slow (object *op1, object *op2); 418 static bool can_merge_slow (object *op1, object *op2);
336 419
337 // this is often used in time-critical code, so optimise 420 // this is often used in time-critical code, so optimise
338 MTH static bool can_merge (object *op1, object *op2) 421 MTH static bool can_merge (object *op1, object *op2)
339 { 422 {
342 && can_merge_slow (op1, op2); 425 && can_merge_slow (op1, op2);
343 } 426 }
344 427
345 MTH void set_owner (object *owner); 428 MTH void set_owner (object *owner);
346 MTH void set_speed (float speed); 429 MTH void set_speed (float speed);
430 MTH void set_glow_radius (sint8 rad);
347 MTH bool change_weapon (object *ob); 431 MTH bool change_weapon (object *ob);
348 MTH bool change_skill (object *ob); 432 MTH bool change_skill (object *ob);
349 433
350 MTH void open_container (object *new_container); 434 MTH void open_container (object *new_container);
351 MTH void close_container () 435 MTH void close_container ()
352 { 436 {
353 open_container (0); 437 open_container (0);
354 } 438 }
355 439
356 MTH object *force_find (const shstr name); 440 MTH object *force_find (shstr_tmp name);
357 MTH void force_add (const shstr name, int duration = 0); 441 MTH object *force_add (shstr_tmp name, int duration = 0);
442
443 oblinkpt *find_link () const;
444 MTH void add_link (maptile *map, shstr_tmp id);
445 MTH void remove_link ();
358 446
359 // overwrite the attachable should_invoke function with a version that also checks ev_want_type 447 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
360 bool should_invoke (event_type event) 448 bool should_invoke (event_type event)
361 { 449 {
362 return ev_want_event [event] || ev_want_type [type] || cb; 450 return ev_want_event [event] || ev_want_type [type] || cb;
377 // info must hold 256 * 3 bytes currently 465 // info must hold 256 * 3 bytes currently
378 const char *debug_desc (char *info) const; 466 const char *debug_desc (char *info) const;
379 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 467 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
380 const char *flag_desc (char *desc, int len) const; 468 const char *flag_desc (char *desc, int len) const;
381 469
470 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
471 MTH object *split (sint32 nr = 1); // return 0 on failure
472
382 int number_of () const 473 MTH int number_of () const
383 { 474 {
384 return nrof ? nrof : 1; 475 return nrof ? nrof : 1;
385 } 476 }
386 477
387 uint64 total_weight () const 478 MTH sint32 total_weight () const
388 { 479 {
389 return weight * number_of (); 480 return (weight + carrying) * number_of ();
390 } 481 }
482
483 MTH void update_weight ();
391 484
392 // return the dominant material of this item, always return something 485 // return the dominant material of this item, always return something
393 const materialtype_t *dominant_material () const; 486 const materialtype_t *dominant_material () const;
394 487
395 // return the volume of this object in cm³ 488 // return the volume of this object in cm³
396 uint64 volume () const 489 MTH uint64 volume () const
397 { 490 {
398 return total_weight () 491 return (uint64)total_weight ()
399 * 1000 492 * 1000
400 * (type == CONTAINER ? 1000 : 1) 493 * (type == CONTAINER ? 1000 : 1)
401 / dominant_material ()->density; 494 / dominant_material ()->density;
402 } 495 }
403 496
497 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
404 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; } 498 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
405 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET 499 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
406 || type == CLOAK || type == BOOTS || type == GLOVES 500 || type == CLOAK || type == BOOTS || type == GLOVES
407 || type == BRACERS || type == GIRDLE; } 501 || type == BRACERS || type == GIRDLE; }
408 MTH bool is_alive () const { return (type == PLAYER 502 MTH bool is_alive () const { return (type == PLAYER
425 /* This return true if object has still randomitems which 519 /* This return true if object has still randomitems which
426 * could be expanded. 520 * could be expanded.
427 */ 521 */
428 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 522 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
429 523
524 MTH bool has_dialogue () const { return *&msg == '@'; }
525
526 // returns the outermost owner, never returns 0
527 MTH object *outer_owner ()
528 {
529 object *op;
530
531 for (op = this; op->owner; op = op->owner)
532 ;
533
534 return op;
535 }
536
537 // returns the outermost environment, never returns 0
538 MTH object *outer_env_or_self () const
539 {
540 const object *op;
541
542 for (op = this; op->env; op = op->env)
543 ;
544
545 return const_cast<object *>(op);
546 }
547
548 // returns the outermost environment, may return 0
549 MTH object *outer_env () const
550 {
551 return env ? outer_env_or_self () : 0;
552 }
553
430 // returns the player that has this object in his inventory, or 0 554 // returns the player that has this object in his inventory, or 0
555 // we assume the player is always the outer env
431 MTH object *in_player () const 556 MTH object *in_player () const
432 { 557 {
433 for (object *op = env; op; op = op->env) 558 object *op = outer_env_or_self ();
434 if (op->type == PLAYER)
435 return op;
436 559
437 return 0; 560 return op->type == PLAYER ? op : 0;
438 } 561 }
439 562
440 // "temporary" helper function 563 // "temporary" helper function
441 MTH object *head_ () 564 MTH object *head_ () const
442 { 565 {
443 return head ? head : this; 566 return head ? head : const_cast<object *>(this);
444 } 567 }
445 568
446 MTH bool is_head () 569 MTH bool is_head () const
447 { 570 {
448 return head_ () == this; 571 return head_ () == this;
449 } 572 }
450 573
574 MTH bool is_on_map () const
575 {
576 return !env && !flag [FLAG_REMOVED];
577 }
578
579 MTH bool is_inserted () const
580 {
581 return !flag [FLAG_REMOVED];
582 }
583
584 MTH bool is_player () const
585 {
586 return !!contr;
587 }
588
589 MTH bool affects_los () const
590 {
591 return glow_radius || flag [FLAG_BLOCKSVIEW];
592 }
593
594 MTH bool has_carried_lights () const
595 {
596 return glow_radius;
597 }
598
599 // returns the player that cna see this object, if any
600 MTH object *visible_to () const;
601
451 MTH std::string long_desc (object *who = 0); 602 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
452 MTH std::string describe_monster (object *who = 0); 603 MTH std::string describe_monster (object *who = 0);
453 MTH std::string describe_item (object *who = 0); 604 MTH std::string describe_item (object *who = 0);
454 MTH std::string describe (object *who = 0); 605 MTH std::string describe (object *who = 0); // long description, without name
606
607 MTH const char *query_weight () { return ::query_weight (this); }
608 MTH const char *query_name () { return ::query_name (this); }
609 MTH const char *query_short_name () { return ::query_short_name (this); }
610 MTH const char *query_base_name (bool plural) { return ::query_base_name (this, plural); }
455 611
456 // If this object has no extra parts but should have them, 612 // If this object has no extra parts but should have them,
457 // add them, effectively expanding heads into multipart 613 // add them, effectively expanding heads into multipart
458 // objects. This method only works on objects not inserted 614 // objects. This method only works on objects not inserted
459 // anywhere. 615 // anywhere.
469 MTH void activate (); 625 MTH void activate ();
470 MTH void deactivate (); 626 MTH void deactivate ();
471 MTH void activate_recursive (); 627 MTH void activate_recursive ();
472 MTH void deactivate_recursive (); 628 MTH void deactivate_recursive ();
473 629
474 // set the givne flag on all objects in the inventory recursively 630 // set the given flag on all objects in the inventory recursively
475 MTH void set_flag_inv (int flag, int value = 1); 631 MTH void set_flag_inv (int flag, int value = 1);
476 632
477 void enter_exit (object *exit);//Perl 633 void enter_exit (object *exit);//Perl
478 MTH void enter_map (maptile *newmap, int x, int y); 634 MTH void enter_map (maptile *newmap, int x, int y);
635 void player_goto (const char *path, int x, int y); // only for players
479 636
480 // returns the mapspace this object is in 637 // returns the mapspace this object is in
481 mapspace &ms () const; 638 mapspace &ms () const;
482 639
483 // fully recursive iterator 640 // fully recursive iterator
519 { 676 {
520 return this; 677 return this;
521 } 678 }
522 679
523 /* This returns TRUE if the object is something that 680 /* This returns TRUE if the object is something that
524 * should be displayed in the floorbox/inventory window 681 * a client might want to know about.
525 */ 682 */
526 MTH bool client_visible () const 683 MTH bool client_visible () const
527 { 684 {
528 return !invisible && type != PLAYER; 685 return !invisible && type != PLAYER;
529 } 686 }
530 687
688 // the client does nrof * this weight
689 MTH sint32 client_weight () const
690 {
691 return weight + carrying;
692 }
693
531 MTH struct region *region () const; 694 MTH struct region *region () const;
532 695
533 void statusmsg (const char *msg, int color = NDI_BLACK); 696 void statusmsg (const char *msg, int color = NDI_BLACK);
534 void failmsg (const char *msg, int color = NDI_RED); 697 void failmsg (const char *msg, int color = NDI_RED);
535 698
536 const char *query_inventory (object *who = 0, const char *indent = ""); 699 const char *query_inventory (object *who = 0, const char *indent = "");
537 700
538 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 701 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
539 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible 702 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
703
704 // make some noise with given item into direction dir,
705 // currently only used for players to make them temporarily visible
706 // when they are invisible.
707 MTH void make_noise ();
708
709 /* animation */
710 bool has_anim () { return animation_id; }
711 const animation &anim () const { return animations [animation_id]; }
712 faceidx get_anim_frame (int frame) const { return anim ().faces [frame]; }
713 void set_anim_frame (int frame) { face = get_anim_frame (frame); }
714 /* anim_frames () returns the number of animations allocated. The last
715 * usuable animation will be anim_frames () - 1 (for example, if an object
716 * has 8 animations, anim_frames () will return 8, but the values will
717 * range from 0 through 7.
718 */
719 int anim_frames () const { return anim ().num_animations; }
720 int anim_facings () const { return anim ().facings; }
540 721
541protected: 722protected:
542 void link (); 723 void link ();
543 void unlink (); 724 void unlink ();
544 725
545 object (); 726 object ();
546 ~object (); 727 ~object ();
728
729private:
730 object &operator =(const object &);
731 object (const object &);
547}; 732};
548 733
549// move this object to the top of its env's inventory to speed up 734// move this object to the top of its env's inventory to speed up
550// searches for it. 735// searches for it.
551static object * 736static object *
563 } 748 }
564 749
565 return ob; 750 return ob;
566} 751}
567 752
568typedef struct oblnk
569{ /* Used to link together several objects */
570 object_ptr ob;
571 struct oblnk *next;
572} objectlink;
573
574typedef struct oblinkpt
575{ /* Used to link together several object links */
576 struct oblnk *link;
577 long value; /* Used as connected value in buttons/gates */
578 struct oblinkpt *next;
579} oblinkpt;
580
581object *find_skill_by_name (object *who, const char *name); 753object *find_skill_by_name_fuzzy (object *who, const char *name);
582object *find_skill_by_name (object *who, const shstr &sh); 754object *find_skill_by_name (object *who, shstr_cmp sh);
583object *find_skill_by_number (object *who, int skillno); 755object *find_skill_by_number (object *who, int skillno);
584 756
585/* 757/*
586 * The archetype structure is a set of rules on how to generate and manipulate 758 * The archetype structure is a set of rules on how to generate and manipulate
587 * objects which point to archetypes. 759 * objects which point to archetypes.
592 */ 764 */
593 765
594INTERFACE_CLASS (archetype) 766INTERFACE_CLASS (archetype)
595struct archetype : object 767struct archetype : object
596{ 768{
769 static arch_ptr empty; // the empty_archetype
770 MTH static void gc ();
771
597 archetype (const char *name); 772 archetype (const char *name);
598 ~archetype (); 773 ~archetype ();
599 void gather_callbacks (AV *&callbacks, event_type event) const; 774 void gather_callbacks (AV *&callbacks, event_type event) const;
600 775
601 static archetype *read (object_thawer &f);
602
603 MTH static archetype *get (const_utf8_string name); // find or create
604 MTH static archetype *find (const_utf8_string name); 776 MTH static archetype *find (const_utf8_string name);
605 777
606 MTH void link (); 778 MTH void link ();
607 MTH void unlink (); 779 MTH void unlink ();
608 780
781 MTH static object *get (const char *name); // (find() || singularity)->instance()
609 MTH object *instance (); 782 MTH object *instance ();
610 783
611 object_vector_index ACC (RW, archid); // index in archvector 784 object_vector_index ACC (RW, archid); // index in archvector
612 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 785 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
613 bool ACC (RW, stub); // if true, this is an invalid archetype
614 786
615 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 787 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
616 sint8 ACC (RW, max_x), ACC (RW, max_y); 788 sint8 ACC (RW, max_x), ACC (RW, max_y);
789
790 // support for archetype loading
791 static archetype *read (object_thawer &f);
792 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
793 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
617}; 794};
795
796// compatbiility, remove once replaced by ->instance
797inline object *
798arch_to_object (archetype *at)
799{
800 return at->instance ();
801}
618 802
619inline void 803inline void
620object_freezer::put (keyword k, archetype *v) 804object_freezer::put (keyword k, archetype *v)
621{ 805{
622 put (k, v ? &v->archname : (const char *)0); 806 put (k, v ? &v->archname : (const char *)0);
628 812
629extern objectvec objects; 813extern objectvec objects;
630extern activevec actives; 814extern activevec actives;
631extern archvec archetypes; 815extern archvec archetypes;
632 816
817// "safely" iterate over inv in a way such that the current item is removable
818// quite horrible, that's why its hidden in some macro
819#define for_inv_removable(op,var) \
820 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
821
633#define for_all_objects(var) \ 822#define for_all_objects(var) \
634 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 823 for (unsigned _i = 0; _i < objects.size (); ++_i) \
635 statementvar (object *, var, objects [_i]) 824 statementvar (object *, var, objects [_i])
636 825
637#define for_all_actives(var) \ 826#define for_all_actives(var) \
638 for (unsigned _i = 0; _i < actives.size (); ++_i) \ 827 for (unsigned _i = 0; _i < actives.size (); ++_i) \
639 statementvar (object *, var, actives [_i]) 828 statementvar (object *, var, actives [_i])
640 829
641#define for_all_archetypes(var) \ 830#define for_all_archetypes(var) \
642 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ 831 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
643 statementvar (archetype *, var, archetypes [_i]) 832 statementvar (archetype *, var, archetypes [_i])
644 833
645/* Used by update_object to know if the object being passed is 834/* Used by update_object to know if the object being passed is
646 * being added or removed. 835 * being added or removed.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines