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.1.1.1 by root, Fri Feb 3 07:12:50 2006 UTC vs.
Revision 1.163 by root, Sun Apr 20 23:25:09 2008 UTC

1/* 1/*
2 * static char *rcsid_object_h = 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * "$Id: object.h,v 1.1.1.1 2006/02/03 07:12:50 root Exp $"; 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 *
8 * Deliantra is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 *
21 * The authors can be reached via e-mail to <support@deliantra.net>
4 */ 22 */
5
6/*
7 CrossFire, A Multiplayer game for X-windows
8
9 Copyright (C) 2001 Mark Wedel & Crossfire Development Team
10 Copyright (C) 1992 Frank Tore Johansen
11
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or
15 (at your option) any later version.
16
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
21
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25
26 The authors can be reached via e-mail at crossfire-devel@real-time.com
27*/
28 23
29#ifndef OBJECT_H 24#ifndef OBJECT_H
30#define OBJECT_H 25#define OBJECT_H
31 26
27#include <bitset>
28
29#include "cfperl.h"
30#include "shstr.h"
31
32typedef uint32 tag_t; 32typedef int tag_t;
33
34enum {
35 body_skill,
36 body_combat,
37 body_range,
38 body_shield,
39 body_arm,
40 body_torso,
41 body_head,
42 body_neck,
43 body_finger,
44 body_shoulder,
45 body_foot,
46 body_hand,
47 body_wrist,
48 body_waist,
33#define NUM_BODY_LOCATIONS 12 49 NUM_BODY_LOCATIONS
34#define BODY_ARMS 1 50};
51
52enum slottype_t
53{
54 slot_none,
55 slot_combat,
56 slot_ranged,
57};
35 58
36/* See common/item.c */ 59/* See common/item.c */
37 60
38typedef struct Body_Locations { 61typedef struct Body_Locations
62{
39 char *save_name; /* Name used to load/save it to disk */ 63 keyword save_name; /* Name used to load/save it to disk */
40 char *use_name; /* Name used when describing an item we can use */ 64 const char *use_name; /* Name used when describing an item we can use */
41 char *nonuse_name; /* Name to describe objects we can't use */ 65 const char *nonuse_name; /* Name to describe objects we can't use */
42} Body_Locations; 66} Body_Locations;
43 67
44extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 68extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
45 69
46typedef struct _event 70#define NUM_COINS 4 /* number of coin types */
47{ 71extern const char *const coins[NUM_COINS + 1];
48 int type;
49 const char *hook;
50 const char *plugin;
51 const char *options;
52 struct _event *next;
53} event;
54 72
55/* 73/*
56 * Each object (this also means archetypes!) could have a few of these 74 * Each object (this also means archetypes!) could have a few of these
57 * "dangling" from it; this could also end up containing 'parse errors'. 75 * "dangling" from it; this could also end up containing 'parse errors'.
58 * 76 *
60 * 78 *
61 * Please use get_ob_key_value(), set_ob_key_value() from object.c rather than 79 * Please use get_ob_key_value(), set_ob_key_value() from object.c rather than
62 * accessing the list directly. 80 * accessing the list directly.
63 * Exception is if you want to walk this list for some reason. 81 * Exception is if you want to walk this list for some reason.
64 */ 82 */
65typedef struct _key_value { 83struct key_value
66 const char * key; 84{
67 const char * value;
68 struct _key_value * next; 85 key_value *next;
69} key_value; 86 shstr key, value;
87};
70 88
89struct UUID
90{
91 uint64 seq;
92
93 static UUID cur; // last uuid generated
94 static void init ();
95 static UUID gen ();
96
97 UUID () { }
98 UUID (uint64 seq) : seq(seq) { }
99 operator uint64() { return seq; }
100 void operator =(uint64 seq) { this->seq = seq; }
101
102 typedef char BUF [32];
103
104 bool parse (const char *s)
105 {
106 return sscanf (s, "<1.%" SCNx64 ">", &seq) == 1;
107 }
108
109 const char *c_str (char *buf, int len) const
110 {
111 snprintf (buf, len, "<1.%" PRIx64 ">", seq);
112
113 return buf;
114 }
115
116 const char *c_str () const
117 {
118 static BUF buf;
119
120 return c_str (buf, sizeof (buf));
121 }
122};
71 123
72/* Definition for WILL_APPLY values. Replaces having harcoded values 124/* Definition for WILL_APPLY values. Replaces having harcoded values
73 * sprinkled in the code. Note that some of these also replace fields 125 * sprinkled in the code. Note that some of these also replace fields
74 * that were in the can_apply area. What is the point of having both 126 * that were in the can_apply area. What is the point of having both
75 * can_apply and will_apply? 127 * can_apply and will_apply?
76 */ 128 */
77#define WILL_APPLY_HANDLE 0x1 129#define WILL_APPLY_HANDLE 0x01
78#define WILL_APPLY_TREASURE 0x2 130#define WILL_APPLY_TREASURE 0x02
79#define WILL_APPLY_EARTHWALL 0x4 131#define WILL_APPLY_EARTHWALL 0x04
80#define WILL_APPLY_DOOR 0x8 132#define WILL_APPLY_DOOR 0x08
81#define WILL_APPLY_FOOD 0x10 133#define WILL_APPLY_FOOD 0x10
82 134
135struct body_slot
136{
137 signed char info:4; /* body info as loaded from the file */
138 signed char used:4; /* Calculated value based on items equipped */
139};
83 140
84/* Note that the ordering of this structure is sort of relevent - 141INTERFACE_CLASS (object)
85 * copy_object copies everything over beyond 'name' using memcpy. 142// these are being copied
86 * Thus, values that need to be copied need to be located beyond that 143struct object_copy : attachable
87 * point. 144{
88 * 145 typedef bitset<NUM_FLAGS> flags_t;
89 * However, if you're keeping a pointer of some sort, you probably 146
90 * don't just want it copied, so you'll need to add to common/object.c, 147 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
91 * e.g. copy-object 148
92 * 149 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
93 * I've tried to clean up this structure a bit (in terms of formatting) 150 uint8 ACC (RW, subtype); /* subtype of object */
94 * by making it more consistent. I've also tried to locate some of the fields 151 sint8 ACC (RW, direction); /* Means the object is moving that way. */
95 * more logically together (put the item related ones together, the monster 152 sint8 ACC (RW, facing); /* Object is oriented/facing that way. */
96 * related ones, etc. 153
97 * This structure is best viewed with about a 100 width screen. 154 shstr ACC (RW, name); /* The name of the object, obviously... */
98 * MSW 2002-07-05 155 shstr ACC (RW, name_pl); /* The plural name of the object */
156 shstr ACC (RW, title); /* Of foo, etc */
157 shstr ACC (RW, race); /* human, goblin, dragon, etc */
158 shstr ACC (RW, slaying); /* Which race to do double damage to */
159 /* If this is an exit, this is the filename */
160 shstr ACC (RW, tag); // a tag used to tracking this object
161 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
162 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
163 shstr ACC (RW, lore); /* Obscure information about this object, */
164 /* To get put into books and the like. */
165 shstr ACC (RW, materialname); /* specific material name */
166 shstr ACC (RW, custom_name); /* Custom name assigned by player */
167// materialtype_t *ACC (RW, material); /* What material this object consists of */
168 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
169 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
170 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
171 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
172 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
173 object_ptr ACC (RW, spell); /* Spell that was being cast */
174 object_ptr ACC (RW, current_weapon); /* Pointer to the weapon currently used */
175 arch_ptr ACC (RW, arch); /* Pointer to archetype */
176 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
177
178 float ACC (RW, speed); /* The overall speed of this object */
179 float ACC (RW, speed_left); /* How much speed is left to spend this round */
180 uint32 ACC (RW, nrof); /* How many of the objects */
181
182 /* This next big block are basically used for monsters and equipment */
183 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
184
185 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
186 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
187 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
188 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
189 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
190 uint16 ACC (RW, materials); /* What materials this object consists of */
191 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
192 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
193 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
194 /* Note that the last_.. values are sometimes used for non obvious
195 * meanings by some objects, eg, sp penalty, permanent exp.
99 */ 196 */
100typedef struct obj { 197 sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */
198 sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */
199 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
200 sint16 ACC (RW, last_eat); /* How long since we last ate */
201 sint16 ACC (RW, invisible); /* How much longer the object will be invis */
202 sint16 ACC (RW, level); /* Level of creature or object */
203 uint8 ACC (RW, pick_up); /* See crossfire.doc */
204 sint8 ACC (RW, item_power); /* power rating of the object */
205 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
206 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
207 sint32 ACC (RW, weight); /* Attributes of the object */
208 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
209 sint32 ACC (RW, carrying); /* How much weight this object contains */
210 sint64 ACC (RW, perm_exp); /* Permanent exp */
211 uint32 ACC (RW, weapontype); /* type of weapon */
212 uint32 ACC (RW, tooltype); /* type of tool or build facility */
213 body_slot slot [NUM_BODY_LOCATIONS];
214 faceidx ACC (RW, face); /* the graphical face */
215 faceidx ACC (RW, sound); /* the sound face */
216 faceidx ACC (RW, sound_destroy); /* played on destroy */
217 living ACC (RO, stats); /* Str, Con, Dex, etc */
218 /* See the pod/objects.pod for more info about body locations */
219
220 /* Following mostly refers to fields only used for monsters */
221 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
222
223 /* allows different movement patterns for attackers */
224 sint32 ACC (RW, move_status); /* What stage in attack mode */
225 uint16 ACC (RW, attack_movement); /* What kind of attack movement */
226 uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
227 float ACC (RW, expmul); /* needed experience = (calc_exp*expmul) - means some */
228 /* races/classes can need less/more exp to gain levels */
229
230 /* Spell related information, may be useful elsewhere
231 * Note that other fields are used - these files are basically
232 * only used in spells.
233 */
234 sint16 ACC (RW, duration); /* How long the spell lasts */
235 sint16 ACC (RW, casting_time);/* time left before spell goes off */
236
237 uint16 ACC (RW, start_holding);
238 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
239 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
240
241 sint8 ACC (RW, range); /* Range of the spell */
242 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
243 MoveType ACC (RW, move_type); /* Type of movement this object uses */
244 MoveType ACC (RW, move_block);/* What movement types this blocks */
245
246 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
247 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
248 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
249 MoveType ACC (RW, move_slow); /* Movement types this slows down */
250
251 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
252
253 char *ACC (RW, spellarg);
254
255 /* Following are values used by any object */
256 /* this objects turns into or what this object creates */
257 treasurelist *ACC (RW, randomitems); /* Items to be generated */
258 flags_t flag; /* various flags */
259#if FOR_PERL
260 bool ACC (RW, flag[NUM_FLAGS]);
261#endif
262 uint16 ACC (RW, animation_id);/* An index into the animation array */
263 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
264 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
265 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */
266 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
267 uint8 ACC (RW, will_apply); /* See crossfire.doc */
268};
269
270struct object : zero_initialised, object_copy
271{
101 /* These variables are not changed by copy_object() */ 272 // These variables are not changed by ->copy_to
102 struct pl *contr; /* Pointer to the player which control this object */ 273 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */
103 struct obj *next; /* Pointer to the next object in the free/used list */ 274
104 struct obj *prev; /* Pointer to the previous object in the free/used list*/ 275 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
105 struct obj *active_next; /* Next & previous object in the 'active' */ 276 int ACC (RO, count);
106 struct obj *active_prev; /* List. This is used in process_events */ 277 object_vector_index ACC (RO, index); // index into objects
107 /* so that the entire object list does not */ 278 object_vector_index ACC (RO, active); // index into actives
108 /* need to be gone through. */ 279
280 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
281
109 struct obj *below; /* Pointer to the object stacked below this one */ 282 object *ACC (RW, below); /* Pointer to the object stacked below this one */
110 struct obj *above; /* Pointer to the object stacked above this one */ 283 object *ACC (RW, above); /* Pointer to the object stacked above this one */
111 /* Note: stacked in the *same* environment*/ 284 /* Note: stacked in the *same* environment */
112 struct obj *inv; /* Pointer to the first object in the inventory */ 285 object *inv; /* Pointer to the first object in the inventory */
286
287 //TODO: container must move into client
113 struct obj *container; /* Current container being used. I think this 288 object_ptr ACC (RW, container); /* Current container being used. I think this
114 * is only used by the player right now. 289 * is only used by the player right now.
115 */ 290 */
116 struct obj *env; /* Pointer to the object which is the environment. 291 object *ACC (RW, env); /* Pointer to the object which is the environment.
117 * This is typically the container that the object is in. 292 * This is typically the container that the object is in.
118 */ 293 */
119 struct obj *more; /* Pointer to the rest of a large body of objects */ 294 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
120 struct obj *head; /* Points to the main object of a large body */ 295 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
121 struct mapdef *map; /* Pointer to the map in which this object is present */ 296 client_container *seen_by; // seen by which player/container currently?
122
123 tag_t count; /* Unique object number for this object */
124 uint16 refcount; /* How many objects points to this object */
125
126 /* These get an extra add_refcount(), after having been copied by memcpy().
127 * All fields beow this point are automatically copied by memcpy. If
128 * adding something that needs a refcount updated, make sure you modify
129 * copy_object to do so. Everything below here also gets cleared
130 * by clear_object()
131 */
132 const char *name; /* The name of the object, obviously... */
133 const char *name_pl; /* The plural name of the object */
134 const char *title; /* Of foo, etc */
135 const char *race; /* human, goblin, dragon, etc */
136 const char *slaying; /* Which race to do double damage to */
137 /* If this is an exit, this is the filename */
138 const char *skill; /* Name of the skill this object uses/grants */
139 const char *msg; /* If this is a book/sign/magic mouth/etc */
140 const char *lore; /* Obscure information about this object, */
141 /* To get put into books and the like. */
142
143 sint16 x,y; /* Position in the map for this object */
144 sint16 ox,oy; /* For debugging: Where it was last inserted */
145 float speed; /* The overall speed of this object */
146 float speed_left; /* How much speed is left to spend this round */
147 uint32 nrof; /* How many of the objects */
148 New_Face *face; /* Face with colors */
149 sint8 direction; /* Means the object is moving that way. */
150 sint8 facing; /* Object is oriented/facing that way. */
151
152 /* This next big block are basically used for monsters and equipment */
153 uint8 type; /* PLAYER, BULLET, etc. See define.h */
154 uint8 subtype; /* subtype of object */
155 uint16 client_type; /* Public type information. see doc/Developers/objects */
156 sint16 resist[NROFATTACKS]; /* Resistance adjustments for attacks */
157 uint32 attacktype; /* Bitmask of attacks this object does */
158 uint32 path_attuned; /* Paths the object is attuned to */
159 uint32 path_repelled; /* Paths the object is repelled from */
160 uint32 path_denied; /* Paths the object is denied access to */
161 uint16 material; /* What materials this object consist of */
162 const char *materialname; /* specific material name */
163 sint8 magic; /* Any magical bonuses to this item */
164 uint8 state; /* How the object was last drawn (animation) */
165 sint32 value; /* How much money it is worth (or contains) */
166 sint16 level; /* Level of creature or object */
167 /* Note that the last_.. values are sometimes used for non obvious
168 * meanings by some objects, eg, sp penalty, permanent exp.
169 */
170 sint32 last_heal; /* Last healed. Depends on constitution */
171 sint32 last_sp; /* As last_heal, but for spell points */
172 sint16 last_grace; /* as last_sp, except for grace */
173 sint16 last_eat; /* How long since we last ate */
174 sint16 invisible; /* How much longer the object will be invis */
175 uint8 pick_up; /* See crossfire.doc */
176 sint8 item_power; /* power rating of the object */
177 sint8 gen_sp_armour; /* sp regen penalty this object has (was last_heal)*/
178 sint32 weight; /* Attributes of the object */
179 sint32 weight_limit; /* Weight-limit of object */
180 sint32 carrying; /* How much weight this object contains */
181 sint8 glow_radius; /* indicates the glow radius of the object */
182 living stats; /* Str, Con, Dex, etc */
183 sint64 perm_exp; /* Permanent exp */
184 const char *current_weapon_script; /* The script of the currently used weapon. Executed */
185 /* each time the object attacks something */
186 struct obj *current_weapon; /* Pointer to the weapon currently used */
187 uint32 weapontype; /* type of weapon */
188 uint32 tooltype; /* type of tool or build facility */
189 sint8 body_info[NUM_BODY_LOCATIONS]; /* body info as loaded from the file */
190 sint8 body_used[NUM_BODY_LOCATIONS]; /* Calculated value based on items equipped */
191 /* See the doc/Developers/objects for more info about body locations */
192
193 /* Following mostly refers to fields only used for monsters */
194 struct obj *owner; /* Pointer to the object which controls this one */
195 /* Owner should not be referred to directly - */
196 /* get_owner should be used instead. */
197 tag_t ownercount; /* What count the owner had (in case owner */
198 /* has been freed) */
199 struct obj *enemy; /* Monster/player to follow even if not closest */
200 struct obj *attacked_by; /* This object start to attack us! only player & monster */
201 tag_t attacked_by_count; /* the tag of attacker, so we can be sure */
202 struct treasureliststruct *randomitems; /* Items to be generated */
203 uint16 run_away; /* Monster runs away if it's hp goes below this percentage. */
204 struct obj *chosen_skill; /* the skill chosen to use */
205 uint32 hide; /* The object is hidden, not invisible */
206 /* changes made by kholland@sunlab.cit.cornell.edu */
207 /* allows different movement patterns for attackers */
208 sint32 move_status; /* What stage in attack mode */
209 uint16 attack_movement;/* What kind of attack movement */
210 uint8 will_apply; /* See crossfire.doc */
211 struct obj *spellitem; /* Spell ability monster is choosing to use */
212 double expmul; /* needed experience = (calc_exp*expmul) - means some */
213 /* races/classes can need less/more exp to gain levels */
214
215 /* Spell related information, may be useful elsewhere
216 * Note that other fields are used - these files are basically
217 * only used in spells.
218 */
219 sint16 duration; /* How long the spell lasts */
220 uint8 duration_modifier; /* how level modifies duration */
221 sint16 casting_time; /* time left before spell goes off */
222 struct obj *spell; /* Spell that was being cast */
223 uint16 start_holding;
224 char *spellarg;
225 uint8 dam_modifier; /* How going up in level effects damage */
226 sint8 range; /* Range of the spell */
227 uint8 range_modifier; /* How going up in level effects range */
228
229 /* Following are values used by any object */
230 struct archt *arch; /* Pointer to archetype */
231 struct archt *other_arch; /* Pointer used for various things - mostly used for what */
232 /* this objects turns into or what this object creates */
233 uint32 flags[4]; /* various flags */
234 uint16 animation_id; /* An index into the animation array */
235 uint8 anim_speed; /* ticks between animation-frames */
236 uint8 last_anim; /* last sequence used to draw face */
237 sint32 elevation; /* elevation of this terrain - not currently used */
238 uint8 smoothlevel; /* how to smooth this square around*/
239
240 MoveType move_type; /* Type of movement this object uses */
241 MoveType move_block; /* What movement types this blocks */
242 MoveType move_on; /* Move types affected moving on to this space */
243 MoveType move_off; /* Move types affected moving off this space */
244 MoveType move_slow; /* Movement types this slows down */
245 float move_slow_penalty; /* How much this slows down the object */
246
247 event *events;
248
249 const char *custom_name; /* Custom name assigned by player */
250 key_value *key_values; /* Fields not explictly known by the loader. */ 297 key_value *key_values; /* Fields not explictly known by the loader. */
251 298
252} object; 299 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
300 MTH void post_load_check (); // do some adjustments after parsing
301 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
302 bool write (object_freezer &f);
253 303
254typedef struct oblnk { /* Used to link together several objects */ 304 MTH int slottype () const;
305 MTH static object *create ();
306 const mapxy &operator =(const mapxy &pos);
307 object &operator =(const object &src);
308 MTH void copy_to (object *dst);
309 MTH object *clone (); // create + copy_to
310 void do_destroy ();
311 void gather_callbacks (AV *&callbacks, event_type event) const;
312 MTH void destroy (bool destroy_inventory = false);
313
314 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
315 MTH void destroy_inv (bool drop_to_ground = false);
316 MTH object *insert (object *item); // insert into inventory
317 MTH void play_sound (faceidx sound) const;
318
319 void do_remove ();
320 MTH void remove ()
321 {
322 if (!flag [FLAG_REMOVED])
323 do_remove ();
324 }
325
326 MTH bool blocked (maptile *m, int x, int y) const;
327
328 void move_to (const mapxy &pos)
329 {
330 remove ();
331 *this = pos;
332 insert_at (this, this);
333 }
334
335 static bool can_merge_slow (object *op1, object *op2);
336
337 // this is often used in time-critical code, so optimise
338 MTH static bool can_merge (object *op1, object *op2)
339 {
340 return op1->value == op2->value
341 && op1->name == op2->name
342 && can_merge_slow (op1, op2);
343 }
344
345 MTH void set_owner (object *owner);
346 MTH void set_speed (float speed);
347 MTH bool change_weapon (object *ob);
348 MTH bool change_skill (object *ob);
349
350 MTH void open_container (object *new_container);
351 MTH void close_container ()
352 {
353 open_container (0);
354 }
355
356 MTH object *force_find (const shstr name);
357 MTH void force_add (const shstr name, int duration = 0);
358
359 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
360 bool should_invoke (event_type event)
361 {
362 return ev_want_event [event] || ev_want_type [type] || cb;
363 }
364
365 MTH void instantiate ();
366
367 // recalculate all stats
368 MTH void update_stats ();
369 MTH void roll_stats ();
370 MTH void swap_stats (int a, int b);
371 MTH void add_statbonus ();
372 MTH void remove_statbonus ();
373 MTH void drain_stat ();
374 MTH void drain_specific_stat (int deplete_stats);
375 MTH void change_luck (int value);
376
377 // info must hold 256 * 3 bytes currently
378 const char *debug_desc (char *info) const;
379 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
380 const char *flag_desc (char *desc, int len) const;
381
382 MTH int number_of () const
383 {
384 return nrof ? nrof : 1;
385 }
386
387 MTH sint32 total_weight () const
388 {
389 return weight * number_of () + carrying;
390 }
391
392 MTH void update_weight ();
393
394 // return the dominant material of this item, always return something
395 const materialtype_t *dominant_material () const;
396
397 // return the volume of this object in cm³
398 MTH uint64 volume () const
399 {
400 return total_weight ()
401 * 1000
402 * (type == CONTAINER ? 1000 : 1)
403 / dominant_material ()->density;
404 }
405
406 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
407 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
408 || type == CLOAK || type == BOOTS || type == GLOVES
409 || type == BRACERS || type == GIRDLE; }
410 MTH bool is_alive () const { return (type == PLAYER
411 || flag [FLAG_MONSTER]
412 || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR))
413 && !flag [FLAG_IS_A_TEMPLATE]; }
414 MTH bool is_arrow () const { return type == ARROW
415 || (type == SPELL_EFFECT
416 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
417 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
418
419 MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; }
420
421 // temporary: wether the object can be saved in a map file
422 // contr => is a player
423 // head => only save head of a multitile object
424 // owner => can not reference owner yet
425 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
426
427 /* This return true if object has still randomitems which
428 * could be expanded.
429 */
430 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
431
432 // returns the outermost environment, never returns 0
433 MTH object *outer_env ()
434 {
435 for (object *op = this; ; op = op->env)
436 if (!op->env)
437 return op;
438 }
439
440 // returns the player that has this object in his inventory, or 0
441 MTH object *in_player () const
442 {
443 for (object *op = env; op; op = op->env)
444 if (op->type == PLAYER)
445 return op;
446
447 return 0;
448 }
449
450 // "temporary" helper function
451 MTH object *head_ ()
452 {
453 return head ? head : this;
454 }
455
456 MTH bool is_head ()
457 {
458 return head_ () == this;
459 }
460
461 MTH std::string long_desc (object *who = 0);
462 MTH std::string describe_monster (object *who = 0);
463 MTH std::string describe_item (object *who = 0);
464 MTH std::string describe (object *who = 0);
465
466 // If this object has no extra parts but should have them,
467 // add them, effectively expanding heads into multipart
468 // objects. This method only works on objects not inserted
469 // anywhere.
470 MTH void expand_tail ();
471
472 MTH void create_treasure (treasurelist *tl, int flags = 0);
473
474 // insert object at same map position as 'where'
475 // handles both inventory and map "positions"
476 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
477 MTH void drop_unpaid_items ();
478
479 MTH void activate ();
480 MTH void deactivate ();
481 MTH void activate_recursive ();
482 MTH void deactivate_recursive ();
483
484 // set the given flag on all objects in the inventory recursively
485 MTH void set_flag_inv (int flag, int value = 1);
486
487 void enter_exit (object *exit);//Perl
488 MTH void enter_map (maptile *newmap, int x, int y);
489
490 // returns the mapspace this object is in
491 mapspace &ms () const;
492
493 // fully recursive iterator
494 struct iterator_base
495 {
496 object *item;
497
498 iterator_base (object *container)
499 : item (container)
500 {
501 }
502
503 operator object *() const { return item; }
504
505 object *operator ->() const { return item; }
506 object &operator * () const { return *item; }
507 };
508
509 MTH unsigned int random_seed () const
510 {
511 return (unsigned int)uuid.seq;
512 }
513
514 // depth-first recursive iterator
515 struct depth_iterator : iterator_base
516 {
517 depth_iterator (object *container);
518 void next ();
519 object *operator ++( ) { next (); return item; }
520 object *operator ++(int) { object *i = item; next (); return i; }
521 };
522
523 object *begin ()
524 {
525 return this;
526 }
527
528 object *end ()
529 {
530 return this;
531 }
532
533 /* This returns TRUE if the object is something that
534 * should be displayed in the floorbox/inventory window
535 */
536 MTH bool client_visible () const
537 {
538 return !invisible && type != PLAYER;
539 }
540
541 MTH struct region *region () const;
542
543 void statusmsg (const char *msg, int color = NDI_BLACK);
544 void failmsg (const char *msg, int color = NDI_RED);
545
546 const char *query_inventory (object *who = 0, const char *indent = "");
547
548 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
549 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
550
551protected:
552 void link ();
553 void unlink ();
554
255 object *ob; 555 object ();
556 ~object ();
557};
558
559// move this object to the top of its env's inventory to speed up
560// searches for it.
561static object *
562splay (object *ob)
563{
564 if (ob->env && ob->env->inv != ob)
565 {
566 if (ob->above) ob->above->below = ob->below;
567 if (ob->below) ob->below->above = ob->above;
568
569 ob->above = 0;
570 ob->below = ob->env->inv;
571 ob->below->above = ob;
572 ob->env->inv = ob;
573 }
574
575 return ob;
576}
577
578typedef struct oblnk
579{ /* Used to link together several objects */
580 object_ptr ob;
256 struct oblnk *next; 581 struct oblnk *next;
257 tag_t id;
258} objectlink; 582} objectlink;
259 583
260typedef struct oblinkpt { /* Used to link together several object links */ 584typedef struct oblinkpt
585{ /* Used to link together several object links */
261 struct oblnk *link; 586 struct oblnk *link;
262 long value; /* Used as connected value in buttons/gates */ 587 sint32 value; /* Used as connected value in buttons/gates */
263 struct oblinkpt *next; 588 struct oblinkpt *next;
264} oblinkpt; 589} oblinkpt;
590
591object *find_skill_by_name (object *who, const char *name);
592object *find_skill_by_name (object *who, const shstr &sh);
593object *find_skill_by_number (object *who, int skillno);
265 594
266/* 595/*
267 * The archetype structure is a set of rules on how to generate and manipulate 596 * The archetype structure is a set of rules on how to generate and manipulate
268 * objects which point to archetypes. 597 * objects which point to archetypes.
269 * This probably belongs in arch.h, but there really doesn't appear to 598 * This probably belongs in arch.h, but there really doesn't appear to
270 * be much left in the archetype - all it really is is a holder for the 599 * be much left in the archetype - all it really is is a holder for the
271 * object and pointers. This structure should get removed, and just replaced 600 * object and pointers. This structure should get removed, and just replaced
272 * by the object structure 601 * by the object structure
273 */ 602 */
274 603
275typedef struct archt { 604INTERFACE_CLASS (archetype)
605struct archetype : object
606{
607 static arch_ptr empty; // the empty_archetype
608 MTH static void gc ();
609
610 archetype (const char *name);
611 ~archetype ();
612 void gather_callbacks (AV *&callbacks, event_type event) const;
613
614 MTH static archetype *find (const_utf8_string name);
615
616 MTH void link ();
617 MTH void unlink ();
618
619 MTH object *instance ();
620
621 object_vector_index ACC (RW, archid); // index in archvector
276 const char *name; /* More definite name, like "generate_kobold" */ 622 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
277 struct archt *next; /* Next archetype in a linked list */
278 struct archt *head; /* The main part of a linked object */
279 struct archt *more; /* Next part of a linked object */
280 object clone; /* An object from which to do copy_object() */
281 uint32 editable; /* editable flags (mainly for editor) */
282 sint8 tail_x, tail_y; /* Where the lower right most portion of the object is
283 * in comparison to the head.
284 */
285} archetype;
286 623
624 sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
625 sint8 ACC (RW, max_x), ACC (RW, max_y);
626
627 // support for archetype loading
628 static archetype *read (object_thawer &f);
629 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
630 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
631};
632
633inline void
634object_freezer::put (keyword k, archetype *v)
635{
636 put (k, v ? &v->archname : (const char *)0);
637}
638
639typedef object_vector<object, &object::index > objectvec;
640typedef object_vector<object, &object::active> activevec;
641typedef object_vector<archetype, &archetype::archid> archvec;
642
287extern object *objects; 643extern objectvec objects;
288extern object *active_objects; 644extern activevec actives;
289extern object *free_objects; 645extern archvec archetypes;
290extern object objarray[STARTMAX];
291 646
292extern int nrofallocobjects; 647#define for_all_objects(var) \
293extern int nroffreeobjects; 648 for (unsigned _i = 0; _i < objects.size (); ++_i) \
649 statementvar (object *, var, objects [_i])
294 650
295/* This returns TRUE if the object is somethign that 651#define for_all_actives(var) \
296 * should be displayed in the look window 652 for (unsigned _i = 0; _i < actives.size (); ++_i) \
297 */ 653 statementvar (object *, var, actives [_i])
298#define LOOK_OBJ(ob) (!ob->invisible && ob->type!=PLAYER && ob->type!=EVENT_CONNECTOR) 654
655#define for_all_archetypes(var) \
656 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
657 statementvar (archetype *, var, archetypes [_i])
299 658
300/* Used by update_object to know if the object being passed is 659/* Used by update_object to know if the object being passed is
301 * being added or removed. 660 * being added or removed.
302 */ 661 */
303#define UP_OBJ_INSERT 1 662#define UP_OBJ_INSERT 1
304#define UP_OBJ_REMOVE 2 663#define UP_OBJ_REMOVE 2
305#define UP_OBJ_CHANGE 3 664#define UP_OBJ_CHANGE 3
306#define UP_OBJ_FACE 4 /* Only thing that changed was the face */ 665#define UP_OBJ_FACE 4 /* Only thing that changed was the face */
307 666
308/* These are flags passed to insert_ob_in_map and 667/* These are flags passed to insert_ob_in_map and
309 * insert_ob_in_ob. Note that all flags may not be meaningful 668 * insert_ob_in_ob. Note that all flags may not be meaningful
310 * for both functions. 669 * for both functions.
311 * Most are fairly explanatory: 670 * Most are fairly explanatory:
320 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 679 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
321 * Use for treasure chests so the new object is the highest thing 680 * Use for treasure chests so the new object is the highest thing
322 * beneath the player, but not actually above it. Note - the 681 * beneath the player, but not actually above it. Note - the
323 * map and x,y coordinates for the object to be inserted must 682 * map and x,y coordinates for the object to be inserted must
324 * match the originator. 683 * match the originator.
325 * INS_MAP_LOAD: disable lots of checkings done at insertion to
326 * speed up map loading process, as we assume the ordering in
327 * loaded map is correct.
328 * 684 *
329 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 685 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
330 * are mutually exclusive. The behaviour for passing more than one 686 * are mutually exclusive. The behaviour for passing more than one
331 * should be considered undefined - while you may notice what happens 687 * should be considered undefined - while you may notice what happens
332 * right now if you pass more than one, that could very well change 688 * right now if you pass more than one, that could very well change
333 * in future revisions of the code. 689 * in future revisions of the code.
334 */ 690 */
335#define INS_NO_MERGE 0x0001 691#define INS_NO_MERGE 0x0001
336#define INS_ABOVE_FLOOR_ONLY 0x0002 692#define INS_ABOVE_FLOOR_ONLY 0x0002
337#define INS_NO_WALK_ON 0x0004 693#define INS_NO_WALK_ON 0x0004
338#define INS_ON_TOP 0x0008 694#define INS_ON_TOP 0x0008
339#define INS_BELOW_ORIGINATOR 0x0010 695#define INS_BELOW_ORIGINATOR 0x0010
340#define INS_MAP_LOAD 0x0020
341 696
342#define ARCH_SINGULARITY "singularity"
343#define ARCH_SINGULARITY_LEN 11
344#define ARCH_DETECT_MAGIC "detect_magic"
345#define ARCH_DEPLETION "depletion" 697#define ARCH_DEPLETION "depletion"
346#define ARCH_SYMPTOM "symptom"
347 698
348#endif 699#endif
700

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines