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.154 by root, Wed Apr 9 14:36:47 2008 UTC vs.
Revision 1.232 by root, Sat Apr 3 02:29:40 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines