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.192 by root, Sun Dec 28 06:59:27 2008 UTC vs.
Revision 1.232 by root, Sat Apr 3 02:29:40 2010 UTC

1/* 1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen 6 * Copyright (©) 1992 Frank Tore Johansen
7 * 7 *
8 * Deliantra is free software: you can redistribute it and/or modify 8 * Deliantra is free software: you can redistribute it and/or modify it under
9 * it under the terms of the GNU General Public License as published by 9 * the terms of the Affero GNU General Public License as published by the
10 * the Free Software Foundation, either version 3 of the License, or 10 * Free Software Foundation, either version 3 of the License, or (at your
11 * (at your option) any later version. 11 * 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 Affero GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. 19 * and the GNU General Public License along with this program. If not, see
20 * <http://www.gnu.org/licenses/>.
20 * 21 *
21 * The authors can be reached via e-mail to <support@deliantra.net> 22 * The authors can be reached via e-mail to <support@deliantra.net>
22 */ 23 */
23 24
24#ifndef OBJECT_H 25#ifndef OBJECT_H
27#include <bitset> 28#include <bitset>
28 29
29#include "cfperl.h" 30#include "cfperl.h"
30#include "shstr.h" 31#include "shstr.h"
31 32
33//+GPL
34
32typedef int tag_t; 35typedef int tag_t;
33 36
37// also see common/item.C
34enum { 38enum {
35 body_skill, 39 body_skill,
36 body_combat, 40 body_combat,
37 body_range, 41 body_range,
38 body_shield, 42 body_shield,
47 body_wrist, 51 body_wrist,
48 body_waist, 52 body_waist,
49 NUM_BODY_LOCATIONS 53 NUM_BODY_LOCATIONS
50}; 54};
51 55
52enum slottype_t
53{
54 slot_none,
55 slot_combat,
56 slot_ranged,
57};
58
59/* See common/item.c */ 56/* See common/item.c */
60 57
61typedef struct Body_Locations 58typedef struct Body_Locations
62{ 59{
63 keyword save_name; /* Name used to load/save it to disk */ 60 keyword save_name; /* Name used to load/save it to disk */
84{ 81{
85 key_value *next; 82 key_value *next;
86 shstr key, value; 83 shstr key, value;
87}; 84};
88 85
86//-GPL
87
89struct UUID 88struct UUID
90{ 89{
91 uint64 seq; 90 uint64 seq;
91
92 enum { MAX_LEN = 3 + 16 + 1 + 1 }; // <1. + hex + > + \0
92 93
93 static UUID cur; // last uuid generated 94 static UUID cur; // last uuid generated
94 static void init (); 95 static void init ();
95 static UUID gen (); 96 static UUID gen ();
96 97
97 UUID () { } 98 UUID () { }
98 UUID (uint64 seq) : seq(seq) { } 99 UUID (uint64 seq) : seq(seq) { }
99 operator uint64() { return seq; } 100 operator uint64() { return seq; }
100 void operator =(uint64 seq) { this->seq = seq; } 101 void operator =(uint64 seq) { this->seq = seq; }
101 102
102 typedef char BUF [32];
103
104 bool parse (const char *s) 103 bool parse (const char *s);
105 { 104 char *append (char *buf) const;
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 105 char *c_str () const;
117 {
118 static BUF buf;
119
120 return c_str (buf, sizeof (buf));
121 }
122}; 106};
107
108//+GPL
123 109
124/* Definition for WILL_APPLY values. Replaces having harcoded values 110/* Definition for WILL_APPLY values. Replaces having harcoded values
125 * sprinkled in the code. Note that some of these also replace fields 111 * sprinkled in the code. Note that some of these also replace fields
126 * that were in the can_apply area. What is the point of having both 112 * that were in the can_apply area. What is the point of having both
127 * can_apply and will_apply? 113 * can_apply and will_apply?
132#define WILL_APPLY_DOOR 0x08 118#define WILL_APPLY_DOOR 0x08
133#define WILL_APPLY_FOOD 0x10 119#define WILL_APPLY_FOOD 0x10
134 120
135struct body_slot 121struct body_slot
136{ 122{
123 signed char used:4; /* Calculated value based on items equipped */
137 signed char info:4; /* body info as loaded from the file */ 124 signed char info:4; /* body info as loaded from the file */
138 signed char used:4; /* Calculated value based on items equipped */
139}; 125};
126
127typedef struct oblnk
128{ /* Used to link together several objects */
129 object_ptr ob;
130 struct oblnk *next;
131} objectlink;
132
133typedef struct oblinkpt
134{ /* Used to link together several object links */
135 struct oblnk *link;
136 struct oblinkpt *next;
137 shstr id; /* Used as connected value in buttons/gates */
138} oblinkpt;
140 139
141INTERFACE_CLASS (object) 140INTERFACE_CLASS (object)
142// these are being copied 141// these are being copied
143struct object_copy : attachable 142struct object_copy : attachable
144{ 143{
160 flags_t flag; /* various flags */ 159 flags_t flag; /* various flags */
161#if FOR_PERL 160#if FOR_PERL
162 bool ACC (RW, flag[NUM_FLAGS]); 161 bool ACC (RW, flag[NUM_FLAGS]);
163#endif 162#endif
164 163
165 shstr ACC (RW, materialname); /* specific material name */ 164 materialtype_t *material; // What material this object consists of //TODO, make perl-accessible
166 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */ 165 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
167// materialtype_t *ACC (RW, material); /* What material this object consists of */
168 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */ 166 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
169 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */ 167 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
170 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */ 168 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
171 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */ 169 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
172 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */ 170 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
175 arch_ptr ACC (RW, arch); /* Pointer to archetype */ 173 arch_ptr ACC (RW, arch); /* Pointer to archetype */
176 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */ 174 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
177 175
178 float ACC (RW, speed); /* The overall speed of this object */ 176 float ACC (RW, speed); /* The overall speed of this object */
179 float ACC (RW, speed_left); /* How much speed is left to spend this round */ 177 float ACC (RW, speed_left); /* How much speed is left to spend this round */
178
180 sint32 ACC (RW, nrof); /* How many of the objects */ 179 sint32 ACC (RW, nrof); /* How many of the objects */
181
182 /* This next big block is basically used for monsters and equipment */ 180 /* This next big block is basically used for monsters and equipment */
183 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */ 181 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
184 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 182 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
185 183
186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 184 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
189 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */ 187 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
190 188
191 uint16 ACC (RW, materials); /* What materials this object consists of */ 189 uint16 ACC (RW, materials); /* What materials this object consists of */
192 sint8 ACC (RW, magic); /* Any magical bonuses to this item */ 190 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
193 uint8 ACC (RW, state); /* How the object was last drawn (animation) */ 191 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
194
195 sint32 ACC (RW, value); /* How much money it is worth (or contains) */ 192 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
193
196 /* Note that the last_.. values are sometimes used for non obvious 194 /* Note that the last_.. values are sometimes used for non obvious
197 * meanings by some objects, eg, sp penalty, permanent exp. 195 * meanings by some objects, eg, sp penalty, permanent exp.
198 */ 196 */
199 sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */ 197 sint16 ACC (RW, last_heal); /* Last healed. Depends on constitution */
200 sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */ 198 sint16 ACC (RW, last_sp); /* As last_heal, but for spell points */
201 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */ 199 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
202 sint16 ACC (RW, last_eat); /* How long since we last ate */ 200 sint16 ACC (RW, last_eat); /* How long since we last ate */
201
203 sint16 ACC (RW, invisible); /* How much longer the object will be invis */ 202 sint16 ACC (RW, invisible); /* How much longer the object will be invis */
204 sint16 ACC (RW, level); /* Level of creature or object */ 203 sint16 ACC (RW, level); /* Level of creature or object */
205 204
206 uint8 ACC (RW, pick_up); /* See crossfire.doc */ 205 uint8 ACC (RW, pick_up); /* See crossfire.doc */
207 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */ 206 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
208 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */ 207 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
209 uint8 ACC (RW, weapontype); /* type of weapon */ 208 uint8 ACC (RW, weapontype); /* type of weapon */
210 209
210 body_slot slot [NUM_BODY_LOCATIONS];
211
211 faceidx ACC (RW, face); /* the graphical face */ 212 faceidx ACC (RW, face); /* the graphical face */
212 213
213 faceidx ACC (RW, sound); /* the sound face */ 214 faceidx ACC (RW, sound); /* the sound face */
214 faceidx ACC (RW, sound_destroy); /* played on destroy */ 215 faceidx ACC (RW, sound_destroy); /* played on destroy */
215 216
216 body_slot slot [NUM_BODY_LOCATIONS];
217
218 sint32 ACC (RW, weight); /* Attributes of the object */ 217 sint32 ACC (RW, weight); /* Attributes of the object */
219 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 218 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
219
220 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */ 220 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
221
221 sint64 ACC (RW, perm_exp); /* Permanent exp */ 222 sint64 ACC (RW, perm_exp); /* Permanent exp */
222 living ACC (RO, stats); /* Str, Con, Dex, etc */ 223 living ACC (RO, stats); /* Str, Con, Dex, etc */
223 /* See the pod/objects.pod for more info about body locations */ 224 /* See the pod/objects.pod for more info about body locations */
224 225
225 /* Following mostly refers to fields only used for monsters */ 226 /* Following mostly refers to fields only used for monsters */
226
227 /* allows different movement patterns for attackers */
228 sint32 ACC (RW, move_status); /* What stage in attack mode */
229 uint16 ACC (RW, attack_movement); /* What kind of attack movement */
230 uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
231 float ACC (RW, expmul); /* needed experience = (calc_exp*expmul) - means some */
232 /* races/classes can need less/more exp to gain levels */
233 227
234 /* Spell related information, may be useful elsewhere 228 /* Spell related information, may be useful elsewhere
235 * Note that other fields are used - these files are basically 229 * Note that other fields are used - these files are basically
236 * only used in spells. 230 * only used in spells.
237 */ 231 */
238 sint16 ACC (RW, duration); /* How long the spell lasts */ 232 sint16 ACC (RW, duration); /* How long the spell lasts */
239 sint16 ACC (RW, casting_time);/* time left before spell goes off */ 233 uint8 ACC (RW, casting_time); /* time left before spell goes off */
240
241 uint8 ACC (RW, duration_modifier); /* how level modifies duration */ 234 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
235
242 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */ 236 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
243 sint8 ACC (RW, range); /* Range of the spell */ 237 sint8 ACC (RW, range); /* Range of the spell */
244 uint8 ACC (RW, range_modifier); /* How going up in level effects range */ 238 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
239 sint8 ACC (RW, item_power); /* power rating of the object */
245 240
241 uint8 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
246 MoveType ACC (RW, move_type); /* Type of movement this object uses */ 242 MoveType ACC (RW, move_type); /* Type of movement this object uses */
247 MoveType ACC (RW, move_block);/* What movement types this blocks */ 243 MoveType ACC (RW, move_block);/* What movement types this blocks */
248 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */ 244 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
245
249 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */ 246 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
250
251 MoveType ACC (RW, move_off); /* Move types affected moving off this space */ 247 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
252 MoveType ACC (RW, move_slow); /* Movement types this slows down */ 248 MoveType ACC (RW, move_slow); /* Movement types this slows down */
253 249
254 sint8 ACC (RW, item_power); /* power rating of the object */
255 // 8 free bits 250 // 8 free bits
256 251
252 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */
253 // /* races/classes can need less/more exp to gain levels */
254 static const float expmul = 1.0;//D
257 float ACC (RW, move_slow_penalty); /* How much this slows down the object */ 255 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
258 char *ACC (RW, spellarg);
259 256
260 /* Following are values used by any object */ 257 /* Following are values used by any object */
261 /* this objects turns into or what this object creates */ 258 /* this objects turns into or what this object creates */
262 treasurelist *ACC (RW, randomitems); /* Items to be generated */ 259 treasurelist *ACC (RW, randomitems); /* Items to be generated */
263 260
264 uint16 ACC (RW, animation_id);/* An index into the animation array */
265 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
266 uint8 ACC (RW, last_anim); /* last sequence used to draw face */ 261 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
267
268 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */ 262 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
269 uint8 ACC (RW, will_apply); /* See crossfire.doc */ 263 uint8 ACC (RW, will_apply); /* See crossfire.doc */
264 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
265 uint16 ACC (RW, animation_id);/* An index into the animation array */
266 uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
267
268 uint16 ACC (RW, cached_eat); /* cached food, used by esrv_update_spells */
270 uint16 ACC (RW, cached_sp); /* cached spell points used for a spell, used by esrv_update_spells */ 269 uint16 ACC (RW, cached_sp); /* cached spell points used for a spell, used by esrv_update_spells */
270 /* allows different movement patterns for attackers */
271 uint8 ACC (RW, move_status); /* What stage in attack mode */
272 uint8 ACC (RW, attack_movement);/* What kind of attack movement */
271 273
272 uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */ 274 //16+ free bits
273 uint16 ACC (RW, cached_eat); /* cached food, used by esrv_update_spells */
274 275
275 // rarely-accessed members should be at the end 276 // rarely-accessed members should be at the end
276 shstr ACC (RW, tag); // a tag used to tracking this object 277 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, msg); /* If this is a book/sign/magic mouth/etc */
278 shstr ACC (RW, lore); /* Obscure information about this object, */ 279 shstr ACC (RW, lore); /* Obscure information about this object, */
279 /* To get put into books and the like. */ 280 /* To get put into books and the like. */
280 shstr ACC (RW, custom_name); /* Custom name assigned by player */ 281 shstr ACC (RW, custom_name); /* Custom name assigned by player */
281}; 282};
282 283
284const_utf8_string query_weight (const object *op);
285const_utf8_string query_short_name (const object *op);
286const_utf8_string query_name (const object *op);
287const_utf8_string query_base_name (const object *op, int plural);
288
283struct object : zero_initialised, object_copy 289struct object : zero_initialised, object_copy
284{ 290{
285 // These variables are not changed by ->copy_to 291 // These variables are not changed by ->copy_to
286 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */ 292 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
287 293
296 object *ACC (RW, above); /* Pointer to the object stacked above this one */ 302 object *ACC (RW, above); /* Pointer to the object stacked above this one */
297 /* Note: stacked in the *same* environment */ 303 /* Note: stacked in the *same* environment */
298 object *inv; /* Pointer to the first object in the inventory */ 304 object *inv; /* Pointer to the first object in the inventory */
299 305
300 //TODO: container must move into client 306 //TODO: container must move into client
301 object_ptr ACC (RW, container); /* Current container being used. I think this 307 object_ptr ACC (RW, container);/* Currently opened container. I think this
302 * is only used by the player right now. 308 * is only used by the player right now.
303 */ 309 */
304 object *ACC (RW, env); /* Pointer to the object which is the environment. 310 object *ACC (RW, env); /* Pointer to the object which is the environment.
305 * This is typically the container that the object is in. 311 * This is typically the container that the object is in.
306 */ 312 */
307 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 313 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
308 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 314 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
309 client_container *seen_by; // seen by which player/container currently?
310 key_value *key_values; /* Fields not explictly known by the loader. */ 315 key_value *key_values; /* Fields not explictly known by the loader. */
311 316
312 // privates / perl 317 // privates / perl
313 const shstr &kv_get (const shstr &key) const; 318 shstr_tmp kv_get (shstr_tmp key) const;
314 void kv_del (const shstr &key); 319 void kv_del (shstr_tmp key);
315 void kv_set (const shstr &key, const shstr &value); 320 void kv_set (shstr_tmp key, shstr_tmp value);
321
322//-GPL
316 323
317 // custom extra fields management 324 // custom extra fields management
318 struct key_value_access_proxy 325 struct key_value_access_proxy
319 { 326 {
320 object &ob; 327 object &ob;
321 shstr key; 328 shstr_tmp key;
322 329
323 key_value_access_proxy (object &ob, const shstr &key) 330 key_value_access_proxy (object &ob, shstr_tmp key)
324 : ob (ob), key (key) 331 : ob (ob), key (key)
325 { 332 {
326 } 333 }
327 334
328 const key_value_access_proxy &operator =(const shstr &value) const 335 const key_value_access_proxy &operator =(shstr_tmp value) const
329 { 336 {
330 ob.kv_set (key, value); 337 ob.kv_set (key, value);
331 return *this; 338 return *this;
332 } 339 }
333 340
334 operator const shstr &() const { return ob.kv_get (key); } 341 operator const shstr_tmp () const { return ob.kv_get (key); }
335 operator const char *() const { return ob.kv_get (key); } 342 operator const char *() const { return ob.kv_get (key); }
336 343
337 private: 344 private:
338 void operator =(int); 345 void operator =(int);
339 }; 346 };
340 347
341 // operator [] is too annoying to use 348 // operator [] is too annoying to use
342 const key_value_access_proxy kv (const shstr &key) 349 const key_value_access_proxy kv (shstr_tmp key)
343 { 350 {
344 return key_value_access_proxy (*this, key); 351 return key_value_access_proxy (*this, key);
345 } 352 }
346 353
347 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all 354 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 355 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. 356 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
350 bool write (object_freezer &f); 357 bool write (object_freezer &f);
351 358
352 MTH int slottype () const;
353 MTH static object *create (); 359 MTH static object *create ();
354 const mapxy &operator =(const mapxy &pos); 360 const mapxy &operator =(const mapxy &pos);
355 MTH void copy_to (object *dst); 361 MTH void copy_to (object *dst);
356 MTH object *clone (); // create + copy_to a single object 362 MTH object *clone (); // create + copy_to a single object
357 MTH object *deep_clone (); // copy whole more chain and inventory 363 MTH object *deep_clone (); // copy whole more chain and inventory
365 } 371 }
366 372
367 // recursively destroy all objects in inventory, optionally dropping them to the ground instead 373 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
368 MTH void destroy_inv (bool drop_to_ground = false); 374 MTH void destroy_inv (bool drop_to_ground = false);
369 MTH object *insert (object *item); // insert into inventory 375 MTH object *insert (object *item); // insert into inventory
370 MTH void play_sound (faceidx sound); 376 MTH void play_sound (faceidx sound) const;
377 MTH void say_msg (const_utf8_string msg) const;
371 378
372 void do_remove (); 379 void do_remove ();
373 MTH void remove () 380 MTH void remove ()
374 { 381 {
375 if (!flag [FLAG_REMOVED]) 382 if (!flag [FLAG_REMOVED])
383 remove (); 390 remove ();
384 *this = pos; 391 *this = pos;
385 insert_at (this, this); 392 insert_at (this, this);
386 } 393 }
387 394
388 // high-level move functions, return true if successful 395 // high-level move method.
396 // object op is trying to move in direction dir.
397 // originator is typically the same as op, but
398 // can be different if originator is causing op to
399 // move (originator is pushing op)
400 // returns 0 if the object is not able to move to the
401 // desired space, 1 otherwise (in which case we also
402 // move the object accordingly. This function is
403 // very similiar to move_object.
389 int move (int dir, object *originator); 404 int move (int dir, object *originator);
390 405
391 int move (int dir) 406 int move (int dir)
392 { 407 {
393 return move (dir, this); 408 return move (dir, this);
394 } 409 }
410
411 // changes move_type to a new value - handles move_on/move_off effects
412 MTH void change_move_type (MoveType mt);
395 413
396 static bool can_merge_slow (object *op1, object *op2); 414 static bool can_merge_slow (object *op1, object *op2);
397 415
398 // this is often used in time-critical code, so optimise 416 // this is often used in time-critical code, so optimise
399 MTH static bool can_merge (object *op1, object *op2) 417 MTH static bool can_merge (object *op1, object *op2)
403 && can_merge_slow (op1, op2); 421 && can_merge_slow (op1, op2);
404 } 422 }
405 423
406 MTH void set_owner (object *owner); 424 MTH void set_owner (object *owner);
407 MTH void set_speed (float speed); 425 MTH void set_speed (float speed);
408 MTH bool change_weapon (object *ob); 426 MTH void set_glow_radius (sint8 rad);
409 MTH bool change_skill (object *ob); 427 MTH bool change_skill (object *ob); // deprecated?
410 428
411 MTH void open_container (object *new_container); 429 MTH void open_container (object *new_container);
412 MTH void close_container () 430 MTH void close_container ()
413 { 431 {
414 open_container (0); 432 open_container (0);
415 } 433 }
416 434
435 // potential future accessor for "container"
436 MTH object *container_ () const
437 {
438 return container;
439 }
440
441 MTH bool is_open_container () const
442 {
443 // strangely enough, using ?: here causes code to inflate
444 return type == CONTAINER
445 && ((env && env->container_ () == this)
446 || (!env && flag [FLAG_APPLIED]));
447 }
448
417 MTH object *force_find (const shstr name); 449 MTH object *force_find (shstr_tmp name);
450 MTH void force_set_timer (int duration);
418 MTH object *force_add (const shstr name, int duration = 0); 451 MTH object *force_add (shstr_tmp name, int duration = 0);
452
453 oblinkpt *find_link () const;
454 MTH void add_link (maptile *map, shstr_tmp id);
455 MTH void remove_link ();
419 456
420 // overwrite the attachable should_invoke function with a version that also checks ev_want_type 457 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
421 bool should_invoke (event_type event) 458 bool should_invoke (event_type event)
422 { 459 {
423 return ev_want_event [event] || ev_want_type [type] || cb; 460 return ev_want_event [event] || ev_want_type [type] || cb;
434 MTH void drain_stat (); 471 MTH void drain_stat ();
435 MTH void drain_specific_stat (int deplete_stats); 472 MTH void drain_specific_stat (int deplete_stats);
436 MTH void change_luck (int value); 473 MTH void change_luck (int value);
437 474
438 // info must hold 256 * 3 bytes currently 475 // info must hold 256 * 3 bytes currently
439 const char *debug_desc (char *info) const; 476 const_utf8_string debug_desc (char *info) const;
440 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers 477 MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
441 const char *flag_desc (char *desc, int len) const; 478 const_utf8_string flag_desc (char *desc, int len) const;
442 479
443 MTH bool decrease (sint32 nr = 1); // returns true if anything is left 480 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
444 MTH object *split (sint32 nr = 1); // return 0 on failure 481 MTH object *split (sint32 nr = 1); // return 0 on failure
445 482
446 MTH int number_of () const 483 MTH int number_of () const
454 } 491 }
455 492
456 MTH void update_weight (); 493 MTH void update_weight ();
457 494
458 // return the dominant material of this item, always return something 495 // return the dominant material of this item, always return something
459 const materialtype_t *dominant_material () const; 496 const materialtype_t *dominant_material () const
497 {
498 return material;
499 }
460 500
461 // return the volume of this object in cm³ 501 // return the volume of this object in cm³
462 MTH uint64 volume () const 502 MTH uint64 volume () const
463 { 503 {
464 return (uint64)total_weight () 504 return (uint64)total_weight ()
465 * 1000 505 * 1024 // 1000 actually
466 * (type == CONTAINER ? 1000 : 1) 506 * (type == CONTAINER ? 128 : 1)
467 / dominant_material ()->density; 507 / dominant_material ()->density; // ugh, division
468 } 508 }
509
510 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; }
469 511
470 MTH bool is_wiz () const { return flag [FLAG_WIZ]; } 512 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
471 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; } 513 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
472 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET 514 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
473 || type == CLOAK || type == BOOTS || type == GLOVES 515 || type == CLOAK || type == BOOTS || type == GLOVES
479 MTH bool is_arrow () const { return type == ARROW 521 MTH bool is_arrow () const { return type == ARROW
480 || (type == SPELL_EFFECT 522 || (type == SPELL_EFFECT
481 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); } 523 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
482 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; } 524 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
483 525
526 MTH bool is_dragon () const;
527
484 MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; } 528 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
485 529
486 // temporary: wether the object can be saved in a map file 530 // temporary: wether the object can be saved in a map file
487 // contr => is a player 531 // contr => is a player
488 // head => only save head of a multitile object 532 // head => only save head of a multitile object
489 // owner => can not reference owner yet 533 // owner => can not reference owner yet
492 /* This return true if object has still randomitems which 536 /* This return true if object has still randomitems which
493 * could be expanded. 537 * could be expanded.
494 */ 538 */
495 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; } 539 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
496 540
497 MTH bool has_dialogue () const { return *&msg == '@'; } 541 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
542
543 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
498 544
499 // returns the outermost owner, never returns 0 545 // returns the outermost owner, never returns 0
500 MTH object *outer_owner () 546 MTH object *outer_owner ()
501 { 547 {
502 object *op; 548 object *op;
506 552
507 return op; 553 return op;
508 } 554 }
509 555
510 // returns the outermost environment, never returns 0 556 // returns the outermost environment, never returns 0
511 MTH object *outer_env () 557 MTH object *outer_env_or_self () const
512 { 558 {
513 object *op; 559 const object *op;
514 560
515 for (op = this; op->env; op = op->env) 561 for (op = this; op->env; op = op->env)
516 ; 562 ;
517 563
518 return op; 564 return const_cast<object *>(op);
565 }
566
567 // returns the outermost environment, may return 0
568 MTH object *outer_env () const
569 {
570 return env ? outer_env_or_self () : 0;
519 } 571 }
520 572
521 // returns the player that has this object in his inventory, or 0 573 // returns the player that has this object in his inventory, or 0
522 // we assume the player is always the outer env 574 // we assume the player is always the outer env
523 MTH object *in_player () 575 MTH object *in_player () const
524 { 576 {
525 object *op = outer_env (); 577 object *op = outer_env_or_self ();
526 578
527 return op->type == PLAYER ? op : 0; 579 return op->type == PLAYER ? op : 0;
528 } 580 }
529 581
530 // "temporary" helper function 582 // "temporary" helper function
531 MTH object *head_ () 583 MTH object *head_ () const
532 { 584 {
533 return head ? head : this; 585 return head ? head : const_cast<object *>(this);
534 } 586 }
535 587
536 MTH bool is_head () 588 MTH bool is_head () const
537 { 589 {
538 return head_ () == this; 590 return head_ () == this;
539 } 591 }
540 592
541 MTH bool is_on_map () const 593 MTH bool is_on_map () const
554 } 606 }
555 607
556 MTH bool affects_los () const 608 MTH bool affects_los () const
557 { 609 {
558 return glow_radius || flag [FLAG_BLOCKSVIEW]; 610 return glow_radius || flag [FLAG_BLOCKSVIEW];
611 }
612
613 MTH bool has_carried_lights () const
614 {
615 return glow_radius;
559 } 616 }
560 617
561 // returns the player that cna see this object, if any 618 // returns the player that cna see this object, if any
562 MTH object *visible_to () const; 619 MTH object *visible_to () const;
563 620
564 MTH std::string long_desc (object *who = 0); 621 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
565 MTH std::string describe_monster (object *who = 0); 622 MTH std::string describe_monster (object *who = 0);
566 MTH std::string describe_item (object *who = 0); 623 MTH std::string describe_item (object *who = 0);
567 MTH std::string describe (object *who = 0); 624 MTH std::string describe (object *who = 0); // long description, without name
625
626 MTH const_utf8_string query_weight () { return ::query_weight (this); }
627 MTH const_utf8_string query_name () { return ::query_name (this); }
628 MTH const_utf8_string query_short_name () { return ::query_short_name (this); }
629 MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); }
568 630
569 // If this object has no extra parts but should have them, 631 // If this object has no extra parts but should have them,
570 // add them, effectively expanding heads into multipart 632 // add them, effectively expanding heads into multipart
571 // objects. This method only works on objects not inserted 633 // objects. This method only works on objects not inserted
572 // anywhere. 634 // anywhere.
575 MTH void create_treasure (treasurelist *tl, int flags = 0); 637 MTH void create_treasure (treasurelist *tl, int flags = 0);
576 638
577 // insert object at same map position as 'where' 639 // insert object at same map position as 'where'
578 // handles both inventory and map "positions" 640 // handles both inventory and map "positions"
579 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 641 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
642 // check whether we can put this into the map, respect max_nrof, max_volume, max_items
643 MTH bool can_drop_at (maptile *m, int x, int y, object *originator = 0);
580 MTH void drop_unpaid_items (); 644 MTH void drop_unpaid_items ();
581 645
582 MTH void activate (); 646 MTH void activate ();
583 MTH void deactivate (); 647 MTH void deactivate ();
584 MTH void activate_recursive (); 648 MTH void activate_recursive ();
587 // set the given flag on all objects in the inventory recursively 651 // set the given flag on all objects in the inventory recursively
588 MTH void set_flag_inv (int flag, int value = 1); 652 MTH void set_flag_inv (int flag, int value = 1);
589 653
590 void enter_exit (object *exit);//Perl 654 void enter_exit (object *exit);//Perl
591 MTH void enter_map (maptile *newmap, int x, int y); 655 MTH void enter_map (maptile *newmap, int x, int y);
592 void player_goto (const char *path, int x, int y); // only for players 656 void player_goto (const_utf8_string path, int x, int y); // only for players
657 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
593 658
594 // returns the mapspace this object is in 659 // returns the mapspace this object is in
595 mapspace &ms () const; 660 mapspace &ms () const;
596 661
597 // fully recursive iterator 662 // fully recursive iterator
648 return weight + carrying; 713 return weight + carrying;
649 } 714 }
650 715
651 MTH struct region *region () const; 716 MTH struct region *region () const;
652 717
653 void statusmsg (const char *msg, int color = NDI_BLACK); 718 void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
654 void failmsg (const char *msg, int color = NDI_RED); 719 void failmsg (const_utf8_string msg, int color = NDI_RED);
655 720
656 const char *query_inventory (object *who = 0, const char *indent = ""); 721 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
657 722
658 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference 723 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
659 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible 724 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
660 725
661 // make some noise with given item into direction dir, 726 // make some noise with given item into direction dir,
662 // currently only used for players to make them temporarily visible 727 // currently only used for players to make them temporarily visible
663 // when they are invisible. 728 // when they are invisible.
664 MTH void make_noise (); 729 MTH void make_noise ();
665 730
731 /* animation */
732 MTH bool has_anim () const { return animation_id; }
733 const animation &anim () const { return animations [animation_id]; }
734 MTH faceidx get_anim_frame (int frame) const { return anim ().faces [frame]; }
735 MTH void set_anim_frame (int frame) { face = get_anim_frame (frame); }
736 /* anim_frames () returns the number of animations allocated. The last
737 * usuable animation will be anim_frames () - 1 (for example, if an object
738 * has 8 animations, anim_frames () will return 8, but the values will
739 * range from 0 through 7.
740 */
741 MTH int anim_frames () const { return anim ().num_animations; }
742 MTH int anim_facings () const { return anim ().facings; }
743
744 MTH utf8_string as_string ();
745
666protected: 746protected:
667 void link (); 747 void link ();
668 void unlink (); 748 void unlink ();
669 749
670 object (); 750 object ();
675 object (const object &); 755 object (const object &);
676}; 756};
677 757
678// move this object to the top of its env's inventory to speed up 758// move this object to the top of its env's inventory to speed up
679// searches for it. 759// searches for it.
680static object * 760static inline object *
681splay (object *ob) 761splay (object *ob)
682{ 762{
683 if (ob->env && ob->env->inv != ob) 763 if (ob->above && ob->env)
684 { 764 {
685 if (ob->above) ob->above->below = ob->below; 765 if (ob->above) ob->above->below = ob->below;
686 if (ob->below) ob->below->above = ob->above; 766 if (ob->below) ob->below->above = ob->above;
687 767
688 ob->above = 0; 768 ob->above = 0;
692 } 772 }
693 773
694 return ob; 774 return ob;
695} 775}
696 776
697typedef struct oblnk 777//+GPL
698{ /* Used to link together several objects */
699 object_ptr ob;
700 struct oblnk *next;
701} objectlink;
702 778
703typedef struct oblinkpt
704{ /* Used to link together several object links */
705 struct oblnk *link;
706 sint32 value; /* Used as connected value in buttons/gates */
707 struct oblinkpt *next;
708} oblinkpt;
709
710object *find_skill_by_name (object *who, const char *name); 779object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
711object *find_skill_by_name (object *who, const shstr &sh); 780object *find_skill_by_name (object *who, shstr_cmp sh);
712object *find_skill_by_number (object *who, int skillno); 781object *find_skill_by_number (object *who, int skillno);
713 782
714/* 783/*
715 * The archetype structure is a set of rules on how to generate and manipulate 784 * The archetype structure is a set of rules on how to generate and manipulate
716 * objects which point to archetypes. 785 * objects which point to archetypes.
718 * be much left in the archetype - all it really is is a holder for the 787 * be much left in the archetype - all it really is is a holder for the
719 * object and pointers. This structure should get removed, and just replaced 788 * object and pointers. This structure should get removed, and just replaced
720 * by the object structure 789 * by the object structure
721 */ 790 */
722 791
792//-GPL
793
723INTERFACE_CLASS (archetype) 794INTERFACE_CLASS (archetype)
724struct archetype : object 795struct archetype : object
725{ 796{
726 static arch_ptr empty; // the empty_archetype 797 static arch_ptr empty; // the empty_archetype
727 MTH static void gc (); 798 MTH static void gc ();
728 799
729 archetype (const char *name); 800 archetype (const_utf8_string name);
730 ~archetype (); 801 ~archetype ();
731 void gather_callbacks (AV *&callbacks, event_type event) const; 802 void gather_callbacks (AV *&callbacks, event_type event) const;
732 803
733 MTH static archetype *find (const_utf8_string name); 804 MTH static archetype *find (const_utf8_string name);
734 805
735 MTH void link (); 806 MTH void link ();
736 MTH void unlink (); 807 MTH void unlink ();
737 808
738 MTH static object *get (const char *name); // (find() || singularity)->instance() 809 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
739 MTH object *instance (); 810 MTH object *instance ();
811
812 MTH void post_load_check (); // do some adjustments after parsing
740 813
741 object_vector_index ACC (RW, archid); // index in archvector 814 object_vector_index ACC (RW, archid); // index in archvector
742 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */ 815 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
743 816
744 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */ 817 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
745 sint8 ACC (RW, max_x), ACC (RW, max_y);
746 818
747 // support for archetype loading 819 // support for archetype loading
748 static archetype *read (object_thawer &f); 820 static archetype *read (object_thawer &f);
749 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more 821 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
750 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */ 822 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
751}; 823};
752 824
753// compatbiility, remove once replaced by ->instance 825// returns whether the object is a dragon player, which are often specialcased
754inline object * 826inline bool
755arch_to_object (archetype *at) 827object::is_dragon () const
756{ 828{
757 return at->instance (); 829 return arch->race == shstr_dragon && is_player ();
758} 830}
759 831
760inline void 832inline void
761object_freezer::put (keyword k, archetype *v) 833object_freezer::put (const keyword_string k, archetype *v)
762{ 834{
763 put (k, v ? &v->archname : (const char *)0); 835 if (expect_true (v))
836 put (k, v->archname);
837 else
838 put (k);
764} 839}
765 840
766typedef object_vector<object, &object::index > objectvec; 841typedef object_vector<object, &object::index > objectvec;
767typedef object_vector<object, &object::active> activevec; 842typedef object_vector<object, &object::active> activevec;
768typedef object_vector<archetype, &archetype::archid> archvec; 843typedef object_vector<archetype, &archetype::archid> archvec;
785 statementvar (object *, var, actives [_i]) 860 statementvar (object *, var, actives [_i])
786 861
787#define for_all_archetypes(var) \ 862#define for_all_archetypes(var) \
788 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \ 863 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
789 statementvar (archetype *, var, archetypes [_i]) 864 statementvar (archetype *, var, archetypes [_i])
865
866//+GPL
790 867
791/* Used by update_object to know if the object being passed is 868/* Used by update_object to know if the object being passed is
792 * being added or removed. 869 * being added or removed.
793 */ 870 */
794#define UP_OBJ_INSERT 1 871#define UP_OBJ_INSERT 1
824#define INS_ABOVE_FLOOR_ONLY 0x0002 901#define INS_ABOVE_FLOOR_ONLY 0x0002
825#define INS_NO_WALK_ON 0x0004 902#define INS_NO_WALK_ON 0x0004
826#define INS_ON_TOP 0x0008 903#define INS_ON_TOP 0x0008
827#define INS_BELOW_ORIGINATOR 0x0010 904#define INS_BELOW_ORIGINATOR 0x0010
828 905
829#define ARCH_DEPLETION "depletion" 906//-GPL
830 907
831#endif 908#endif
832 909

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines