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.184 by root, Mon Sep 29 10:31:32 2008 UTC vs.
Revision 1.225 by root, Sat Jan 30 23:30:26 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines