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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines