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.164 by root, Mon Apr 21 06:16:02 2008 UTC vs.
Revision 1.211 by sf-marcmagus, Sun Oct 11 05:43:35 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,2008 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, must be 0 if nrof == 0 */ 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); 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);
441 MTH void force_set_timer (int duration);
357 MTH void force_add (const shstr name, int duration = 0); 442 MTH object *force_add (shstr_tmp name, int duration = 0);
443
444 oblinkpt *find_link () const;
445 MTH void add_link (maptile *map, shstr_tmp id);
446 MTH void remove_link ();
358 447
359 // overwrite the attachable should_invoke function with a version that also checks ev_want_type 448 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
360 bool should_invoke (event_type event) 449 bool should_invoke (event_type event)
361 { 450 {
362 return ev_want_event [event] || ev_want_type [type] || cb; 451 return ev_want_event [event] || ev_want_type [type] || cb;
377 // info must hold 256 * 3 bytes currently 466 // info must hold 256 * 3 bytes currently
378 const char *debug_desc (char *info) const; 467 const char *debug_desc (char *info) const;
379 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 468 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
380 const char *flag_desc (char *desc, int len) const; 469 const char *flag_desc (char *desc, int len) const;
381 470
382 MTH bool decrease_nr (sint32 nr); 471 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
383 MTH object *split_nr (sint32 nr); 472 MTH object *split (sint32 nr = 1); // return 0 on failure
384 473
385 MTH int number_of () const 474 MTH int number_of () const
386 { 475 {
387 return nrof ? nrof : 1; 476 return nrof ? nrof : 1;
388 } 477 }
398 const materialtype_t *dominant_material () const; 487 const materialtype_t *dominant_material () const;
399 488
400 // return the volume of this object in cm³ 489 // return the volume of this object in cm³
401 MTH uint64 volume () const 490 MTH uint64 volume () const
402 { 491 {
403 return total_weight () 492 return (uint64)total_weight ()
404 * 1000 493 * 1000
405 * (type == CONTAINER ? 1000 : 1) 494 * (type == CONTAINER ? 1000 : 1)
406 / dominant_material ()->density; 495 / dominant_material ()->density;
407 } 496 }
408 497
498 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; }
499
500 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
409 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; } 501 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
410 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET 502 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
411 || type == CLOAK || type == BOOTS || type == GLOVES 503 || type == CLOAK || type == BOOTS || type == GLOVES
412 || type == BRACERS || type == GIRDLE; } 504 || type == BRACERS || type == GIRDLE; }
413 MTH bool is_alive () const { return (type == PLAYER 505 MTH bool is_alive () const { return (type == PLAYER
430 /* This return true if object has still randomitems which 522 /* This return true if object has still randomitems which
431 * could be expanded. 523 * could be expanded.
432 */ 524 */
433 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 525 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
434 526
527 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
528
529 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
530
531 // returns the outermost owner, never returns 0
532 MTH object *outer_owner ()
533 {
534 object *op;
535
536 for (op = this; op->owner; op = op->owner)
537 ;
538
539 return op;
540 }
541
435 // returns the outermost environment, never returns 0 542 // returns the outermost environment, never returns 0
543 MTH object *outer_env_or_self () const
544 {
545 const object *op;
546
547 for (op = this; op->env; op = op->env)
548 ;
549
550 return const_cast<object *>(op);
551 }
552
553 // returns the outermost environment, may return 0
436 MTH object *outer_env () 554 MTH object *outer_env () const
437 { 555 {
438 for (object *op = this; ; op = op->env) 556 return env ? outer_env_or_self () : 0;
439 if (!op->env)
440 return op;
441 } 557 }
442 558
443 // returns the player that has this object in his inventory, or 0 559 // returns the player that has this object in his inventory, or 0
444 // we assume the player is always the outer env 560 // we assume the player is always the outer env
445 MTH object *in_player () 561 MTH object *in_player () const
446 { 562 {
447 object *op = outer_env (); 563 object *op = outer_env_or_self ();
448 564
449 return op->type == PLAYER ? op : 0; 565 return op->type == PLAYER ? op : 0;
450 } 566 }
451 567
452 // "temporary" helper function 568 // "temporary" helper function
453 MTH object *head_ () 569 MTH object *head_ () const
454 { 570 {
455 return head ? head : this; 571 return head ? head : const_cast<object *>(this);
456 } 572 }
457 573
458 MTH bool is_head () 574 MTH bool is_head () const
459 { 575 {
460 return head_ () == this; 576 return head_ () == this;
461 } 577 }
462 578
463 MTH bool is_on_map () const 579 MTH bool is_on_map () const
464 { 580 {
465 return !env && !flag [FLAG_REMOVED]; 581 return !env && !flag [FLAG_REMOVED];
466 } 582 }
467 583
584 MTH bool is_inserted () const
585 {
586 return !flag [FLAG_REMOVED];
587 }
588
589 MTH bool is_player () const
590 {
591 return !!contr;
592 }
593
594 MTH bool affects_los () const
595 {
596 return glow_radius || flag [FLAG_BLOCKSVIEW];
597 }
598
599 MTH bool has_carried_lights () const
600 {
601 return glow_radius;
602 }
603
604 // returns the player that cna see this object, if any
605 MTH object *visible_to () const;
606
468 MTH std::string long_desc (object *who = 0); 607 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
469 MTH std::string describe_monster (object *who = 0); 608 MTH std::string describe_monster (object *who = 0);
470 MTH std::string describe_item (object *who = 0); 609 MTH std::string describe_item (object *who = 0);
471 MTH std::string describe (object *who = 0); 610 MTH std::string describe (object *who = 0); // long description, without name
611
612 MTH const char *query_weight () { return ::query_weight (this); }
613 MTH const char *query_name () { return ::query_name (this); }
614 MTH const char *query_short_name () { return ::query_short_name (this); }
615 MTH const char *query_base_name (bool plural) { return ::query_base_name (this, plural); }
472 616
473 // If this object has no extra parts but should have them, 617 // If this object has no extra parts but should have them,
474 // add them, effectively expanding heads into multipart 618 // add them, effectively expanding heads into multipart
475 // objects. This method only works on objects not inserted 619 // objects. This method only works on objects not inserted
476 // anywhere. 620 // anywhere.
491 // set the given flag on all objects in the inventory recursively 635 // set the given flag on all objects in the inventory recursively
492 MTH void set_flag_inv (int flag, int value = 1); 636 MTH void set_flag_inv (int flag, int value = 1);
493 637
494 void enter_exit (object *exit);//Perl 638 void enter_exit (object *exit);//Perl
495 MTH void enter_map (maptile *newmap, int x, int y); 639 MTH void enter_map (maptile *newmap, int x, int y);
640 void player_goto (const char *path, int x, int y); // only for players
496 641
497 // returns the mapspace this object is in 642 // returns the mapspace this object is in
498 mapspace &ms () const; 643 mapspace &ms () const;
499 644
500 // fully recursive iterator 645 // fully recursive iterator
536 { 681 {
537 return this; 682 return this;
538 } 683 }
539 684
540 /* This returns TRUE if the object is something that 685 /* This returns TRUE if the object is something that
541 * should be displayed in the floorbox/inventory window 686 * a client might want to know about.
542 */ 687 */
543 MTH bool client_visible () const 688 MTH bool client_visible () const
544 { 689 {
545 return !invisible && type != PLAYER; 690 return !invisible && type != PLAYER;
546 } 691 }
547 692
693 // the client does nrof * this weight
694 MTH sint32 client_weight () const
695 {
696 return weight + carrying;
697 }
698
548 MTH struct region *region () const; 699 MTH struct region *region () const;
549 700
550 void statusmsg (const char *msg, int color = NDI_BLACK); 701 void statusmsg (const char *msg, int color = NDI_BLACK);
551 void failmsg (const char *msg, int color = NDI_RED); 702 void failmsg (const char *msg, int color = NDI_RED);
552 703
553 const char *query_inventory (object *who = 0, const char *indent = ""); 704 const char *query_inventory (object *who = 0, const char *indent = "");
554 705
555 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 706 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
556 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible 707 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
708
709 // make some noise with given item into direction dir,
710 // currently only used for players to make them temporarily visible
711 // when they are invisible.
712 MTH void make_noise ();
713
714 /* animation */
715 MTH bool has_anim () const { return animation_id; }
716 const animation &anim () const { return animations [animation_id]; }
717 MTH faceidx get_anim_frame (int frame) const { return anim ().faces [frame]; }
718 MTH void set_anim_frame (int frame) { face = get_anim_frame (frame); }
719 /* anim_frames () returns the number of animations allocated. The last
720 * usuable animation will be anim_frames () - 1 (for example, if an object
721 * has 8 animations, anim_frames () will return 8, but the values will
722 * range from 0 through 7.
723 */
724 MTH int anim_frames () const { return anim ().num_animations; }
725 MTH int anim_facings () const { return anim ().facings; }
726
727 MTH char *as_string ();
557 728
558protected: 729protected:
559 void link (); 730 void link ();
560 void unlink (); 731 void unlink ();
561 732
562 object (); 733 object ();
563 ~object (); 734 ~object ();
735
736private:
737 object &operator =(const object &);
738 object (const object &);
564}; 739};
565 740
566// move this object to the top of its env's inventory to speed up 741// move this object to the top of its env's inventory to speed up
567// searches for it. 742// searches for it.
568static object * 743static object *
569splay (object *ob) 744splay (object *ob)
570{ 745{
571 if (ob->env && ob->env->inv != ob) 746 if (ob->above && ob->env)
572 { 747 {
573 if (ob->above) ob->above->below = ob->below; 748 if (ob->above) ob->above->below = ob->below;
574 if (ob->below) ob->below->above = ob->above; 749 if (ob->below) ob->below->above = ob->above;
575 750
576 ob->above = 0; 751 ob->above = 0;
580 } 755 }
581 756
582 return ob; 757 return ob;
583} 758}
584 759
585typedef struct oblnk
586{ /* Used to link together several objects */
587 object_ptr ob;
588 struct oblnk *next;
589} objectlink;
590
591typedef struct oblinkpt
592{ /* Used to link together several object links */
593 struct oblnk *link;
594 sint32 value; /* Used as connected value in buttons/gates */
595 struct oblinkpt *next;
596} oblinkpt;
597
598object *find_skill_by_name (object *who, const char *name); 760object *find_skill_by_name_fuzzy (object *who, const char *name);
599object *find_skill_by_name (object *who, const shstr &sh); 761object *find_skill_by_name (object *who, shstr_cmp sh);
600object *find_skill_by_number (object *who, int skillno); 762object *find_skill_by_number (object *who, int skillno);
601 763
602/* 764/*
603 * The archetype structure is a set of rules on how to generate and manipulate 765 * The archetype structure is a set of rules on how to generate and manipulate
604 * objects which point to archetypes. 766 * objects which point to archetypes.
621 MTH static archetype *find (const_utf8_string name); 783 MTH static archetype *find (const_utf8_string name);
622 784
623 MTH void link (); 785 MTH void link ();
624 MTH void unlink (); 786 MTH void unlink ();
625 787
788 MTH static object *get (const char *name); // (find() || singularity)->instance()
626 MTH object *instance (); 789 MTH object *instance ();
627 790
628 object_vector_index ACC (RW, archid); // index in archvector 791 object_vector_index ACC (RW, archid); // index in archvector
629 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 792 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
630 793
635 static archetype *read (object_thawer &f); 798 static archetype *read (object_thawer &f);
636 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 799 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
637 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */ 800 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
638}; 801};
639 802
803// compatbiility, remove once replaced by ->instance
804inline object *
805arch_to_object (archetype *at)
806{
807 return at->instance ();
808}
809
640inline void 810inline void
641object_freezer::put (keyword k, archetype *v) 811object_freezer::put (keyword k, archetype *v)
642{ 812{
643 put (k, v ? &v->archname : (const char *)0); 813 put (k, v ? &v->archname : (const char *)0);
644} 814}
649 819
650extern objectvec objects; 820extern objectvec objects;
651extern activevec actives; 821extern activevec actives;
652extern archvec archetypes; 822extern archvec archetypes;
653 823
824// "safely" iterate over inv in a way such that the current item is removable
825// quite horrible, that's why its hidden in some macro
826#define for_inv_removable(op,var) \
827 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
828
654#define for_all_objects(var) \ 829#define for_all_objects(var) \
655 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 830 for (unsigned _i = 0; _i < objects.size (); ++_i) \
656 statementvar (object *, var, objects [_i]) 831 statementvar (object *, var, objects [_i])
657 832
658#define for_all_actives(var) \ 833#define for_all_actives(var) \
659 for (unsigned _i = 0; _i < actives.size (); ++_i) \ 834 for (unsigned _i = 0; _i < actives.size (); ++_i) \
660 statementvar (object *, var, actives [_i]) 835 statementvar (object *, var, actives [_i])
661 836
662#define for_all_archetypes(var) \ 837#define for_all_archetypes(var) \
663 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ 838 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
664 statementvar (archetype *, var, archetypes [_i]) 839 statementvar (archetype *, var, archetypes [_i])
665 840
666/* Used by update_object to know if the object being passed is 841/* Used by update_object to know if the object being passed is
667 * being added or removed. 842 * being added or removed.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines