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.97 by root, Wed Feb 7 02:13:06 2007 UTC vs.
Revision 1.202 by root, Sat Jun 27 08:25:36 2009 UTC

1/* 1/*
2 * CrossFire, A Multiplayer Online RPG 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.
21 * 20 *
22 * The authors can be reached via e-mail at crossfire@schmorp.de 21 * The authors can be reached via e-mail to <support@deliantra.net>
23 */ 22 */
24 23
25#ifndef OBJECT_H 24#ifndef OBJECT_H
26#define OBJECT_H 25#define OBJECT_H
27 26
29 28
30#include "cfperl.h" 29#include "cfperl.h"
31#include "shstr.h" 30#include "shstr.h"
32 31
33typedef int 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 */
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// materialtype_t *ACC (RW, material); /* What material this object consists of */ 180// materialtype_t *ACC (RW, material); /* What material this object consists of */
116 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 */
117 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 */
118 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 */
119 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */ 184 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
121 object_ptr ACC (RW, spell); /* Spell that was being cast */ 186 object_ptr ACC (RW, spell); /* Spell that was being cast */
122 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 */
123 arch_ptr ACC (RW, arch); /* Pointer to archetype */ 188 arch_ptr ACC (RW, arch); /* Pointer to archetype */
124 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 */
125 190
126 facetile *ACC (RW, face); /* Face with colors */
127 float ACC (RW, speed); /* The overall speed of this object */ 191 float ACC (RW, speed); /* The overall speed of this object */
128 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
129 uint32 ACC (RW, nrof); /* How many of the objects */ 194 sint32 ACC (RW, nrof); /* How many of the objects */
130
131 /* This next big block are basically used for monsters and equipment */ 195 /* This next big block is basically used for monsters and equipment */
132 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
133 uint8 ACC (RW, subtype); /* subtype of object */
134 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 */
135 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */ 197 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
198
136 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */ 199 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
137 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */ 200 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
138 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */ 201 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
139 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 */
203
140 uint16 ACC (RW, materials); /* What materials this object consists of */ 204 uint16 ACC (RW, materials); /* What materials this object consists of */
141 sint8 ACC (RW, magic); /* Any magical bonuses to this item */ 205 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
142 uint8 ACC (RW, state); /* How the object was last drawn (animation) */ 206 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
143 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
144 /* Note that the last_.. values are sometimes used for non obvious 209 /* Note that the last_.. values are sometimes used for non obvious
145 * meanings by some objects, eg, sp penalty, permanent exp. 210 * meanings by some objects, eg, sp penalty, permanent exp.
146 */ 211 */
147 sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */ 212 sint16 ACC (RW, last_heal); /* Last healed. Depends on constitution */
148 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 */
149 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */ 214 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
150 sint16 ACC (RW, last_eat); /* How long since we last ate */ 215 sint16 ACC (RW, last_eat); /* How long since we last ate */
216
151 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 */
152 sint16 ACC (RW, level); /* Level of creature or object */ 218 sint16 ACC (RW, level); /* Level of creature or object */
219
153 uint8 ACC (RW, pick_up); /* See crossfire.doc */ 220 uint8 ACC (RW, pick_up); /* See crossfire.doc */
154 sint8 ACC (RW, item_power); /* power rating of the object */
155 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) */
156 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
157 sint32 ACC (RW, weight); /* Attributes of the object */ 232 sint32 ACC (RW, weight); /* Attributes of the object */
158 sint32 ACC (RW, weight_limit);/* Weight-limit of object */ 233 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
234
159 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
160 sint64 ACC (RW, perm_exp); /* Permanent exp */ 237 sint64 ACC (RW, perm_exp); /* Permanent exp */
161 uint32 ACC (RW, weapontype); /* type of weapon */
162 uint32 ACC (RW, tooltype); /* type of tool or build facility */
163 sint8 ACC (RW, body_info[NUM_BODY_LOCATIONS]); /* body info as loaded from the file */
164 sint8 ACC (RW, body_used[NUM_BODY_LOCATIONS]); /* Calculated value based on items equipped */
165 living ACC (RO, stats); /* Str, Con, Dex, etc */ 238 living ACC (RO, stats); /* Str, Con, Dex, etc */
166 /* See the pod/objects.pod for more info about body locations */ 239 /* See the pod/objects.pod for more info about body locations */
167 240
168 /* Following mostly refers to fields only used for monsters */ 241 /* Following mostly refers to fields only used for monsters */
169 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
170
171 /* allows different movement patterns for attackers */
172 sint32 ACC (RW, move_status); /* What stage in attack mode */
173 uint16 ACC (RW, attack_movement); /* What kind of attack movement */
174 uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
175 float ACC (RW, expmul); /* needed experience = (calc_exp*expmul) - means some */
176 /* races/classes can need less/more exp to gain levels */
177 242
178 /* Spell related information, may be useful elsewhere 243 /* Spell related information, may be useful elsewhere
179 * Note that other fields are used - these files are basically 244 * Note that other fields are used - these files are basically
180 * only used in spells. 245 * only used in spells.
181 */ 246 */
182 sint16 ACC (RW, duration); /* How long the spell lasts */ 247 sint16 ACC (RW, duration); /* How long the spell lasts */
183 sint16 ACC (RW, casting_time);/* time left before spell goes off */ 248 uint8 ACC (RW, casting_time); /* time left before spell goes off */
184 uint16 ACC (RW, start_holding);
185 uint8 ACC (RW, duration_modifier); /* how level modifies duration */ 249 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
250
186 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 */
187 sint8 ACC (RW, range); /* Range of the spell */ 252 sint8 ACC (RW, range); /* Range of the spell */
188 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 */
189 255
256 uint8 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
190 MoveType ACC (RW, move_type); /* Type of movement this object uses */ 257 MoveType ACC (RW, move_type); /* Type of movement this object uses */
191 MoveType ACC (RW, move_block);/* What movement types this blocks */ 258 MoveType ACC (RW, move_block);/* What movement types this blocks */
192 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */ 259 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
260
193 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 */
194 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 */
195 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 */
196 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 */
197
198 char *ACC (RW, spellarg);
199 270
200 /* Following are values used by any object */ 271 /* Following are values used by any object */
201 /* this objects turns into or what this object creates */ 272 /* this objects turns into or what this object creates */
202 treasurelist *ACC (RW, randomitems); /* Items to be generated */ 273 treasurelist *ACC (RW, randomitems); /* Items to be generated */
203 key_value *key_values; /* Fields not explictly known by the loader. */ 274
204 flags_t flag; /* various flags */
205#if FOR_PERL
206 bool ACC (RW, flag[NUM_FLAGS]);
207#endif
208 uint16 ACC (RW, animation_id);/* An index into the animation array */
209 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
210 uint8 ACC (RW, last_anim); /* last sequence used to draw face */ 275 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
211 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */
212 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */ 276 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
213 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 */
214}; 296};
215 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
216struct object : zero_initialised, object_copy 303struct object : zero_initialised, object_copy
217{ 304{
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 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 308 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
222 int ACC (RO, count); 309 int ACC (RO, count);
223 int ACC (RO, index); // index into objects 310 object_vector_index ACC (RO, index); // index into objects
224 int ACC (RO, active); // index into actives 311 object_vector_index ACC (RO, active); // index into actives
225 312
226 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 */
227 314
228 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 */
229 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 */
230 /* Note: stacked in the *same* environment */ 317 /* Note: stacked in the *same* environment */
231 object *inv; /* Pointer to the first object in the inventory */ 318 object *inv; /* Pointer to the first object in the inventory */
232 319
233 //TODO: container must move into client 320 //TODO: container must move into client
234 object *ACC (RW, container); /* Current container being used. I think this 321 object_ptr ACC (RW, container); /* Current container being used. I think this
235 * is only used by the player right now. 322 * is only used by the player right now.
236 */ 323 */
237 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.
238 * This is typically the container that the object is in. 325 * This is typically the container that the object is in.
239 */ 326 */
240 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 */
241 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
242 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. */
243 331
332 // privates / perl
333 shstr_tmp kv_get (shstr_tmp key) const;
334 void kv_del (shstr_tmp key);
335 void kv_set (shstr_tmp key, shstr_tmp value);
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;
244 MTH static object *create (); 373 MTH static object *create ();
374 const mapxy &operator =(const mapxy &pos);
245 MTH void copy_to (object *dst); 375 MTH void copy_to (object *dst);
246 MTH 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
247 void do_destroy (); 378 void do_destroy ();
248 void gather_callbacks (AV *&callbacks, event_type event) const; 379 void gather_callbacks (AV *&callbacks, event_type event) const;
249 MTH void destroy (bool destroy_inventory = false); 380 MTH void destroy ();
381 MTH void drop_and_destroy ()
382 {
383 destroy_inv (true);
384 destroy ();
385 }
250 386
251 // 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
252 MTH void destroy_inv (bool drop_to_ground = false); 388 MTH void destroy_inv (bool drop_to_ground = false);
253 MTH 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
254 void do_remove (); 393 void do_remove ();
255 MTH void remove () 394 MTH void remove ()
256 { 395 {
257 if (!flag [FLAG_REMOVED]) 396 if (!flag [FLAG_REMOVED])
258 do_remove (); 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);
259 } 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
268 && can_merge_slow (op1, op2); 424 && can_merge_slow (op1, op2);
269 } 425 }
270 426
271 MTH void set_owner (object *owner); 427 MTH void set_owner (object *owner);
272 MTH void set_speed (float speed); 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);
273 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
274 MTH void instantiate () 452 MTH void instantiate ();
275 {
276 if (!uuid.seq) // HACK
277 uuid = gen_uuid ();
278
279 attachable::instantiate ();
280 }
281 453
282 // recalculate all stats 454 // recalculate all stats
283 MTH void update_stats (); 455 MTH void update_stats ();
284 MTH void roll_stats (); 456 MTH void roll_stats ();
285 MTH void swap_stats (int a, int b); 457 MTH void swap_stats (int a, int b);
289 MTH void drain_specific_stat (int deplete_stats); 461 MTH void drain_specific_stat (int deplete_stats);
290 MTH void change_luck (int value); 462 MTH void change_luck (int value);
291 463
292 // info must hold 256 * 3 bytes currently 464 // info must hold 256 * 3 bytes currently
293 const char *debug_desc (char *info) const; 465 const char *debug_desc (char *info) const;
294 MTH const char *debug_desc () const; 466 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
295 const char *debug_desc2 () const; // another debug_desc, pure convinience function
296 const char *flag_desc (char *desc, int len) const; 467 const char *flag_desc (char *desc, int len) const;
297 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
298 int number_of () const 472 MTH int number_of () const
299 { 473 {
300 return nrof ? nrof : 1; 474 return nrof ? nrof : 1;
301 } 475 }
302 476
303 uint64 total_weight () const 477 MTH sint32 total_weight () const
304 { 478 {
305 return weight * number_of (); 479 return (weight + carrying) * number_of ();
306 } 480 }
481
482 MTH void update_weight ();
307 483
308 // return the dominant material of this item, always return something 484 // return the dominant material of this item, always return something
309 const materialtype_t *dominant_material () const; 485 const materialtype_t *dominant_material () const;
310 486
487 // return the volume of this object in cm³
311 uint64 volume () const 488 MTH uint64 volume () const
312 { 489 {
313 return total_weight () / dominant_material ()->density; 490 return (uint64)total_weight ()
491 * 1000
492 * (type == CONTAINER ? 1000 : 1)
493 / dominant_material ()->density;
314 } 494 }
315 495
496 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
316 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; } 497 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
317 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET 498 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
318 || type == CLOAK || type == BOOTS || type == GLOVES 499 || type == CLOAK || type == BOOTS || type == GLOVES
319 || type == BRACERS || type == GIRDLE; } 500 || type == BRACERS || type == GIRDLE; }
320 MTH bool is_alive () const { return (type == PLAYER 501 MTH bool is_alive () const { return (type == PLAYER
322 || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR)) 503 || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR))
323 && !flag [FLAG_IS_A_TEMPLATE]; } 504 && !flag [FLAG_IS_A_TEMPLATE]; }
324 MTH bool is_arrow () const { return type == ARROW 505 MTH bool is_arrow () const { return type == ARROW
325 || (type == SPELL_EFFECT 506 || (type == SPELL_EFFECT
326 && (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; }
327 509
328 MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; } 510 MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; }
329 511
330 // temporary: wether the object can be saved in a map file 512 // temporary: wether the object can be saved in a map file
331 // contr => is a player 513 // contr => is a player
332 // head => only save head of a multitile object 514 // head => only save head of a multitile object
333 // owner => can not reference owner yet 515 // owner => can not reference owner yet
334 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; } 516 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
335 517
336 /* This return true if object has still randomitems which 518 /* This return true if object has still randomitems which
337 * could be expanded. 519 * could be expanded.
338 */ 520 */
339 MTH 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]; }
340 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 }
546
341 // 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
342 MTH object *in_player () const 549 MTH object *in_player () const
343 { 550 {
344 for (object *op = env; op; op = op->env) 551 object *op = outer_env ();
345 if (op->type == PLAYER)
346 return op;
347 552
348 return 0; 553 return op->type == PLAYER ? op : 0;
349 } 554 }
350 555
351 // "temporary" helper function 556 // "temporary" helper function
352 MTH object *head_ () 557 MTH object *head_ () const
353 { 558 {
354 return head ? head : this; 559 return head ? head : const_cast<object *>(this);
355 } 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 {
579 return !!contr;
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);
356 612
357 // insert object at same map position as 'where' 613 // insert object at same map position as 'where'
358 // handles both inventory and map "positions" 614 // handles both inventory and map "positions"
359 MTH object *insert_at (object *where, object *originator = 0, int flags = 0); 615 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
616 MTH void drop_unpaid_items ();
360 617
361 MTH void activate (); 618 MTH void activate ();
362 MTH void deactivate (); 619 MTH void deactivate ();
363 MTH void activate_recursive (); 620 MTH void activate_recursive ();
364 MTH void deactivate_recursive (); 621 MTH void deactivate_recursive ();
365 622
366 // set the givne flag on all objects in the inventory recursively 623 // set the given flag on all objects in the inventory recursively
367 MTH void set_flag_inv (int flag, int value = 1); 624 MTH void set_flag_inv (int flag, int value = 1);
368 625
369 void enter_exit (object *exit);//PERL 626 void enter_exit (object *exit);//Perl
370 MTH void enter_map (maptile *newmap, int x, int y); 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
371 629
372 // returns the mapspace this object is in 630 // returns the mapspace this object is in
373 mapspace &ms () const; 631 mapspace &ms () const;
374 632
375 // fully recursive iterator 633 // fully recursive iterator
411 { 669 {
412 return this; 670 return this;
413 } 671 }
414 672
415 /* This returns TRUE if the object is something that 673 /* This returns TRUE if the object is something that
416 * should be displayed in the floorbox/inventory window 674 * a client might want to know about.
417 */ 675 */
418 MTH bool client_visible () const 676 MTH bool client_visible () const
419 { 677 {
420 return !invisible && type != PLAYER; 678 return !invisible && type != PLAYER;
421 } 679 }
422 680
681 // the client does nrof * this weight
682 MTH sint32 client_weight () const
683 {
684 return weight + carrying;
685 }
686
423 MTH struct region *region () const; 687 MTH struct region *region () const;
424 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
425protected: 715protected:
426 friend struct archetype;
427
428 void link (); 716 void link ();
429 void unlink (); 717 void unlink ();
430 718
431 object (); 719 object ();
432 ~object (); 720 ~object ();
721
722private:
723 object &operator =(const object &);
724 object (const object &);
433}; 725};
434 726
435typedef object_vector<object, &object::index > objectvec; 727// move this object to the top of its env's inventory to speed up
436typedef object_vector<object, &object::active> activevec; 728// searches for it.
729static object *
730splay (object *ob)
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;
437 736
438extern objectvec objects; 737 ob->above = 0;
439extern activevec actives; 738 ob->below = ob->env->inv;
739 ob->below->above = ob;
740 ob->env->inv = ob;
741 }
440 742
441#define for_all_objects(var) \ 743 return ob;
442 for (int _i = 0; _i < objects.size (); ++_i) \ 744}
443 declvar (object *, var, objects [_i])
444 745
445#define for_all_actives(var) \ 746object *find_skill_by_name_fuzzy (object *who, const char *name);
446 for (int _i = 0; _i < actives.size (); ++_i) \ 747object *find_skill_by_name (object *who, shstr_cmp sh);
447 declvar (object *, var, actives [_i]) 748object *find_skill_by_number (object *who, int skillno);
448
449typedef struct oblnk
450{ /* Used to link together several objects */
451 object_ptr ob;
452 struct oblnk *next;
453} objectlink;
454
455typedef struct oblinkpt
456{ /* Used to link together several object links */
457 struct oblnk *link;
458 long value; /* Used as connected value in buttons/gates */
459 struct oblinkpt *next;
460} oblinkpt;
461 749
462/* 750/*
463 * 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
464 * objects which point to archetypes. 752 * objects which point to archetypes.
465 * 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
467 * object and pointers. This structure should get removed, and just replaced 755 * object and pointers. This structure should get removed, and just replaced
468 * by the object structure 756 * by the object structure
469 */ 757 */
470 758
471INTERFACE_CLASS (archetype) 759INTERFACE_CLASS (archetype)
472struct archetype : zero_initialised, attachable 760struct archetype : object
473{ 761{
474 archetype (); 762 static arch_ptr empty; // the empty_archetype
763 MTH static void gc ();
764
765 archetype (const char *name);
475 ~archetype (); 766 ~archetype ();
476 void gather_callbacks (AV *&callbacks, event_type event) const; 767 void gather_callbacks (AV *&callbacks, event_type event) const;
477 768
478 static archetype *find (const char *name); 769 MTH static archetype *find (const_utf8_string name);
479 770
480 void hash_add (); // add to hashtable 771 MTH void link ();
481 void hash_del (); // remove from hashtable 772 MTH void unlink ();
482 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
483 shstr ACC (RW, name); /* More definite name, like "generate_kobold" */ 778 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
484 struct archetype *ACC (RW, next); /* Next archetype in a linked list */ 779
485 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...) */
486 struct archetype *ACC (RW, more); /* Next part of a linked object */ 781 sint8 ACC (RW, max_x), ACC (RW, max_y);
487 object ACC (RO, clone); /* An object from which to do ->copy_to () */ 782
488 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */ 783 // support for archetype loading
489 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);
490 * in comparison to the head. 785 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
491 */ 786 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
492}; 787};
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
806extern objectvec objects;
807extern activevec actives;
808extern archvec archetypes;
809
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; )
814
815#define for_all_objects(var) \
816 for (unsigned _i = 0; _i < objects.size (); ++_i) \
817 statementvar (object *, var, objects [_i])
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])
493 826
494/* 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
495 * being added or removed. 828 * being added or removed.
496 */ 829 */
497#define UP_OBJ_INSERT 1 830#define UP_OBJ_INSERT 1
514 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 847 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
515 * 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
516 * beneath the player, but not actually above it. Note - the 849 * beneath the player, but not actually above it. Note - the
517 * 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
518 * match the originator. 851 * match the originator.
519 * INS_MAP_LOAD: disable lots of checkings done at insertion to
520 * speed up map loading process, as we assume the ordering in
521 * loaded map is correct.
522 * 852 *
523 * 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
524 * are mutually exclusive. The behaviour for passing more than one 854 * are mutually exclusive. The behaviour for passing more than one
525 * should be considered undefined - while you may notice what happens 855 * should be considered undefined - while you may notice what happens
526 * 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
529#define INS_NO_MERGE 0x0001 859#define INS_NO_MERGE 0x0001
530#define INS_ABOVE_FLOOR_ONLY 0x0002 860#define INS_ABOVE_FLOOR_ONLY 0x0002
531#define INS_NO_WALK_ON 0x0004 861#define INS_NO_WALK_ON 0x0004
532#define INS_ON_TOP 0x0008 862#define INS_ON_TOP 0x0008
533#define INS_BELOW_ORIGINATOR 0x0010 863#define INS_BELOW_ORIGINATOR 0x0010
534#define INS_MAP_LOAD 0x0020
535 864
536#define ARCH_SINGULARITY "singularity"
537#define ARCH_SINGULARITY_LEN 11
538#define ARCH_DETECT_MAGIC "detect_magic"
539#define ARCH_DEPLETION "depletion" 865#define ARCH_DEPLETION "depletion"
540#define ARCH_SYMPTOM "symptom"
541 866
542#endif 867#endif
543 868

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines