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.145 by root, Sat Aug 25 22:19:26 2007 UTC vs.
Revision 1.218 by root, Mon Nov 9 03:08:24 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines