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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines