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.114 by root, Thu May 3 09:26:45 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines