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.220 by root, Tue Nov 10 05:05:22 2009 UTC vs.
Revision 1.274 by root, Sun Nov 18 15:19:48 2018 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 (©) 2018 Marc Alexander Lehmann / the Deliantra team
4 * Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 5 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team 6 * Copyright (©) 2001 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen 7 * Copyright (©) 1992 Frank Tore Johansen
7 * 8 *
8 * Deliantra is free software: you can redistribute it and/or modify it under 9 * 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 * 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 * Free Software Foundation, either version 3 of the License, or (at your
11 * option) any later version. 12 * option) any later version.
12 * 13 *
13 * This program is distributed in the hope that it will be useful, 14 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details. 17 * GNU General Public License for more details.
17 * 18 *
18 * You should have received a copy of the Affero GNU General Public License 19 * 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 * and the GNU General Public License along with this program. If not, see
20 * <http://www.gnu.org/licenses/>. 21 * <http://www.gnu.org/licenses/>.
21 * 22 *
22 * The authors can be reached via e-mail to <support@deliantra.net> 23 * The authors can be reached via e-mail to <support@deliantra.net>
23 */ 24 */
24 25
25#ifndef OBJECT_H 26#ifndef OBJECT_H
26#define OBJECT_H 27#define OBJECT_H
27 28
28#include <bitset>
29
30#include "cfperl.h" 29#include "cfperl.h"
31#include "shstr.h" 30#include "shstr.h"
32 31
33//+GPL 32//+GPL
34 33
35typedef int tag_t; 34typedef int tag_t;
36 35
36// also see common/item.C
37enum { 37enum
38 body_skill, 38{
39 body_combat, 39# define def(name, use, nonuse) body_ ## name,
40 body_range, 40# include "slotinc.h"
41 body_shield, 41# undef def
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,
52 NUM_BODY_LOCATIONS 42 NUM_BODY_LOCATIONS
53}; 43};
54 44
55enum slottype_t
56{
57 slot_none,
58 slot_combat,
59 slot_ranged,
60};
61
62/* See common/item.c */ 45/* See common/item.c */
63 46
64typedef struct Body_Locations 47struct Body_Locations
65{ 48{
49 const char *name; /* Short name/identifier */
66 keyword save_name; /* Name used to load/save it to disk */ 50 keyword kw; /* Name used to load/save it to disk */
67 const char *use_name; /* Name used when describing an item we can use */ 51 const char *use_name; /* Name used when describing an item we can use */
68 const char *nonuse_name; /* Name to describe objects we can't use */ 52 const char *nonuse_name; /* Name to describe objects we can't use */
69} Body_Locations; 53};
70 54
71extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 55extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
56
57// for each set of directions (1 == up, 2 == right, 4 == down, 8 == left)
58// contains the wall suffix (0, 1_3, 1_4 and so on).
59extern const char *wall_suffix[16];
72 60
73#define NUM_COINS 4 /* number of coin types */ 61#define NUM_COINS 4 /* number of coin types */
74extern const char *const coins[NUM_COINS + 1]; 62extern const char *const coins[NUM_COINS + 1];
63
64// restart server when object_count reaches this value
65#define RESTART_COUNT 0xe0000000
75 66
76/* 67/*
77 * Each object (this also means archetypes!) could have a few of these 68 * Each object (this also means archetypes!) could have a few of these
78 * "dangling" from it; this could also end up containing 'parse errors'. 69 * "dangling" from it; this could also end up containing 'parse errors'.
79 * 70 *
83 * accessing the list directly. 74 * accessing the list directly.
84 * Exception is if you want to walk this list for some reason. 75 * Exception is if you want to walk this list for some reason.
85 */ 76 */
86struct key_value : slice_allocated 77struct key_value : slice_allocated
87{ 78{
88 key_value *next; 79 key_value *next; // must be first element
89 shstr key, value; 80 shstr key, value;
81};
82
83// "crossfires version of a perl hash."
84struct key_values
85{
86 key_value *first; // must be first element
87
88 bool empty() const
89 {
90 return !first;
91 }
92
93 void clear ();
94 shstr_tmp get (shstr_tmp key) const;
95 void del (shstr_tmp key);
96 void set (shstr_tmp key, shstr_tmp value);
97
98 void add (shstr_tmp key, shstr_tmp value); // liek set, but doesn't check for duplicates
99 void reverse (); // reverses the ordering, to be used after loading an object
100 key_values &operator =(const key_values &kv);
101
102 // custom extra fields management
103 struct access_proxy
104 {
105 key_values &kv;
106 shstr_tmp key;
107
108 access_proxy (key_values &kv, shstr_tmp key)
109 : kv (kv), key (key)
110 {
111 }
112
113 const access_proxy &operator =(shstr_tmp value) const
114 {
115 kv.set (key, value);
116 return *this;
117 }
118
119 operator const shstr_tmp () const { return kv.get (key); }
120 operator const char *() const { return kv.get (key); }
121
122 private:
123 void operator =(int);
124 };
125
126 const access_proxy operator [](shstr_tmp key)
127 {
128 return access_proxy (*this, key);
129 }
90}; 130};
91 131
92//-GPL 132//-GPL
93 133
94struct UUID 134struct UUID
140{ /* Used to link together several object links */ 180{ /* Used to link together several object links */
141 struct oblnk *link; 181 struct oblnk *link;
142 struct oblinkpt *next; 182 struct oblinkpt *next;
143 shstr id; /* Used as connected value in buttons/gates */ 183 shstr id; /* Used as connected value in buttons/gates */
144} oblinkpt; 184} oblinkpt;
185
186// temporary hack to find the culprit who corrupts face numbers. maybe. hopefully.
187struct faceidx_debug
188{
189 faceidx x;
190
191 operator faceidx () const
192 {
193 return x;
194 }
195
196 faceidx operator =(faceidx i)
197 {
198 if (ecb_expect_false (i >= faces.size ()))
199 {
200 fork_abort ("illegal faceidx assignment");
201 i = blank_face;
202 }
203
204 return x = i;
205 }
206};
207
208#if CFPERL
209static inline void sv_to (SV *sv, faceidx_debug &v) { v = SvIV (sv); }
210#endif
145 211
146INTERFACE_CLASS (object) 212INTERFACE_CLASS (object)
147// these are being copied 213// these are being copied
148struct object_copy : attachable 214struct object_copy : attachable
149{ 215{
213 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */ 279 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
214 uint8 ACC (RW, weapontype); /* type of weapon */ 280 uint8 ACC (RW, weapontype); /* type of weapon */
215 281
216 body_slot slot [NUM_BODY_LOCATIONS]; 282 body_slot slot [NUM_BODY_LOCATIONS];
217 283
218 faceidx ACC (RW, face); /* the graphical face */ 284 faceidx_debug ACC (RW, face); /* the graphical face */
219 285
220 faceidx ACC (RW, sound); /* the sound face */ 286 faceidx ACC (RW, sound); /* the sound face */
221 faceidx ACC (RW, sound_destroy); /* played on destroy */ 287 faceidx ACC (RW, sound_destroy); /* played on destroy */
222 288
223 sint32 ACC (RW, weight); /* Attributes of the object */ 289 sint32 ACC (RW, weight); /* Attributes of the object */
255 321
256 // 8 free bits 322 // 8 free bits
257 323
258 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */ 324 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */
259 // /* races/classes can need less/more exp to gain levels */ 325 // /* races/classes can need less/more exp to gain levels */
260 static const float expmul = 1.0;//D 326 constexpr static const float expmul = 1.0;//D
261 float ACC (RW, move_slow_penalty); /* How much this slows down the object */ 327 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
262 328
263 /* Following are values used by any object */ 329 /* Following are values used by any object */
264 /* this objects turns into or what this object creates */ 330 /* this objects turns into or what this object creates */
265 treasurelist *ACC (RW, randomitems); /* Items to be generated */ 331 treasurelist *ACC (RW, randomitems); /* Items to be generated */
285 shstr ACC (RW, lore); /* Obscure information about this object, */ 351 shstr ACC (RW, lore); /* Obscure information about this object, */
286 /* To get put into books and the like. */ 352 /* To get put into books and the like. */
287 shstr ACC (RW, custom_name); /* Custom name assigned by player */ 353 shstr ACC (RW, custom_name); /* Custom name assigned by player */
288}; 354};
289 355
290const char *query_weight (const object *op); 356const_utf8_string query_weight (const object *op);
291const char *query_short_name (const object *op); 357const_utf8_string query_short_name (const object *op);
292const char *query_name (const object *op); 358const_utf8_string query_name (const object *op);
293const char *query_base_name (const object *op, int plural); 359const_utf8_string query_base_name (const object *op, int plural);
360sint64 query_cost (const object *tmp, object *who, int flag);
361const char *query_cost_string (const object *tmp, object *who, int flag);
294 362
363int change_ability_duration (object *spell, object *caster);
364int min_casting_level (object *caster, object *spell);
365int casting_level (object *caster, object *spell);
366sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
367int SP_level_dam_adjust (object *caster, object *spob);
368int SP_level_duration_adjust (object *caster, object *spob);
369int SP_level_range_adjust (object *caster, object *spob);
370
371struct freelist_item
372{
373 freelist_item *next;
374 uint32_t count;
375};
376
295struct object : zero_initialised, object_copy 377struct object : object_copy
296{ 378{
297 // These variables are not changed by ->copy_to 379 // These variables are not changed by ->copy_to
298 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ 380 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
299 381
300 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 382 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
301 int ACC (RO, count); 383 uint32_t ACC (RO, count);
302 object_vector_index ACC (RO, index); // index into objects 384 object_vector_index ACC (RO, index); // index into objects
303 object_vector_index ACC (RO, active); // index into actives 385 object_vector_index ACC (RO, active); // index into actives
304 386
305 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */ 387 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
306 388
316 object *ACC (RW, env); /* Pointer to the object which is the environment. 398 object *ACC (RW, env); /* Pointer to the object which is the environment.
317 * This is typically the container that the object is in. 399 * This is typically the container that the object is in.
318 */ 400 */
319 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 401 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
320 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 402 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
321 key_value *key_values; /* Fields not explictly known by the loader. */
322 403
323 // privates / perl 404 MTH void set_flag (int flagnum)
324 shstr_tmp kv_get (shstr_tmp key) const; 405 {
325 void kv_del (shstr_tmp key); 406 flag [flagnum] = true;
326 void kv_set (shstr_tmp key, shstr_tmp value); 407 }
408
409 MTH void clr_flag (int flagnum)
410 {
411 flag [flagnum] = false;
412 }
413
414 // extra key value pairs
415 key_values kv;
327 416
328//-GPL 417//-GPL
329
330 // custom extra fields management
331 struct key_value_access_proxy
332 {
333 object &ob;
334 shstr_tmp key;
335
336 key_value_access_proxy (object &ob, shstr_tmp key)
337 : ob (ob), key (key)
338 {
339 }
340
341 const key_value_access_proxy &operator =(shstr_tmp value) const
342 {
343 ob.kv_set (key, value);
344 return *this;
345 }
346
347 operator const shstr_tmp () const { return ob.kv_get (key); }
348 operator const char *() const { return ob.kv_get (key); }
349
350 private:
351 void operator =(int);
352 };
353
354 // operator [] is too annoying to use
355 const key_value_access_proxy kv (shstr_tmp key)
356 {
357 return key_value_access_proxy (*this, key);
358 }
359 418
360 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 419 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
361 MTH void post_load_check (); // do some adjustments after parsing 420 MTH void post_load_check (); // do some adjustments after parsing
362 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go. 421 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
363 bool write (object_freezer &f); 422 bool write (object_freezer &f);
364 423
365 MTH int slottype () const;
366 MTH static object *create (); 424 MTH static object *create ();
367 const mapxy &operator =(const mapxy &pos); 425 const mapxy &operator =(const mapxy &pos);
368 MTH void copy_to (object *dst); 426 MTH void copy_to (object *dst);
369 MTH object *clone (); // create + copy_to a single object 427 MTH object *clone (); // create + copy_to a single object
370 MTH object *deep_clone (); // copy whole more chain and inventory 428 MTH object *deep_clone (); // copy whole more chain and inventory
377 destroy (); 435 destroy ();
378 } 436 }
379 437
380 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 438 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
381 MTH void destroy_inv (bool drop_to_ground = false); 439 MTH void destroy_inv (bool drop_to_ground = false);
440 MTH void destroy_inv_fast (); // like destroy_inv (false), but only works when *this is destroyed, too
382 MTH object *insert (object *item); // insert into inventory 441 MTH object *insert (object *item); // insert into inventory
383 MTH void play_sound (faceidx sound) const; 442 MTH void play_sound (faceidx sound) const;
384 MTH void say_msg (const char *msg) const; 443 MTH void say_msg (const_utf8_string msg) const;
385 444
386 void do_remove (); 445 void do_remove ();
387 MTH void remove () 446 MTH void remove ()
388 { 447 {
389 if (!flag [FLAG_REMOVED]) 448 if (!flag [FLAG_REMOVED])
397 remove (); 456 remove ();
398 *this = pos; 457 *this = pos;
399 insert_at (this, this); 458 insert_at (this, this);
400 } 459 }
401 460
402 // high-level move functions, return true if successful 461 // high-level move method.
462 // object op is trying to move in direction dir.
463 // originator is typically the same as op, but
464 // can be different if originator is causing op to
465 // move (originator is pushing op)
466 // returns 0 if the object is not able to move to the
467 // desired space, 1 otherwise (in which case we also
468 // move the object accordingly. This function is
469 // very similiar to move_object.
403 int move (int dir, object *originator); 470 int move (int dir, object *originator);
404 471
405 int move (int dir) 472 int move (int dir)
406 { 473 {
407 return move (dir, this); 474 return move (dir, this);
408 } 475 }
476
477 // changes move_type to a new value - handles move_on/move_off effects
478 MTH void change_move_type (MoveType mt);
409 479
410 static bool can_merge_slow (object *op1, object *op2); 480 static bool can_merge_slow (object *op1, object *op2);
411 481
412 // this is often used in time-critical code, so optimise 482 // this is often used in time-critical code, so optimise
413 MTH static bool can_merge (object *op1, object *op2) 483 MTH static bool can_merge (object *op1, object *op2)
415 return op1->value == op2->value 485 return op1->value == op2->value
416 && op1->name == op2->name 486 && op1->name == op2->name
417 && can_merge_slow (op1, op2); 487 && can_merge_slow (op1, op2);
418 } 488 }
419 489
420 MTH void set_owner (object *owner); 490 MTH void set_owner (object_ornull *owner);
421 MTH void set_speed (float speed); 491 MTH void set_speed (float speed);
422 MTH void set_glow_radius (sint8 rad); 492 MTH void set_glow_radius (sint8 rad);
423 MTH bool change_weapon (object *ob);
424 MTH bool change_skill (object *ob);
425 493
426 MTH void open_container (object *new_container); 494 MTH void open_container (object *new_container);
427 MTH void close_container () 495 MTH void close_container ()
428 { 496 {
429 open_container (0); 497 open_container (0);
440 // strangely enough, using ?: here causes code to inflate 508 // strangely enough, using ?: here causes code to inflate
441 return type == CONTAINER 509 return type == CONTAINER
442 && ((env && env->container_ () == this) 510 && ((env && env->container_ () == this)
443 || (!env && flag [FLAG_APPLIED])); 511 || (!env && flag [FLAG_APPLIED]));
444 } 512 }
513
514 MTH object *find_spell (const_utf8_string prefix) const;
445 515
446 MTH object *force_find (shstr_tmp name); 516 MTH object *force_find (shstr_tmp name);
447 MTH void force_set_timer (int duration); 517 MTH void force_set_timer (int duration);
448 MTH object *force_add (shstr_tmp name, int duration = 0); 518 MTH object *force_add (shstr_tmp name, int duration = 0);
449 519
468 MTH void drain_stat (); 538 MTH void drain_stat ();
469 MTH void drain_specific_stat (int deplete_stats); 539 MTH void drain_specific_stat (int deplete_stats);
470 MTH void change_luck (int value); 540 MTH void change_luck (int value);
471 541
472 // info must hold 256 * 3 bytes currently 542 // info must hold 256 * 3 bytes currently
473 const char *debug_desc (char *info) const; 543 const_utf8_string debug_desc (char *info) const;
474 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 544 MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
475 const char *flag_desc (char *desc, int len) const; 545 const_utf8_string flag_desc (char *desc, int len) const;
476 546
477 MTH bool decrease (sint32 nr = 1); // returns true if anything is left 547 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
478 MTH object *split (sint32 nr = 1); // return 0 on failure 548 MTH object *split (sint32 nr = 1); // return 0 on failure
479 549
480 MTH int number_of () const 550 MTH int number_of () const
481 { 551 {
482 return nrof ? nrof : 1; 552 return nrof ? nrof : 1;
483 } 553 }
484 554
485 MTH sint32 total_weight () const 555 MTH weight_t total_weight () const
486 { 556 {
487 return (weight + carrying) * number_of (); 557 return sint64 (weight + carrying) * number_of ();
488 } 558 }
489 559
490 MTH void update_weight (); 560 MTH void update_weight ();
491 561
492 // return the dominant material of this item, always return something 562 // return the dominant material of this item, always return something
494 { 564 {
495 return material; 565 return material;
496 } 566 }
497 567
498 // return the volume of this object in cm³ 568 // return the volume of this object in cm³
499 MTH uint64 volume () const 569 MTH volume_t volume () const
500 { 570 {
501 return (uint64)total_weight () 571 return (volume_t)total_weight ()
502 * 1024 // 1000 actually 572 * 1024 // 1000 actually
503 * (type == CONTAINER ? 128 : 1) 573 * (type == CONTAINER ? 128 : 1)
504 / dominant_material ()->density; // ugh, division 574 / dominant_material ()->density; // ugh, division
505 } 575 }
506 576
518 MTH bool is_arrow () const { return type == ARROW 588 MTH bool is_arrow () const { return type == ARROW
519 || (type == SPELL_EFFECT 589 || (type == SPELL_EFFECT
520 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 590 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
521 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } 591 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
522 592
593 MTH bool is_dragon () const;
594
595 MTH bool is_immunity () const { return invisible && type == SIGN; }
596
523 MTH bool has_active_speed () const { return fabs (speed) >= MIN_ACTIVE_SPEED; } 597 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
524 598
525 // temporary: wether the object can be saved in a map file 599 // temporary: wether the object can be saved in a map file
526 // contr => is a player 600 // contr => is a player
527 // head => only save head of a multitile object 601 // head => only save head of a multitile object
528 // owner => can not reference owner yet 602 // owner => can not reference owner yet
535 609
536 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; } 610 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
537 611
538 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); } 612 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
539 613
614 /* need_identify returns true if the item should be identified. This
615 * function really should not exist - by default, any item not identified
616 * should need it.
617 */
618 MTH bool need_identify () const;
619
540 // returns the outermost owner, never returns 0 620 // returns the outermost owner, never returns 0
541 MTH object *outer_owner () 621 MTH object *outer_owner ()
542 { 622 {
543 object *op; 623 object *op;
544 624
598 MTH bool is_player () const 678 MTH bool is_player () const
599 { 679 {
600 return !!contr; 680 return !!contr;
601 } 681 }
602 682
683 /* elmex: this method checks whether the object is in a shop */
684 MTH bool is_in_shop () const;
685
603 MTH bool affects_los () const 686 MTH bool affects_los () const
604 { 687 {
605 return glow_radius || flag [FLAG_BLOCKSVIEW]; 688 return glow_radius || flag [FLAG_BLOCKSVIEW];
606 } 689 }
607 690
608 MTH bool has_carried_lights () const 691 MTH bool has_carried_lights () const
609 { 692 {
610 return glow_radius; 693 return glow_radius;
611 } 694 }
612 695
613 // returns the player that cna see this object, if any 696 // returns the player that can see this object, if any
614 MTH object *visible_to () const; 697 MTH object *visible_to () const;
615 698
616 MTH std::string long_desc (object *who = 0); // query_name . " " . describe 699 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
617 MTH std::string describe_monster (object *who = 0); 700 MTH std::string describe_monster (object *who = 0);
618 MTH std::string describe_item (object *who = 0); 701 MTH std::string describe_item (object *who = 0);
619 MTH std::string describe (object *who = 0); // long description, without name 702 MTH std::string describe (object *who = 0); // long description, without name
620 703
621 MTH const char *query_weight () { return ::query_weight (this); } 704 MTH const_utf8_string query_weight () { return ::query_weight (this); }
622 MTH const char *query_name () { return ::query_name (this); } 705 MTH const_utf8_string query_name () { return ::query_name (this); }
623 MTH const char *query_short_name () { return ::query_short_name (this); } 706 MTH const_utf8_string query_short_name () { return ::query_short_name (this); }
624 MTH const char *query_base_name (bool plural) { return ::query_base_name (this, plural); } 707 MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); }
625 708
626 // If this object has no extra parts but should have them, 709 // If this object has no extra parts but should have them,
627 // add them, effectively expanding heads into multipart 710 // add them, effectively expanding heads into multipart
628 // objects. This method only works on objects not inserted 711 // objects. This method only works on objects not inserted
629 // anywhere. 712 // anywhere.
630 MTH void expand_tail (); 713 MTH void expand_tail ();
631 714
632 MTH void create_treasure (treasurelist *tl, int flags = 0); 715 MTH void create_treasure (treasurelist *tl, int flags = 0);
716
717 // makes sure the player has the named skill,
718 // and also makes it innate if can_use is true.
719 // returns the new skill or 0 if no such skill exists.
720 MTH object *give_skill (shstr_cmp name, bool can_use = false);
721 MTH void become_follower (object *new_god);
633 722
634 // insert object at same map position as 'where' 723 // insert object at same map position as 'where'
635 // handles both inventory and map "positions" 724 // handles both inventory and map "positions"
636 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 725 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
637 // check whether we can put this into the map, respect max_nrof, max_volume, max_items 726 // check whether we can put this into the map, respect max_nrof, max_volume, max_items
641 MTH void activate (); 730 MTH void activate ();
642 MTH void deactivate (); 731 MTH void deactivate ();
643 MTH void activate_recursive (); 732 MTH void activate_recursive ();
644 MTH void deactivate_recursive (); 733 MTH void deactivate_recursive ();
645 734
735 // prefetch and activate the surrounding area
736 MTH void prefetch_surrounding_maps ();
737
646 // set the given flag on all objects in the inventory recursively 738 // set the given flag on all objects in the inventory recursively
647 MTH void set_flag_inv (int flag, int value = 1); 739 MTH void set_flag_inv (int flag, int value = 1);
648 740
649 void enter_exit (object *exit);//Perl 741 void enter_exit (object *exit); // perl
650 MTH void enter_map (maptile *newmap, int x, int y); 742 MTH bool enter_map (maptile *newmap, int x, int y);
651 void player_goto (const char *path, int x, int y); // only for players 743 void player_goto (const_utf8_string path, int x, int y); // only for players
744 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
745
746 MTH object *mark () const;
747 MTH void splay_marked ();
652 748
653 // returns the mapspace this object is in 749 // returns the mapspace this object is in
654 mapspace &ms () const; 750 mapspace &ms () const;
655 751
656 // fully recursive iterator 752 // fully recursive iterator
707 return weight + carrying; 803 return weight + carrying;
708 } 804 }
709 805
710 MTH struct region *region () const; 806 MTH struct region *region () const;
711 807
712 void statusmsg (const char *msg, int color = NDI_BLACK); 808 MTH void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
713 void failmsg (const char *msg, int color = NDI_RED); 809 MTH void failmsg (const_utf8_string msg, int color = NDI_RED);
810 void failmsgf (const_utf8_string format, ...); // always NDI_RED...
714 811
715 const char *query_inventory (object *who = 0, const char *indent = ""); 812 MTH const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
716 813
717 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 814 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
718 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible 815 static object *deref (const_octet_string ref); // returns the object from the generated reference, if possible
719 816
720 // make some noise with given item into direction dir, 817 // make some noise with given item into direction dir,
721 // currently only used for players to make them temporarily visible 818 // currently only used for players to make them temporarily visible
722 // when they are invisible. 819 // when they are invisible.
723 MTH void make_noise (); 820 MTH void make_noise ();
733 * range from 0 through 7. 830 * range from 0 through 7.
734 */ 831 */
735 MTH int anim_frames () const { return anim ().num_animations; } 832 MTH int anim_frames () const { return anim ().num_animations; }
736 MTH int anim_facings () const { return anim ().facings; } 833 MTH int anim_facings () const { return anim ().facings; }
737 834
738 MTH char *as_string (); 835 // sets a new animation frame, if the object has animation frames,
836 // and updates the face
837 MTH void update_anim_frame (int frame);
838
839 MTH utf8_string as_string ();
840
841 // low-level management, statistics, ...
842 static uint32_t ACC (RW, object_count);
843 static uint32_t ACC (RW, free_count);
844 static uint32_t ACC (RW, create_count);
845 static uint32_t ACC (RW, destroy_count);
846 static freelist_item *freelist;
847 MTH static void freelist_free (int count);
739 848
740protected: 849protected:
741 void link (); 850 void link ();
742 void unlink (); 851 void unlink ();
852
853 void do_delete ();
743 854
744 object (); 855 object ();
745 ~object (); 856 ~object ();
746 857
747private: 858private:
768 return ob; 879 return ob;
769} 880}
770 881
771//+GPL 882//+GPL
772 883
773object *find_skill_by_name_fuzzy (object *who, const char *name); 884object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
774object *find_skill_by_name (object *who, shstr_cmp sh); 885object *find_skill_by_name (object *who, shstr_cmp sh);
775object *find_skill_by_number (object *who, int skillno); 886object *find_skill_by_number (object *who, int skillno);
776 887
777/* 888/*
778 * The archetype structure is a set of rules on how to generate and manipulate 889 * The archetype structure is a set of rules on how to generate and manipulate
784 */ 895 */
785 896
786//-GPL 897//-GPL
787 898
788INTERFACE_CLASS (archetype) 899INTERFACE_CLASS (archetype)
789struct archetype : object 900struct archetype : object, zero_initialised
790{ 901{
791 static arch_ptr empty; // the empty_archetype 902 static arch_ptr empty; // the empty_archetype
792 MTH static void gc (); 903 MTH static void gc ();
793 904
794 archetype (const char *name); 905 archetype (const_utf8_string name);
795 ~archetype (); 906 ~archetype ();
796 void gather_callbacks (AV *&callbacks, event_type event) const; 907 void gather_callbacks (AV *&callbacks, event_type event) const;
797 908
798 MTH static archetype *find (const_utf8_string name); 909 MTH static archetype *find (const_utf8_string name);
799 910
800 MTH void link (); 911 MTH void link ();
801 MTH void unlink (); 912 MTH void unlink ();
802 913
803 MTH static object *get (const char *name); // (find() || singularity)->instance() 914 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
804 MTH object *instance (); 915 MTH object *instance ();
805 916
806 MTH void post_load_check (); // do some adjustments after parsing 917 MTH void post_load_check (); // do some adjustments after parsing
807 918
808 object_vector_index ACC (RW, archid); // index in archvector 919 object_vector_index ACC (RW, archid); // index in archvector
809 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 920 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
810 921
811 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 922 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
812 sint8 ACC (RW, max_x), ACC (RW, max_y);
813 923
814 // support for archetype loading 924 // support for archetype loading
815 static archetype *read (object_thawer &f); 925 static archetype *read (object_thawer &f);
816 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 926 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
817 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */ 927 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
928
929protected:
930 void do_delete ();
818}; 931};
819 932
820// compatbiility, remove once replaced by ->instance 933// returns whether the object is a dragon player, which are often specialcased
821inline object * 934inline bool
822arch_to_object (archetype *at) 935object::is_dragon () const
823{ 936{
824 return at->instance (); 937 return arch->race == shstr_dragon && is_player ();
825} 938}
826 939
827inline void 940inline void
828object_freezer::put (keyword k, archetype *v) 941object_freezer::put (const keyword_string k, archetype *v)
829{ 942{
830 put (k, v ? &v->archname : (const char *)0); 943 if (expect_true (v))
944 put (k, v->archname);
945 else
946 put (k);
831} 947}
832 948
833typedef object_vector<object, &object::index > objectvec; 949typedef object_vector<object, &object::index > objectvec;
834typedef object_vector<object, &object::active> activevec; 950typedef object_vector<object, &object::active> activevec;
835typedef object_vector<archetype, &archetype::archid> archvec; 951typedef object_vector<archetype, &archetype::archid> archvec;
841// "safely" iterate over inv in a way such that the current item is removable 957// "safely" iterate over inv in a way such that the current item is removable
842// quite horrible, that's why its hidden in some macro 958// quite horrible, that's why its hidden in some macro
843#define for_inv_removable(op,var) \ 959#define for_inv_removable(op,var) \
844 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; ) 960 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
845 961
846#define for_all_objects(var) \ 962#define for_all_objects(var) \
847 for (unsigned _i = 0; _i < objects.size (); ++_i) \ 963 for (unsigned _i = 0; _i < objects.size (); ++_i) \
848 statementvar (object *, var, objects [_i]) 964 statementvar (object *, var, objects [_i])
849 965
850#define for_all_actives(var) \ 966#define for_all_actives(var) \
851 for (unsigned _i = 0; _i < actives.size (); ++_i) \ 967 for (unsigned _i = 0; _i < actives.size (); ++_i) \
852 statementvar (object *, var, actives [_i]) 968 statementvar (object *, var, actives [_i])
853 969
854#define for_all_archetypes(var) \ 970#define for_all_archetypes(var) \
855 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ 971 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
856 statementvar (archetype *, var, archetypes [_i]) 972 statementvar (archetype *, var, archetypes [_i])
857 973
858//+GPL 974//+GPL
859 975
860/* Used by update_object to know if the object being passed is 976/* Used by update_object to know if the object being passed is
861 * being added or removed. 977 * being added or removed.
862 */ 978 */
863#define UP_OBJ_INSERT 1 979#define UP_OBJ_INSERT 1 // object was inserted
864#define UP_OBJ_REMOVE 2 980#define UP_OBJ_REMOVE 2 // object was removed
865#define UP_OBJ_CHANGE 3 981#define UP_OBJ_CHANGE 3 // object has changed in some unspecified way
866#define UP_OBJ_FACE 4 /* Only thing that changed was the face */ 982#define UP_OBJ_FACE 4 // only thing that changed was the face
867 983
868/* These are flags passed to insert_ob_in_map and 984/* These are flags passed to insert_ob_in_map and
869 * insert_ob_in_ob. Note that all flags may not be meaningful 985 * insert_ob_in_ob. Note that all flags may not be meaningful
870 * for both functions. 986 * for both functions.
871 * Most are fairly explanatory: 987 * Most are fairly explanatory:
872 * INS_NO_MERGE: don't try to merge inserted object with ones alrady 988 * INS_NO_MERGE: don't try to merge inserted object with ones alrady
873 * on space. 989 * on space.
874 * INS_ABOVE_FLOOR_ONLY: Put object immediatly above the floor. 990 * INS_ABOVE_FLOOR_ONLY: Put object immediatly above the floor.
875 * INS_NO_WALK_ON: Don't call check_walk_on against the 991 * INS_NO_WALK_ON: Don't call check_walk_on against the
876 * originator - saves cpu time if you know the inserted object 992 * originator - saves cpu time if you know the inserted object
877 * is not meaningful in terms of having an effect. 993 * is not meaningful in terms of having an effect.
878 * INS_ON_TOP: Always put object on top. Generally only needed when loading 994 * INS_ON_TOP: Always put object on top. Generally only needed when loading
879 * files from disk and ordering needs to be preserved. 995 * files from disk and ordering needs to be preserved.
880 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 996 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
881 * Use for treasure chests so the new object is the highest thing 997 * Use for treasure chests so the new object is the highest thing
882 * beneath the player, but not actually above it. Note - the 998 * beneath the player, but not actually above it. Note - the
883 * map and x,y coordinates for the object to be inserted must 999 * map and x,y coordinates for the object to be inserted must
884 * match the originator. 1000 * match the originator.
892#define INS_NO_MERGE 0x0001 1008#define INS_NO_MERGE 0x0001
893#define INS_ABOVE_FLOOR_ONLY 0x0002 1009#define INS_ABOVE_FLOOR_ONLY 0x0002
894#define INS_NO_WALK_ON 0x0004 1010#define INS_NO_WALK_ON 0x0004
895#define INS_ON_TOP 0x0008 1011#define INS_ON_TOP 0x0008
896#define INS_BELOW_ORIGINATOR 0x0010 1012#define INS_BELOW_ORIGINATOR 0x0010
1013#define INS_NO_AUTO_EXIT 0x0020 // temporary, fix exits instead
897 1014
898//-GPL 1015//-GPL
899 1016
900#endif 1017#endif
901 1018

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines