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.116 by root, Mon May 7 03:05:58 2007 UTC vs.
Revision 1.190 by root, Tue Dec 23 01:13:15 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines