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.2 by elmex, Wed Feb 22 18:01:58 2006 UTC vs.
Revision 1.130 by root, Mon Jun 4 13:04:00 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines