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.35 by root, Thu Sep 14 01:12:28 2006 UTC vs.
Revision 1.193 by root, Wed Dec 31 18:07:41 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines