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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines