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.75 by root, Sat Dec 30 21:17:48 2006 UTC vs.
Revision 1.186 by elmex, Mon Oct 6 18:26:35 2008 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for X-windows 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 (C) 2001 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
5 Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
6 7 *
7 This program is free software; you can redistribute it and/or modify 8 * Deliantra is free software: you can redistribute it and/or modify
8 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
9 the Free Software Foundation; either version 2 of the License, or 10 * the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version. 11 * (at your option) any later version.
11 12 *
12 This program is distributed in the hope that it will be useful, 13 * This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details. 16 * GNU General Public License for more details.
16 17 *
17 You should have received a copy of the GNU General Public License 18 * You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 *
20 21 * The authors can be reached via e-mail to <support@deliantra.net>
21 The authors can be reached via e-mail at crossfire@schmorp.de
22*/ 22 */
23 23
24#ifndef OBJECT_H 24#ifndef OBJECT_H
25#define OBJECT_H 25#define OBJECT_H
26 26
27#include <bitset> 27#include <bitset>
28 28
29#include "cfperl.h" 29#include "cfperl.h"
30#include "shstr.h" 30#include "shstr.h"
31 31
32typedef uint32 tag_t; 32typedef int tag_t;
33#define NUM_BODY_LOCATIONS 12 33
34#define BODY_ARMS 1 34enum {
35 body_skill,
36 body_combat,
37 body_range,
38 body_shield,
39 body_arm,
40 body_torso,
41 body_head,
42 body_neck,
43 body_finger,
44 body_shoulder,
45 body_foot,
46 body_hand,
47 body_wrist,
48 body_waist,
49 NUM_BODY_LOCATIONS
50};
51
52enum slottype_t
53{
54 slot_none,
55 slot_combat,
56 slot_ranged,
57};
35 58
36/* See common/item.c */ 59/* See common/item.c */
37 60
38typedef struct Body_Locations 61typedef struct Body_Locations
39{ 62{
40 const char *save_name; /* Name used to load/save it to disk */ 63 keyword save_name; /* Name used to load/save it to disk */
41 const char *use_name; /* Name used when describing an item we can use */ 64 const char *use_name; /* Name used when describing an item we can use */
42 const char *nonuse_name; /* Name to describe objects we can't use */ 65 const char *nonuse_name; /* Name to describe objects we can't use */
43} Body_Locations; 66} Body_Locations;
44 67
45extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 68extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
69
70#define NUM_COINS 4 /* number of coin types */
71extern const char *const coins[NUM_COINS + 1];
46 72
47/* 73/*
48 * 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
49 * "dangling" from it; this could also end up containing 'parse errors'. 75 * "dangling" from it; this could also end up containing 'parse errors'.
50 * 76 *
51 * key and value are shared-strings. 77 * key and value are shared-strings.
52 * 78 *
53 * 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
54 * accessing the list directly. 80 * accessing the list directly.
55 * 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.
56 */ 82 */
57struct key_value 83struct key_value : slice_allocated
58{ 84{
59 key_value *next; 85 key_value *next;
60 shstr key, value; 86 shstr key, value;
61}; 87};
62 88
63struct UUID 89struct UUID
64{ 90{
65 uint64 seq; 91 uint64 seq;
92
93 static UUID cur; // last uuid generated
94 static void init ();
95 static UUID gen ();
66 96
67 UUID () { } 97 UUID () { }
68 UUID (uint64 seq) : seq(seq) { } 98 UUID (uint64 seq) : seq(seq) { }
69 operator uint64() { return seq; } 99 operator uint64() { return seq; }
70 void operator =(uint64 seq) { this->seq = seq; } 100 void operator =(uint64 seq) { this->seq = seq; }
101
102 typedef char BUF [32];
103
104 bool parse (const char *s)
105 {
106 return sscanf (s, "<1.%" SCNx64 ">", &seq) == 1;
107 }
108
109 const char *c_str (char *buf, int len) const
110 {
111 snprintf (buf, len, "<1.%" PRIx64 ">", seq);
112
113 return buf;
114 }
115
116 const char *c_str () const
117 {
118 static BUF buf;
119
120 return c_str (buf, sizeof (buf));
121 }
71}; 122};
72
73extern void init_uuid ();
74extern UUID gen_uuid ();
75extern const uint64 UUID_SKIP;
76 123
77/* Definition for WILL_APPLY values. Replaces having harcoded values 124/* Definition for WILL_APPLY values. Replaces having harcoded values
78 * sprinkled in the code. Note that some of these also replace fields 125 * sprinkled in the code. Note that some of these also replace fields
79 * that were in the can_apply area. What is the point of having both 126 * that were in the can_apply area. What is the point of having both
80 * can_apply and will_apply? 127 * can_apply and will_apply?
83#define WILL_APPLY_TREASURE 0x02 130#define WILL_APPLY_TREASURE 0x02
84#define WILL_APPLY_EARTHWALL 0x04 131#define WILL_APPLY_EARTHWALL 0x04
85#define WILL_APPLY_DOOR 0x08 132#define WILL_APPLY_DOOR 0x08
86#define WILL_APPLY_FOOD 0x10 133#define WILL_APPLY_FOOD 0x10
87 134
88/* However, if you're keeping a pointer of some sort, you probably 135struct body_slot
89 * don't just want it copied, so you'll need to add to common/object.C, 136{
90 * e.g. ->copy_to () 137 signed char info:4; /* body info as loaded from the file */
91 */ 138 signed char used:4; /* Calculated value based on items equipped */
139};
92 140
93INTERFACE_CLASS (object) 141INTERFACE_CLASS (object)
94// these are being copied 142// these are being copied
95struct object_copy : attachable 143struct object_copy : attachable
96{ 144{
97 typedef bitset<NUM_FLAGS> flags_t; 145 typedef bitset<NUM_FLAGS> flags_t;
98 146
99 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */ 147 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
148
149 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
150 uint8 ACC (RW, subtype); /* subtype of object */
100 sint8 ACC (RW, direction); /* Means the object is moving that way. */ 151 sint8 ACC (RW, direction); /* Means the object is moving that way. */
101 sint8 ACC (RW, facing); /* Object is oriented/facing that way. */ 152 sint8 ACC (RW, facing); /* Object is oriented/facing that way. */
153
102 shstr ACC (RW, name); /* The name of the object, obviously... */ 154 shstr ACC (RW, name); /* The name of the object, obviously... */
103 shstr ACC (RW, name_pl); /* The plural name of the object */ 155 shstr ACC (RW, name_pl); /* The plural name of the object */
104 shstr ACC (RW, title); /* Of foo, etc */ 156 shstr ACC (RW, title); /* Of foo, etc */
105 shstr ACC (RW, race); /* human, goblin, dragon, etc */ 157 shstr ACC (RW, race); /* human, goblin, dragon, etc */
106 shstr ACC (RW, slaying); /* Which race to do double damage to */ 158 shstr ACC (RW, slaying); /* Which race to do double damage to */
107 /* If this is an exit, this is the filename */ 159 /* If this is an exit, this is the filename */
160 shstr ACC (RW, tag); // a tag used to tracking this object
108 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ 161 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
109 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */ 162 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
110 shstr ACC (RW, lore); /* Obscure information about this object, */ 163 shstr ACC (RW, lore); /* Obscure information about this object, */
111 /* To get put into books and the like. */ 164 /* To get put into books and the like. */
112 shstr ACC (RW, materialname); /* specific material name */ 165 shstr ACC (RW, materialname); /* specific material name */
113 shstr ACC (RW, custom_name); /* Custom name assigned by player */ 166 shstr ACC (RW, custom_name); /* Custom name assigned by player */
167// materialtype_t *ACC (RW, material); /* What material this object consists of */
114 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */ 168 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
115 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */ 169 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
116 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */ 170 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
117 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */ 171 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
118 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */ 172 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
119 object_ptr ACC (RW, spell); /* Spell that was being cast */ 173 object_ptr ACC (RW, spell); /* Spell that was being cast */
120 object_ptr ACC (RW, current_weapon); /* Pointer to the weapon currently used */ 174 object_ptr ACC (RW, current_weapon); /* Pointer to the weapon currently used */
121 arch_ptr ACC (RW, arch); /* Pointer to archetype */ 175 arch_ptr ACC (RW, arch); /* Pointer to archetype */
122 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */ 176 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
123 177
124 New_Face *ACC (RW, face); /* Face with colors */
125 float ACC (RW, speed); /* The overall speed of this object */ 178 float ACC (RW, speed); /* The overall speed of this object */
126 float ACC (RW, speed_left); /* How much speed is left to spend this round */ 179 float ACC (RW, speed_left); /* How much speed is left to spend this round */
127 uint32 ACC (RW, nrof); /* How many of the objects */ 180 sint32 ACC (RW, nrof); /* How many of the objects */
128 181
129 /* This next big block are basically used for monsters and equipment */ 182 /* This next big block is basically used for monsters and equipment */
130 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
131 uint8 ACC (RW, subtype); /* subtype of object */
132 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */ 183 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
184
133 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
134 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
135 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
136 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */ 188 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
137 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */ 189 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
138 uint16 ACC (RW, material); /* What materials this object consist of */ 190 uint16 ACC (RW, materials); /* What materials this object consists of */
139 sint8 ACC (RW, magic); /* Any magical bonuses to this item */ 191 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
140 uint8 ACC (RW, state); /* How the object was last drawn (animation) */ 192 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
141 sint32 ACC (RW, value); /* How much money it is worth (or contains) */ 193 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
142 /* Note that the last_.. values are sometimes used for non obvious 194 /* Note that the last_.. values are sometimes used for non obvious
143 * meanings by some objects, eg, sp penalty, permanent exp. 195 * meanings by some objects, eg, sp penalty, permanent exp.
152 sint8 ACC (RW, item_power); /* power rating of the object */ 204 sint8 ACC (RW, item_power); /* power rating of the object */
153 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */ 205 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
154 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */ 206 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
155 sint32 ACC (RW, weight); /* Attributes of the object */ 207 sint32 ACC (RW, weight); /* Attributes of the object */
156 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
157 sint32 ACC (RW, carrying); /* How much weight this object contains */ 209 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
158 sint64 ACC (RW, perm_exp); /* Permanent exp */ 210 sint64 ACC (RW, perm_exp); /* Permanent exp */
159 uint32 ACC (RW, weapontype); /* type of weapon */ 211 uint32 ACC (RW, weapontype); /* type of weapon */
160 uint32 ACC (RW, tooltype); /* type of tool or build facility */ 212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
161 sint8 ACC (RW, body_info[NUM_BODY_LOCATIONS]); /* body info as loaded from the file */ 213 body_slot slot [NUM_BODY_LOCATIONS];
162 sint8 ACC (RW, body_used[NUM_BODY_LOCATIONS]); /* Calculated value based on items equipped */ 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 */
163 living ACC (RO, stats); /* Str, Con, Dex, etc */ 217 living ACC (RO, stats); /* Str, Con, Dex, etc */
164 /* See the pod/objects.pod for more info about body locations */ 218 /* See the pod/objects.pod for more info about body locations */
165 219
166 /* Following mostly refers to fields only used for monsters */ 220 /* Following mostly refers to fields only used for monsters */
167 uint32 ACC (RW, hide); /* The object is hidden, not invisible */ 221 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
177 * Note that other fields are used - these files are basically 231 * Note that other fields are used - these files are basically
178 * only used in spells. 232 * only used in spells.
179 */ 233 */
180 sint16 ACC (RW, duration); /* How long the spell lasts */ 234 sint16 ACC (RW, duration); /* How long the spell lasts */
181 sint16 ACC (RW, casting_time);/* time left before spell goes off */ 235 sint16 ACC (RW, casting_time);/* time left before spell goes off */
236
182 uint16 ACC (RW, start_holding); 237 uint16 ACC (RW, start_holding);
183 uint8 ACC (RW, duration_modifier); /* how level modifies duration */ 238 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
184 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */ 239 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
240
185 sint8 ACC (RW, range); /* Range of the spell */ 241 sint8 ACC (RW, range); /* Range of the spell */
186 uint8 ACC (RW, range_modifier); /* How going up in level effects range */ 242 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
187
188 MoveType ACC (RW, move_type); /* Type of movement this object uses */ 243 MoveType ACC (RW, move_type); /* Type of movement this object uses */
189 MoveType ACC (RW, move_block);/* What movement types this blocks */ 244 MoveType ACC (RW, move_block);/* What movement types this blocks */
245
190 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */ 246 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
191 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */ 247 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
192 MoveType ACC (RW, move_off); /* Move types affected moving off this space */ 248 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
193 MoveType ACC (RW, move_slow); /* Movement types this slows down */ 249 MoveType ACC (RW, move_slow); /* Movement types this slows down */
250
194 float ACC (RW, move_slow_penalty); /* How much this slows down the object */ 251 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
195 252
196 char *ACC (RW, spellarg); 253 char *ACC (RW, spellarg);
197 254
198 /* Following are values used by any object */ 255 /* Following are values used by any object */
199 /* this objects turns into or what this object creates */ 256 /* this objects turns into or what this object creates */
200 treasurelist *ACC (RW, randomitems); /* Items to be generated */ 257 treasurelist *ACC (RW, randomitems); /* Items to be generated */
201 key_value *key_values; /* Fields not explictly known by the loader. */
202 flags_t flag; /* various flags */ 258 flags_t flag; /* various flags */
203#if FOR_PERL 259#if FOR_PERL
204 bool ACC (RW, flag[NUM_FLAGS]); 260 bool ACC (RW, flag[NUM_FLAGS]);
205#endif 261#endif
206 uint16 ACC (RW, animation_id);/* An index into the animation array */ 262 uint16 ACC (RW, animation_id);/* An index into the animation array */
207 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */ 263 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
208 uint8 ACC (RW, last_anim); /* last sequence used to draw face */ 264 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
209 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */
210 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */ 265 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
211 uint8 ACC (RW, will_apply); /* See crossfire.doc */ 266 uint8 ACC (RW, will_apply); /* See crossfire.doc */
267 uint16 ACC (RW, cached_sp); /* cached spell points used for a spell, used by esrv_update_spells */
268 uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
269 uint16 ACC (RW, cached_eat); /* cached food, used by esrv_update_spells */
212}; 270};
213 271
214struct object : zero_initialised, object_copy 272struct object : zero_initialised, object_copy
215{ 273{
216 typedef unordered_vector<object *> vector;
217
218 // These variables are not changed by ->copy_to 274 // These variables are not changed by ->copy_to
219 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */ 275 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
220 276
221 tag_t ACC (RW, count); /* Generation count for this object */
222 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 277 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
278 int ACC (RO, count);
279 object_vector_index ACC (RO, index); // index into objects
280 object_vector_index ACC (RO, active); // index into actives
223 281
224 player_ptr ACC (RW, contr); /* Pointer to the player which control this object */ 282 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
225 object *ACC (RW, next); /* Pointer to the next object in the free/used list */ 283
226 object *ACC (RW, prev); /* Pointer to the previous object in the free/used list */
227 object *ACC (RW, active_next);/* Next & previous object in the 'active' */
228 object *ACC (RW, active_prev);/* List. This is used in process_events */
229 /* so that the entire object list does not */
230 /* need to be gone through. */
231 object *ACC (RW, below); /* Pointer to the object stacked below this one */ 284 object *ACC (RW, below); /* Pointer to the object stacked below this one */
232 object *ACC (RW, above); /* Pointer to the object stacked above this one */ 285 object *ACC (RW, above); /* Pointer to the object stacked above this one */
233 /* Note: stacked in the *same* environment */ 286 /* Note: stacked in the *same* environment */
234 object *inv; /* Pointer to the first object in the inventory */ 287 object *inv; /* Pointer to the first object in the inventory */
288
289 //TODO: container must move into client
235 object *ACC (RW, container); /* Current container being used. I think this 290 object_ptr ACC (RW, container); /* Current container being used. I think this
236 * is only used by the player right now. 291 * is only used by the player right now.
237 */ 292 */
238 object *ACC (RW, env); /* Pointer to the object which is the environment. 293 object *ACC (RW, env); /* Pointer to the object which is the environment.
239 * This is typically the container that the object is in. 294 * This is typically the container that the object is in.
240 */ 295 */
241 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 296 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
242 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 297 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
243 client_container *seen_by; // seen by which player/container currently? 298 client_container *seen_by; // seen by which player/container currently?
299 key_value *key_values; /* Fields not explictly known by the loader. */
244 300
245 static vector active; // active objects, not yet used 301 // privates / perl
246 static vector objects; // not used yet, use first->next->... 302 const shstr &kv_get (const shstr &key) const;
247 static object *first; // will be replaced by "objects" 303 void kv_del (const shstr &key);
304 void kv_set (const shstr &key, const shstr &value);
248 305
306 // custom extra fields management
307 struct key_value_access_proxy
308 {
309 object &ob;
310 shstr key;
311
312 key_value_access_proxy (object &ob, const shstr &key)
313 : ob (ob), key (key)
314 {
315 }
316
317 const key_value_access_proxy &operator =(const shstr &value) const
318 {
319 ob.kv_set (key, value);
320 return *this;
321 }
322
323 operator const shstr &() const { return ob.kv_get (key); }
324 operator const char *() const { return ob.kv_get (key); }
325
326 private:
327 void operator =(int);
328 };
329
330 // operator [] is too annoying to use
331 const key_value_access_proxy kv (const shstr &key)
332 {
333 return key_value_access_proxy (*this, key);
334 }
335
336 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
337 MTH void post_load_check (); // do some adjustments after parsing
338 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
339 bool write (object_freezer &f);
340
341 MTH int slottype () const;
249 MTH static object *create (); 342 MTH static object *create ();
343 const mapxy &operator =(const mapxy &pos);
250 MTH void copy_to (object *dst); 344 MTH void copy_to (object *dst);
251 MTH object *clone (); // create + copy_to 345 MTH object *clone (); // create + copy_to a single object
346 MTH object *deep_clone (); // copy whole more chain and inventory
252 void do_destroy (); 347 void do_destroy ();
253 void gather_callbacks (AV *&callbacks, event_type event) const; 348 void gather_callbacks (AV *&callbacks, event_type event) const;
254 MTH void destroy (bool destroy_inventory = false); 349 MTH void destroy ();
350 MTH void drop_and_destroy ()
351 {
352 destroy_inv (true);
353 destroy ();
354 }
255 355
256 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 356 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
257 MTH void destroy_inv (bool drop_to_ground = false); 357 MTH void destroy_inv (bool drop_to_ground = false);
258 MTH void remove ();
259 MTH object *insert (object *item); // insert into inventory 358 MTH object *insert (object *item); // insert into inventory
359 MTH void play_sound (faceidx sound);
360
361 void do_remove ();
362 MTH void remove ()
363 {
364 if (!flag [FLAG_REMOVED])
365 do_remove ();
366 }
367
368 MTH bool blocked (maptile *m, int x, int y) const;
369
370 void move_to (const mapxy &pos)
371 {
372 remove ();
373 *this = pos;
374 insert_at (this, this);
375 }
260 376
261 static bool can_merge_slow (object *op1, object *op2); 377 static bool can_merge_slow (object *op1, object *op2);
262 378
263 // this is often used in time-critical code, so optimise 379 // this is often used in time-critical code, so optimise
264 MTH static bool can_merge (object *op1, object *op2) 380 MTH static bool can_merge (object *op1, object *op2)
268 && can_merge_slow (op1, op2); 384 && can_merge_slow (op1, op2);
269 } 385 }
270 386
271 MTH void set_owner (object *owner); 387 MTH void set_owner (object *owner);
272 MTH void set_speed (float speed); 388 MTH void set_speed (float speed);
389 MTH bool change_weapon (object *ob);
390 MTH bool change_skill (object *ob);
273 391
392 MTH void open_container (object *new_container);
393 MTH void close_container ()
394 {
395 open_container (0);
396 }
397
398 MTH object *force_find (const shstr name);
399 MTH void force_add (const shstr name, int duration = 0);
400
401 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
402 bool should_invoke (event_type event)
403 {
404 return ev_want_event [event] || ev_want_type [type] || cb;
405 }
406
274 MTH void instantiate () 407 MTH void instantiate ();
275 {
276 if (!uuid.seq) // HACK
277 uuid = gen_uuid ();
278
279 attachable::instantiate ();
280 }
281 408
282 // recalculate all stats 409 // recalculate all stats
283 MTH void update_stats (); 410 MTH void update_stats ();
284 MTH void roll_stats (); 411 MTH void roll_stats ();
285 MTH void swap_stats (int a, int b); 412 MTH void swap_stats (int a, int b);
289 MTH void drain_specific_stat (int deplete_stats); 416 MTH void drain_specific_stat (int deplete_stats);
290 MTH void change_luck (int value); 417 MTH void change_luck (int value);
291 418
292 // info must hold 256 * 3 bytes currently 419 // info must hold 256 * 3 bytes currently
293 const char *debug_desc (char *info) const; 420 const char *debug_desc (char *info) const;
294 MTH const char *debug_desc () const; 421 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
295 const char *flag_desc (char *desc, int len) const; 422 const char *flag_desc (char *desc, int len) const;
296 423
424 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
425 MTH object *split (sint32 nr = 1); // return 0 on failure
426
427 MTH int number_of () const
428 {
429 return nrof ? nrof : 1;
430 }
431
432 MTH sint32 total_weight () const
433 {
434 return (weight + carrying) * number_of ();
435 }
436
437 MTH void update_weight ();
438
439 // return the dominant material of this item, always return something
440 const materialtype_t *dominant_material () const;
441
442 // return the volume of this object in cm³
443 MTH uint64 volume () const
444 {
445 return total_weight ()
446 * 1000
447 * (type == CONTAINER ? 1000 : 1)
448 / dominant_material ()->density;
449 }
450
451 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
297 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; } 452 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
298 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET 453 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
299 || type == CLOAK || type == BOOTS || type == GLOVES 454 || type == CLOAK || type == BOOTS || type == GLOVES
300 || type == BRACERS || type == GIRDLE; } 455 || type == BRACERS || type == GIRDLE; }
301 MTH bool is_alive () const { return (type == PLAYER 456 MTH bool is_alive () const { return (type == PLAYER
303 || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR)) 458 || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR))
304 && !flag [FLAG_IS_A_TEMPLATE]; } 459 && !flag [FLAG_IS_A_TEMPLATE]; }
305 MTH bool is_arrow () const { return type == ARROW 460 MTH bool is_arrow () const { return type == ARROW
306 || (type == SPELL_EFFECT 461 || (type == SPELL_EFFECT
307 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 462 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
463 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
308 464
309 MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; } 465 MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; }
310 466
311 // temporary: wether the objetc can be saved in a map file 467 // temporary: wether the object can be saved in a map file
312 // contr => is a player 468 // contr => is a player
313 // head => only save head of a multitile object 469 // head => only save head of a multitile object
314 // owner => can not reference owner yet 470 // owner => can not reference owner yet
315 MTH bool can_map_save () const { return !contr && !head && !owner; } 471 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
316 472
317 /* This return true if object has still randomitems which 473 /* This return true if object has still randomitems which
318 * could be expanded. 474 * could be expanded.
319 */ 475 */
320 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 476 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
321 477
478 MTH bool has_dialogue () const { return *&msg == '@'; }
479
480 // returns the outermost owner, never returns 0
481 MTH object *outer_owner ()
482 {
483 object *op;
484
485 for (op = this; op->owner; op = op->owner)
486 ;
487
488 return op;
489 }
490
491 // returns the outermost environment, never returns 0
492 MTH object *outer_env ()
493 {
494 object *op;
495
496 for (op = this; op->env; op = op->env)
497 ;
498
499 return op;
500 }
501
322 // returns the player that has this object in his inventory, or 0 502 // returns the player that has this object in his inventory, or 0
503 // we assume the player is always the outer env
323 MTH object *in_player () const 504 MTH object *in_player ()
324 { 505 {
325 for (object *op = env; op; op = op->env) 506 object *op = outer_env ();
326 if (op->type == PLAYER)
327 return op;
328 507
329 return 0; 508 return op->type == PLAYER ? op : 0;
330 } 509 }
331 510
332 // "temporary" helper function 511 // "temporary" helper function
333 MTH object *head_ () 512 MTH object *head_ ()
334 { 513 {
335 return head ? head : this; 514 return head ? head : this;
336 } 515 }
516
517 MTH bool is_head ()
518 {
519 return head_ () == this;
520 }
521
522 MTH bool is_on_map () const
523 {
524 return !env && !flag [FLAG_REMOVED];
525 }
526
527 MTH bool is_in_map_or_inv () const
528 {
529 return !flag [FLAG_REMOVED];
530 }
531
532 // returns the player that cna see this object, if any
533 MTH object *visible_to () const;
534
535 MTH std::string long_desc (object *who = 0);
536 MTH std::string describe_monster (object *who = 0);
537 MTH std::string describe_item (object *who = 0);
538 MTH std::string describe (object *who = 0);
539
540 // If this object has no extra parts but should have them,
541 // add them, effectively expanding heads into multipart
542 // objects. This method only works on objects not inserted
543 // anywhere.
544 MTH void expand_tail ();
545
546 MTH void create_treasure (treasurelist *tl, int flags = 0);
337 547
338 // insert object at same map position as 'where' 548 // insert object at same map position as 'where'
339 // handles both inventory and map "positions" 549 // handles both inventory and map "positions"
340 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 550 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
551 MTH void drop_unpaid_items ();
341 552
553 MTH void activate ();
554 MTH void deactivate ();
342 MTH void activate (bool recursive = true); 555 MTH void activate_recursive ();
343 MTH void deactivate (bool recursive = true); 556 MTH void deactivate_recursive ();
344 557
558 // set the given flag on all objects in the inventory recursively
559 MTH void set_flag_inv (int flag, int value = 1);
560
345 void enter_exit (object *exit);//PERL 561 void enter_exit (object *exit);//Perl
346 MTH void enter_map (maptile *newmap, int x, int y); 562 MTH void enter_map (maptile *newmap, int x, int y);
563 void player_goto (const char *path, int x, int y); // only for players
347 564
348 // returns the mapspace this object is in 565 // returns the mapspace this object is in
349 mapspace &ms () const; 566 mapspace &ms () const;
350 567
351 // fully recursive iterator 568 // fully recursive iterator
361 operator object *() const { return item; } 578 operator object *() const { return item; }
362 579
363 object *operator ->() const { return item; } 580 object *operator ->() const { return item; }
364 object &operator * () const { return *item; } 581 object &operator * () const { return *item; }
365 }; 582 };
583
584 MTH unsigned int random_seed () const
585 {
586 return (unsigned int)uuid.seq;
587 }
366 588
367 // depth-first recursive iterator 589 // depth-first recursive iterator
368 struct depth_iterator : iterator_base 590 struct depth_iterator : iterator_base
369 { 591 {
370 depth_iterator (object *container); 592 depth_iterator (object *container);
381 object *end () 603 object *end ()
382 { 604 {
383 return this; 605 return this;
384 } 606 }
385 607
608 /* This returns TRUE if the object is something that
609 * a client might want to know about.
610 */
611 MTH bool client_visible () const
612 {
613 return !invisible && type != PLAYER;
614 }
615
616 // the client does nrof * this weight
617 MTH sint32 client_weight () const
618 {
619 return weight + carrying;
620 }
621
622 MTH struct region *region () const;
623
624 void statusmsg (const char *msg, int color = NDI_BLACK);
625 void failmsg (const char *msg, int color = NDI_RED);
626
627 const char *query_inventory (object *who = 0, const char *indent = "");
628
629 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
630 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
631
386protected: 632protected:
387 friend struct archetype;
388
389 void link (); 633 void link ();
390 void unlink (); 634 void unlink ();
391 635
392 object (); 636 object ();
393 ~object (); 637 ~object ();
638
639private:
640 object &operator =(const object &);
641 object (const object &);
394}; 642};
643
644// move this object to the top of its env's inventory to speed up
645// searches for it.
646static object *
647splay (object *ob)
648{
649 if (ob->env && ob->env->inv != ob)
650 {
651 if (ob->above) ob->above->below = ob->below;
652 if (ob->below) ob->below->above = ob->above;
653
654 ob->above = 0;
655 ob->below = ob->env->inv;
656 ob->below->above = ob;
657 ob->env->inv = ob;
658 }
659
660 return ob;
661}
395 662
396typedef struct oblnk 663typedef struct oblnk
397{ /* Used to link together several objects */ 664{ /* Used to link together several objects */
398 object_ptr ob; 665 object_ptr ob;
399 struct oblnk *next; 666 struct oblnk *next;
400} objectlink; 667} objectlink;
401 668
402typedef struct oblinkpt 669typedef struct oblinkpt
403{ /* Used to link together several object links */ 670{ /* Used to link together several object links */
404 struct oblnk *link; 671 struct oblnk *link;
405 long value; /* Used as connected value in buttons/gates */ 672 sint32 value; /* Used as connected value in buttons/gates */
406 struct oblinkpt *next; 673 struct oblinkpt *next;
407} oblinkpt; 674} oblinkpt;
675
676object *find_skill_by_name (object *who, const char *name);
677object *find_skill_by_name (object *who, const shstr &sh);
678object *find_skill_by_number (object *who, int skillno);
408 679
409/* 680/*
410 * The archetype structure is a set of rules on how to generate and manipulate 681 * The archetype structure is a set of rules on how to generate and manipulate
411 * objects which point to archetypes. 682 * objects which point to archetypes.
412 * This probably belongs in arch.h, but there really doesn't appear to 683 * This probably belongs in arch.h, but there really doesn't appear to
414 * object and pointers. This structure should get removed, and just replaced 685 * object and pointers. This structure should get removed, and just replaced
415 * by the object structure 686 * by the object structure
416 */ 687 */
417 688
418INTERFACE_CLASS (archetype) 689INTERFACE_CLASS (archetype)
419struct archetype : zero_initialised, attachable 690struct archetype : object
420{ 691{
421 archetype (); 692 static arch_ptr empty; // the empty_archetype
693 MTH static void gc ();
694
695 archetype (const char *name);
422 ~archetype (); 696 ~archetype ();
423 void gather_callbacks (AV *&callbacks, event_type event) const; 697 void gather_callbacks (AV *&callbacks, event_type event) const;
424 698
425 static archetype *find (const char *arch); 699 MTH static archetype *find (const_utf8_string name);
426 700
427 void hash_add (); // add to hashtable 701 MTH void link ();
428 void hash_del (); // remove from hashtable 702 MTH void unlink ();
429 703
704 MTH static object *get (const char *name); // (find() || singularity)->instance()
705 MTH object *instance ();
706
707 object_vector_index ACC (RW, archid); // index in archvector
430 shstr ACC (RW, name); /* More definite name, like "generate_kobold" */ 708 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
431 struct archetype *ACC (RW, next); /* Next archetype in a linked list */ 709
432 struct archetype *ACC (RW, head); /* The main part of a linked object */ 710 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
433 struct archetype *ACC (RW, more); /* Next part of a linked object */ 711 sint8 ACC (RW, max_x), ACC (RW, max_y);
434 object ACC (RO, clone); /* An object from which to do ->copy_to () */ 712
435 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */ 713 // support for archetype loading
436 sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is 714 static archetype *read (object_thawer &f);
437 * in comparison to the head. 715 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
438 */ 716 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
439}; 717};
440 718
719// compatbiility, remove once replaced by ->instance
720inline object *
721arch_to_object (archetype *at)
722{
723 return at->instance ();
724}
725
726inline void
727object_freezer::put (keyword k, archetype *v)
728{
729 put (k, v ? &v->archname : (const char *)0);
730}
731
732typedef object_vector<object, &object::index > objectvec;
733typedef object_vector<object, &object::active> activevec;
734typedef object_vector<archetype, &archetype::archid> archvec;
735
441extern object *objects; 736extern objectvec objects;
442extern object *active_objects; 737extern activevec actives;
738extern archvec archetypes;
443 739
444extern int nrofallocobjects; 740// "safely" iterate over inv in a way such that the current item is removable
741// quite horrible, thats why its hidden in some macro
742#define for_inv_removable(op,var) \
743 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
445 744
446/* This returns TRUE if the object is something that 745#define for_all_objects(var) \
447 * should be displayed in the look window 746 for (unsigned _i = 0; _i < objects.size (); ++_i) \
448 */ 747 statementvar (object *, var, objects [_i])
449#define LOOK_OBJ(ob) (!ob->invisible && ob->type != PLAYER && ob->type != EVENT_CONNECTOR) 748
749#define for_all_actives(var) \
750 for (unsigned _i = 0; _i < actives.size (); ++_i) \
751 statementvar (object *, var, actives [_i])
752
753#define for_all_archetypes(var) \
754 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
755 statementvar (archetype *, var, archetypes [_i])
450 756
451/* Used by update_object to know if the object being passed is 757/* Used by update_object to know if the object being passed is
452 * being added or removed. 758 * being added or removed.
453 */ 759 */
454#define UP_OBJ_INSERT 1 760#define UP_OBJ_INSERT 1
471 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 777 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
472 * Use for treasure chests so the new object is the highest thing 778 * Use for treasure chests so the new object is the highest thing
473 * beneath the player, but not actually above it. Note - the 779 * beneath the player, but not actually above it. Note - the
474 * map and x,y coordinates for the object to be inserted must 780 * map and x,y coordinates for the object to be inserted must
475 * match the originator. 781 * match the originator.
476 * INS_MAP_LOAD: disable lots of checkings done at insertion to
477 * speed up map loading process, as we assume the ordering in
478 * loaded map is correct.
479 * 782 *
480 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 783 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
481 * are mutually exclusive. The behaviour for passing more than one 784 * are mutually exclusive. The behaviour for passing more than one
482 * should be considered undefined - while you may notice what happens 785 * should be considered undefined - while you may notice what happens
483 * right now if you pass more than one, that could very well change 786 * right now if you pass more than one, that could very well change
486#define INS_NO_MERGE 0x0001 789#define INS_NO_MERGE 0x0001
487#define INS_ABOVE_FLOOR_ONLY 0x0002 790#define INS_ABOVE_FLOOR_ONLY 0x0002
488#define INS_NO_WALK_ON 0x0004 791#define INS_NO_WALK_ON 0x0004
489#define INS_ON_TOP 0x0008 792#define INS_ON_TOP 0x0008
490#define INS_BELOW_ORIGINATOR 0x0010 793#define INS_BELOW_ORIGINATOR 0x0010
491#define INS_MAP_LOAD 0x0020
492 794
493#define ARCH_SINGULARITY "singularity"
494#define ARCH_SINGULARITY_LEN 11
495#define ARCH_DETECT_MAGIC "detect_magic"
496#define ARCH_DEPLETION "depletion" 795#define ARCH_DEPLETION "depletion"
497#define ARCH_SYMPTOM "symptom"
498 796
499#endif 797#endif
500 798

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines