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.13 by root, Thu Aug 31 09:19:34 2006 UTC vs.
Revision 1.149 by root, Mon Sep 10 12:44:06 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines