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.61 by root, Thu Dec 21 01:33:50 2006 UTC vs.
Revision 1.215 by root, Sat Nov 7 18:30:05 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines