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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines