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.5 by root, Fri Aug 25 17:11:53 2006 UTC vs.
Revision 1.125 by root, Sat May 19 00:08:11 2007 UTC

1/* 1/*
2 * static char *rcsid_object_h = 2 * CrossFire, A Multiplayer Online RPG
3 * "$Id: object.h,v 1.5 2006/08/25 17:11:53 root Exp $"; 3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
5 * Copyright (C) 2001 Mark Wedel & Crossfire Development Team
6 * Copyright (C) 1992 Frank Tore Johansen
7 *
8 * This program 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 2 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, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 *
22 * The authors can be reached via e-mail at 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 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 */ 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
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 112/* 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, 113 * don't just want it copied, so you'll need to add to common/object.C,
91 * e.g. copy-object 114 * e.g. ->copy_to ()
92 *
93 * I've tried to clean up this structure a bit (in terms of formatting)
94 * by making it more consistent. I've also tried to locate some of the fields
95 * more logically together (put the item related ones together, the monster
96 * related ones, etc.
97 * This structure is best viewed with about a 100 width screen.
98 * MSW 2002-07-05
99 */ 115 */
100 116
101struct object_simple { 117struct body_slot
118{
119 signed char info:4; /* body info as loaded from the file */
120 signed char used:4; /* Calculated value based on items equipped */
121};
122
123INTERFACE_CLASS (object)
124// these are being copied
125struct object_copy : attachable
126{
127 typedef bitset<NUM_FLAGS> flags_t;
128
129 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
130
131 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
132 uint8 ACC (RW, subtype); /* subtype of object */
133 sint8 ACC (RW, direction); /* Means the object is moving that way. */
134 sint8 ACC (RW, facing); /* Object is oriented/facing that way. */
135
136 shstr ACC (RW, name); /* The name of the object, obviously... */
137 shstr ACC (RW, name_pl); /* The plural name of the object */
138 shstr ACC (RW, title); /* Of foo, etc */
139 shstr ACC (RW, race); /* human, goblin, dragon, etc */
140 shstr ACC (RW, slaying); /* Which race to do double damage to */
141 /* If this is an exit, this is the filename */
142 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
143 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
144 shstr ACC (RW, lore); /* Obscure information about this object, */
145 /* To get put into books and the like. */
146 shstr ACC (RW, materialname); /* specific material name */
147 shstr ACC (RW, custom_name); /* Custom name assigned by player */
148// materialtype_t *ACC (RW, material); /* What material this object consists of */
149 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
150 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
151 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
152 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
153 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
154 object_ptr ACC (RW, spell); /* Spell that was being cast */
155 object_ptr ACC (RW, current_weapon); /* Pointer to the weapon currently used */
156 arch_ptr ACC (RW, arch); /* Pointer to archetype */
157 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
158
159 float ACC (RW, speed); /* The overall speed of this object */
160 float ACC (RW, speed_left); /* How much speed is left to spend this round */
161 uint32 ACC (RW, nrof); /* How many of the objects */
162
163 /* This next big block are basically used for monsters and equipment */
164 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
165
166 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
167 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
168 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
169 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
170 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
171 uint16 ACC (RW, materials); /* What materials this object consists of */
172 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
173 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
174 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
175 /* Note that the last_.. values are sometimes used for non obvious
176 * meanings by some objects, eg, sp penalty, permanent exp.
177 */
178 sint32 ACC (RW, last_heal); /* Last healed. Depends on constitution */
179 sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */
180 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
181 sint16 ACC (RW, last_eat); /* How long since we last ate */
182 sint16 ACC (RW, invisible); /* How much longer the object will be invis */
183 sint16 ACC (RW, level); /* Level of creature or object */
184 uint8 ACC (RW, pick_up); /* See crossfire.doc */
185 sint8 ACC (RW, item_power); /* power rating of the object */
186 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
187 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
188 sint32 ACC (RW, weight); /* Attributes of the object */
189 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
190 sint32 ACC (RW, carrying); /* How much weight this object contains */
191 sint64 ACC (RW, perm_exp); /* Permanent exp */
192 uint32 ACC (RW, weapontype); /* type of weapon */
193 uint32 ACC (RW, tooltype); /* type of tool or build facility */
194 body_slot slot [NUM_BODY_LOCATIONS];
195 faceidx ACC (RW, face); /* Face with colors */
196 living ACC (RO, stats); /* Str, Con, Dex, etc */
197 /* See the pod/objects.pod for more info about body locations */
198
199 /* Following mostly refers to fields only used for monsters */
200 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
201
202 /* allows different movement patterns for attackers */
203 sint32 ACC (RW, move_status); /* What stage in attack mode */
204 uint16 ACC (RW, attack_movement); /* What kind of attack movement */
205 uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
206 float ACC (RW, expmul); /* needed experience = (calc_exp*expmul) - means some */
207 /* races/classes can need less/more exp to gain levels */
208
209 /* Spell related information, may be useful elsewhere
210 * Note that other fields are used - these files are basically
211 * only used in spells.
212 */
213 sint16 ACC (RW, duration); /* How long the spell lasts */
214 sint16 ACC (RW, casting_time);/* time left before spell goes off */
215
216 uint16 ACC (RW, start_holding);
217 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
218 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
219
220 sint8 ACC (RW, range); /* Range of the spell */
221 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
222 MoveType ACC (RW, move_type); /* Type of movement this object uses */
223 MoveType ACC (RW, move_block);/* What movement types this blocks */
224
225 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
226 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
227 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
228 MoveType ACC (RW, move_slow); /* Movement types this slows down */
229
230 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
231
232 char *ACC (RW, spellarg);
233
234 /* Following are values used by any object */
235 /* this objects turns into or what this object creates */
236 treasurelist *ACC (RW, randomitems); /* Items to be generated */
237 flags_t flag; /* various flags */
238#if FOR_PERL
239 bool ACC (RW, flag[NUM_FLAGS]);
240#endif
241 uint16 ACC (RW, animation_id);/* An index into the animation array */
242 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
243 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
244 sint16 ACC (RW, elevation); /* elevation of this terrain - not currently used */
245 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
246 uint8 ACC (RW, will_apply); /* See crossfire.doc */
247};
248
249struct object : zero_initialised, object_copy
250{
102 /* These variables are not changed by copy_object() */ 251 // These variables are not changed by ->copy_to
252 maptile_ptr ACC (RW, map); /* Pointer to the map in which this object is present */
253
254 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
255 int ACC (RO, count);
256 int ACC (RO, index); // index into objects
257 int ACC (RO, active); // index into actives
258
103 struct pl *contr; /* Pointer to the player which control this object */ 259 player_ptr ACC (RW, contr); /* Pointer to the player which control this object */
104 struct object *next; /* Pointer to the next object in the free/used list */ 260
105 struct object *prev; /* Pointer to the previous object in the free/used list*/
106 struct object *active_next; /* Next & previous object in the 'active' */
107 struct object *active_prev; /* List. This is used in process_events */
108 /* so that the entire object list does not */
109 /* need to be gone through. */
110 struct object *below; /* Pointer to the object stacked below this one */ 261 object *ACC (RW, below); /* Pointer to the object stacked below this one */
111 struct object *above; /* Pointer to the object stacked above this one */ 262 object *ACC (RW, above); /* Pointer to the object stacked above this one */
112 /* Note: stacked in the *same* environment*/ 263 /* Note: stacked in the *same* environment */
113 struct object *inv; /* Pointer to the first object in the inventory */ 264 object *inv; /* Pointer to the first object in the inventory */
265
266 //TODO: container must move into client
114 struct object *container; /* Current container being used. I think this 267 object_ptr ACC (RW, container); /* Current container being used. I think this
115 * is only used by the player right now. 268 * is only used by the player right now.
116 */ 269 */
117 struct object *env; /* Pointer to the object which is the environment. 270 object *ACC (RW, env); /* Pointer to the object which is the environment.
118 * This is typically the container that the object is in. 271 * This is typically the container that the object is in.
119 */ 272 */
120 struct object *more; /* Pointer to the rest of a large body of objects */ 273 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
121 struct object *head; /* Points to the main object of a large body */ 274 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
122 struct mapstruct *map; /* Pointer to the map in which this object is present */ 275 client_container *seen_by; // seen by which player/container currently?
123
124 tag_t count; /* Unique object number for this object */
125 uint16 refcount; /* How many objects points to this object */
126};
127
128struct object_special {
129 /* These get an extra add_refcount(), after having been copied by memcpy().
130 * All fields beow this point are automatically copied by memcpy. If
131 * adding something that needs a refcount updated, make sure you modify
132 * copy_object to do so. Everything below here also gets cleared
133 * by clear_object()
134 */
135 const char *name; /* The name of the object, obviously... */
136 const char *name_pl; /* The plural name of the object */
137 const char *title; /* Of foo, etc */
138 const char *race; /* human, goblin, dragon, etc */
139 const char *slaying; /* Which race to do double damage to */
140 /* If this is an exit, this is the filename */
141 const char *skill; /* Name of the skill this object uses/grants */
142 const char *msg; /* If this is a book/sign/magic mouth/etc */
143 const char *lore; /* Obscure information about this object, */
144 /* To get put into books and the like. */
145
146 sint16 x,y; /* Position in the map for this object */
147 sint16 ox,oy; /* For debugging: Where it was last inserted */
148 float speed; /* The overall speed of this object */
149 float speed_left; /* How much speed is left to spend this round */
150 uint32 nrof; /* How many of the objects */
151 New_Face *face; /* Face with colors */
152 sint8 direction; /* Means the object is moving that way. */
153 sint8 facing; /* Object is oriented/facing that way. */
154
155 /* This next big block are basically used for monsters and equipment */
156 uint8 type; /* PLAYER, BULLET, etc. See define.h */
157 uint8 subtype; /* subtype of object */
158 uint16 client_type; /* Public type information. see doc/Developers/objects */
159 sint16 resist[NROFATTACKS]; /* Resistance adjustments for attacks */
160 uint32 attacktype; /* Bitmask of attacks this object does */
161 uint32 path_attuned; /* Paths the object is attuned to */
162 uint32 path_repelled; /* Paths the object is repelled from */
163 uint32 path_denied; /* Paths the object is denied access to */
164 uint16 material; /* What materials this object consist of */
165 const char *materialname; /* specific material name */
166 sint8 magic; /* Any magical bonuses to this item */
167 uint8 state; /* How the object was last drawn (animation) */
168 sint32 value; /* How much money it is worth (or contains) */
169 sint16 level; /* Level of creature or object */
170 /* Note that the last_.. values are sometimes used for non obvious
171 * meanings by some objects, eg, sp penalty, permanent exp.
172 */
173 sint32 last_heal; /* Last healed. Depends on constitution */
174 sint32 last_sp; /* As last_heal, but for spell points */
175 sint16 last_grace; /* as last_sp, except for grace */
176 sint16 last_eat; /* How long since we last ate */
177 sint16 invisible; /* How much longer the object will be invis */
178 uint8 pick_up; /* See crossfire.doc */
179 sint8 item_power; /* power rating of the object */
180 sint8 gen_sp_armour; /* sp regen penalty this object has (was last_heal)*/
181 sint32 weight; /* Attributes of the object */
182 sint32 weight_limit; /* Weight-limit of object */
183 sint32 carrying; /* How much weight this object contains */
184 sint8 glow_radius; /* indicates the glow radius of the object */
185 living stats; /* Str, Con, Dex, etc */
186 sint64 perm_exp; /* Permanent exp */
187 const char *current_weapon_script; /* The script of the currently used weapon. Executed */
188 /* each time the object attacks something */
189 struct object *current_weapon; /* Pointer to the weapon currently used */
190 uint32 weapontype; /* type of weapon */
191 uint32 tooltype; /* type of tool or build facility */
192 sint8 body_info[NUM_BODY_LOCATIONS]; /* body info as loaded from the file */
193 sint8 body_used[NUM_BODY_LOCATIONS]; /* Calculated value based on items equipped */
194 /* See the doc/Developers/objects for more info about body locations */
195
196 /* Following mostly refers to fields only used for monsters */
197 struct object *owner; /* Pointer to the object which controls this one */
198 /* Owner should not be referred to directly - */
199 /* get_owner should be used instead. */
200 tag_t ownercount; /* What count the owner had (in case owner */
201 /* has been freed) */
202 struct object *enemy; /* Monster/player to follow even if not closest */
203 struct object *attacked_by; /* This object start to attack us! only player & monster */
204 tag_t attacked_by_count; /* the tag of attacker, so we can be sure */
205 struct treasureliststruct *randomitems; /* Items to be generated */
206 uint16 run_away; /* Monster runs away if it's hp goes below this percentage. */
207 struct object *chosen_skill; /* the skill chosen to use */
208 uint32 hide; /* The object is hidden, not invisible */
209 /* changes made by kholland@sunlab.cit.cornell.edu */
210 /* allows different movement patterns for attackers */
211 sint32 move_status; /* What stage in attack mode */
212 uint16 attack_movement;/* What kind of attack movement */
213 uint8 will_apply; /* See crossfire.doc */
214 struct object *spellitem; /* Spell ability monster is choosing to use */
215 double expmul; /* needed experience = (calc_exp*expmul) - means some */
216 /* races/classes can need less/more exp to gain levels */
217
218 /* Spell related information, may be useful elsewhere
219 * Note that other fields are used - these files are basically
220 * only used in spells.
221 */
222 sint16 duration; /* How long the spell lasts */
223 uint8 duration_modifier; /* how level modifies duration */
224 sint16 casting_time; /* time left before spell goes off */
225 struct object *spell; /* Spell that was being cast */
226 uint16 start_holding;
227 char *spellarg;
228 uint8 dam_modifier; /* How going up in level effects damage */
229 sint8 range; /* Range of the spell */
230 uint8 range_modifier; /* How going up in level effects range */
231
232 /* Following are values used by any object */
233 struct archt *arch; /* Pointer to archetype */
234 struct archt *other_arch; /* Pointer used for various things - mostly used for what */
235 /* this objects turns into or what this object creates */
236 uint32 flags[4]; /* various flags */
237 uint16 animation_id; /* An index into the animation array */
238 uint8 anim_speed; /* ticks between animation-frames */
239 uint8 last_anim; /* last sequence used to draw face */
240 sint32 elevation; /* elevation of this terrain - not currently used */
241 uint8 smoothlevel; /* how to smooth this square around*/
242
243 MoveType move_type; /* Type of movement this object uses */
244 MoveType move_block; /* What movement types this blocks */
245 MoveType move_allow; /* What movement types explicitly allowd */
246 MoveType move_on; /* Move types affected moving on to this space */
247 MoveType move_off; /* Move types affected moving off this space */
248 MoveType move_slow; /* Movement types this slows down */
249 float move_slow_penalty; /* How much this slows down the object */
250
251 event *events;
252
253 const char *custom_name; /* Custom name assigned by player */
254 key_value *key_values; /* Fields not explictly known by the loader. */ 276 key_value *key_values; /* Fields not explictly known by the loader. */
255};
256 277
257struct object : object_special, object_simple { 278 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
258 void *self, *cb; // CF+ perl's self and callback registry 279 void post_load_check (); // do some adjustments after parsing
259}; 280 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
281 bool write (object_freezer &f);
260 282
261typedef struct oblnk { /* Used to link together several objects */ 283 MTH int slottype () const;
284 MTH static object *create ();
285 object &operator =(const object &src);
286 MTH void copy_to (object *dst);
287 MTH object *clone (); // create + copy_to
288 void do_destroy ();
289 void gather_callbacks (AV *&callbacks, event_type event) const;
290 MTH void destroy (bool destroy_inventory = false);
291
292 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
293 MTH void destroy_inv (bool drop_to_ground = false);
294 MTH object *insert (object *item); // insert into inventory
295 void do_remove ();
296 MTH void remove ()
297 {
298 if (!flag [FLAG_REMOVED])
299 do_remove ();
300 }
301
302 static bool can_merge_slow (object *op1, object *op2);
303
304 // this is often used in time-critical code, so optimise
305 MTH static bool can_merge (object *op1, object *op2)
306 {
307 return op1->value == op2->value
308 && op1->name == op2->name
309 && can_merge_slow (op1, op2);
310 }
311
312 MTH void set_owner (object *owner);
313 MTH void set_speed (float speed);
314 MTH bool change_weapon (object *ob);
315 MTH bool change_skill (object *ob);
316
317 MTH void open_container (object *new_container);
318 MTH void close_container ()
319 {
320 open_container (0);
321 }
322
323 // overwrite the attachable invoke function with a version that also checks ev_want_type
324 bool invoke (event_type event, ...)
325 {
326 if (ev_want_event [event] || ev_want_type [type] || cb)
327 {
328 va_list ap;
329 va_start (ap, event);
330 vinvoke (event, ap);
331 va_end (ap);
332 }
333 }
334
335 MTH void instantiate ();
336
337 // recalculate all stats
338 MTH void update_stats ();
339 MTH void roll_stats ();
340 MTH void swap_stats (int a, int b);
341 MTH void add_statbonus ();
342 MTH void remove_statbonus ();
343 MTH void drain_stat ();
344 MTH void drain_specific_stat (int deplete_stats);
345 MTH void change_luck (int value);
346
347 // info must hold 256 * 3 bytes currently
348 const char *debug_desc (char *info) const;
349 MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
350 const char *flag_desc (char *desc, int len) const;
351
352 int number_of () const
353 {
354 return nrof ? nrof : 1;
355 }
356
357 uint64 total_weight () const
358 {
359 return weight * number_of ();
360 }
361
362 // return the dominant material of this item, always return something
363 const materialtype_t *dominant_material () const;
364
365 // return the volume of this object in cm³
366 uint64 volume () const
367 {
368 return total_weight ()
369 * 1000
370 * (type == CONTAINER ? 1000 : 1)
371 / dominant_material ()->density;
372 }
373
374 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
375 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
376 || type == CLOAK || type == BOOTS || type == GLOVES
377 || type == BRACERS || type == GIRDLE; }
378 MTH bool is_alive () const { return (type == PLAYER
379 || flag [FLAG_MONSTER]
380 || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR))
381 && !flag [FLAG_IS_A_TEMPLATE]; }
382 MTH bool is_arrow () const { return type == ARROW
383 || (type == SPELL_EFFECT
384 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
385 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
386
387 MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; }
388
389 // temporary: wether the object can be saved in a map file
390 // contr => is a player
391 // head => only save head of a multitile object
392 // owner => can not reference owner yet
393 MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; }
394
395 /* This return true if object has still randomitems which
396 * could be expanded.
397 */
398 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
399
400 // returns the player that has this object in his inventory, or 0
401 MTH object *in_player () const
402 {
403 for (object *op = env; op; op = op->env)
404 if (op->type == PLAYER)
405 return op;
406
407 return 0;
408 }
409
410 // "temporary" helper function
411 MTH object *head_ ()
412 {
413 return head ? head : this;
414 }
415
416 MTH std::string long_desc (object *who = 0);
417 MTH std::string describe_monster (object *who = 0);
418 MTH std::string describe_item (object *who = 0);
419 MTH std::string describe (object *who = 0);
420
421 // If this object has no extra parts but should have them,
422 // add them, effectively expanding heads into multipart
423 // objects. This method only works on objects not inserted
424 // anywhere.
425 MTH void expand_tail ();
426
427 MTH void create_treasure (treasurelist *tl, int flags = 0);
428
429 // insert object at same map position as 'where'
430 // handles both inventory and map "positions"
431 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
432
433 MTH void activate ();
434 MTH void deactivate ();
435 MTH void activate_recursive ();
436 MTH void deactivate_recursive ();
437
438 // set the givne flag on all objects in the inventory recursively
439 MTH void set_flag_inv (int flag, int value = 1);
440
441 void enter_exit (object *exit);//Perl
442 MTH void enter_map (maptile *newmap, int x, int y);
443
444 // returns the mapspace this object is in
445 mapspace &ms () const;
446
447 // fully recursive iterator
448 struct iterator_base
449 {
450 object *item;
451
452 iterator_base (object *container)
453 : item (container)
454 {
455 }
456
457 operator object *() const { return item; }
458
459 object *operator ->() const { return item; }
460 object &operator * () const { return *item; }
461 };
462
463 MTH unsigned int random_seed () const
464 {
465 return (unsigned int)uuid.seq;
466 }
467
468 // depth-first recursive iterator
469 struct depth_iterator : iterator_base
470 {
471 depth_iterator (object *container);
472 void next ();
473 object *operator ++( ) { next (); return item; }
474 object *operator ++(int) { object *i = item; next (); return i; }
475 };
476
477 object *begin ()
478 {
479 return this;
480 }
481
482 object *end ()
483 {
484 return this;
485 }
486
487 /* This returns TRUE if the object is something that
488 * should be displayed in the floorbox/inventory window
489 */
490 MTH bool client_visible () const
491 {
492 return !invisible && type != PLAYER;
493 }
494
495 MTH struct region *region () const;
496
497protected:
498 friend struct archetype;
499
500 void link ();
501 void unlink ();
502
262 object *ob; 503 object ();
504 ~object ();
505};
506
507// move this object to the top of its env's inventory to speed up
508// searches for it.
509static object *
510splay (object *ob)
511{
512 if (ob->env && ob->env->inv != ob)
513 {
514 if (ob->above) ob->above->below = ob->below;
515 if (ob->below) ob->below->above = ob->above;
516
517 ob->above = 0;
518 ob->below = ob->env->inv;
519 ob->below->above = ob;
520 ob->env->inv = ob;
521 }
522
523 return ob;
524}
525
526typedef object_vector<object, &object::index > objectvec;
527typedef object_vector<object, &object::active> activevec;
528
529extern objectvec objects;
530extern activevec actives;
531
532#define for_all_objects(var) \
533 for (unsigned _i = 0; _i < objects.size (); ++_i) \
534 declvar (object *, var, objects [_i])
535
536#define for_all_actives(var) \
537 for (unsigned _i = 0; _i < actives.size (); ++_i) \
538 declvar (object *, var, actives [_i])
539
540typedef struct oblnk
541{ /* Used to link together several objects */
542 object_ptr ob;
263 struct oblnk *next; 543 struct oblnk *next;
264 tag_t id;
265} objectlink; 544} objectlink;
266 545
267typedef struct oblinkpt { /* Used to link together several object links */ 546typedef struct oblinkpt
547{ /* Used to link together several object links */
268 struct oblnk *link; 548 struct oblnk *link;
269 long value; /* Used as connected value in buttons/gates */ 549 long value; /* Used as connected value in buttons/gates */
270 struct oblinkpt *next; 550 struct oblinkpt *next;
271} oblinkpt; 551} oblinkpt;
552
553object *find_skill_by_name (object *who, const char *name);
554object *find_skill_by_name (object *who, const shstr &sh);
555object *find_skill_by_number (object *who, int skillno);
272 556
273/* 557/*
274 * The archetype structure is a set of rules on how to generate and manipulate 558 * The archetype structure is a set of rules on how to generate and manipulate
275 * objects which point to archetypes. 559 * objects which point to archetypes.
276 * This probably belongs in arch.h, but there really doesn't appear to 560 * This probably belongs in arch.h, but there really doesn't appear to
277 * be much left in the archetype - all it really is is a holder for the 561 * be much left in the archetype - all it really is is a holder for the
278 * object and pointers. This structure should get removed, and just replaced 562 * object and pointers. This structure should get removed, and just replaced
279 * by the object structure 563 * by the object structure
280 */ 564 */
281 565
282typedef struct archt { 566INTERFACE_CLASS (archetype)
567struct archetype : zero_initialised, attachable
568{
569 archetype ();
570 ~archetype ();
571 void gather_callbacks (AV *&callbacks, event_type event) const;
572
573 static archetype *read (object_thawer &f);
574 static archetype *get (const char *name); // find or create
575 static archetype *find (const char *name);
576
577 void hash_add (); // add to hashtable
578 void hash_del (); // remove from hashtable
579
283 const char *name; /* More definite name, like "generate_kobold" */ 580 shstr ACC (RW, name); /* More definite name, like "generate_kobold" */
284 struct archt *next; /* Next archetype in a linked list */ 581 struct archetype *ACC (RW, next); /* Next archetype in a linked list */
285 struct archt *head; /* The main part of a linked object */ 582 struct archetype *ACC (RW, head); /* The main part of a linked object */
286 struct archt *more; /* Next part of a linked object */ 583 struct archetype *ACC (RW, more); /* Next part of a linked object */
287 object clone; /* An object from which to do copy_object() */ 584 object ACC (RO, clone); /* An object from which to do ->copy_to () */
288 uint32 editable; /* editable flags (mainly for editor) */ 585 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
586 bool ACC (RW, linked); // linked into list of heads
289 sint8 tail_x, tail_y; /* Where the lower right most portion of the object is 587 sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is
290 * in comparison to the head. 588 * in comparison to the head.
291 */ 589 */
292} archetype; 590};
293
294extern object *objects;
295extern object *active_objects;
296extern object *free_objects;
297extern object objarray[STARTMAX];
298
299extern int nrofallocobjects;
300extern int nroffreeobjects;
301
302/* This returns TRUE if the object is somethign that
303 * should be displayed in the look window
304 */
305#define LOOK_OBJ(ob) (!ob->invisible && ob->type!=PLAYER && ob->type!=EVENT_CONNECTOR)
306 591
307/* Used by update_object to know if the object being passed is 592/* Used by update_object to know if the object being passed is
308 * being added or removed. 593 * being added or removed.
309 */ 594 */
310#define UP_OBJ_INSERT 1 595#define UP_OBJ_INSERT 1
311#define UP_OBJ_REMOVE 2 596#define UP_OBJ_REMOVE 2
312#define UP_OBJ_CHANGE 3 597#define UP_OBJ_CHANGE 3
313#define UP_OBJ_FACE 4 /* Only thing that changed was the face */ 598#define UP_OBJ_FACE 4 /* Only thing that changed was the face */
314 599
315/* These are flags passed to insert_ob_in_map and 600/* These are flags passed to insert_ob_in_map and
316 * insert_ob_in_ob. Note that all flags may not be meaningful 601 * insert_ob_in_ob. Note that all flags may not be meaningful
317 * for both functions. 602 * for both functions.
318 * Most are fairly explanatory: 603 * Most are fairly explanatory:
337 * are mutually exclusive. The behaviour for passing more than one 622 * are mutually exclusive. The behaviour for passing more than one
338 * should be considered undefined - while you may notice what happens 623 * should be considered undefined - while you may notice what happens
339 * right now if you pass more than one, that could very well change 624 * right now if you pass more than one, that could very well change
340 * in future revisions of the code. 625 * in future revisions of the code.
341 */ 626 */
342#define INS_NO_MERGE 0x0001 627#define INS_NO_MERGE 0x0001
343#define INS_ABOVE_FLOOR_ONLY 0x0002 628#define INS_ABOVE_FLOOR_ONLY 0x0002
344#define INS_NO_WALK_ON 0x0004 629#define INS_NO_WALK_ON 0x0004
345#define INS_ON_TOP 0x0008 630#define INS_ON_TOP 0x0008
346#define INS_BELOW_ORIGINATOR 0x0010 631#define INS_BELOW_ORIGINATOR 0x0010
347#define INS_MAP_LOAD 0x0020 632#define INS_MAP_LOAD 0x0020
348 633
349#define ARCH_SINGULARITY "singularity" 634#define ARCH_SINGULARITY "singularity"
350#define ARCH_SINGULARITY_LEN 11
351#define ARCH_DETECT_MAGIC "detect_magic" 635#define ARCH_DETECT_MAGIC "detect_magic"
352#define ARCH_DEPLETION "depletion" 636#define ARCH_DEPLETION "depletion"
353#define ARCH_SYMPTOM "symptom" 637#define ARCH_SYMPTOM "symptom"
354 638
355extern void (*object_free_callback)(object *ob); // called for every object_free
356
357#endif 639#endif
640

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines