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.53 by root, Wed Dec 13 18:08:01 2006 UTC vs.
Revision 1.213 by root, Mon Oct 19 21:48:49 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines