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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines