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.115 by root, Thu May 3 10:39:46 2007 UTC vs.
Revision 1.208 by root, Sat Oct 3 18:46:26 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines