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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines