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.55 by root, Fri Dec 15 20:08:45 2006 UTC vs.
Revision 1.235 by root, Tue Apr 6 21:11:48 2010 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for X-windows 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 3 *
4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
4 Copyright (C) 2001 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001 Mark Wedel & Crossfire Development Team
5 Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992 Frank Tore Johansen
6 7 *
7 This program is free software; you can redistribute it and/or modify 8 * Deliantra is free software: you can redistribute it and/or modify it under
8 it under the terms of the GNU General Public License as published by 9 * the terms of the Affero GNU General Public License as published by the
9 the Free Software Foundation; either version 2 of the License, or 10 * Free Software Foundation, either version 3 of the License, or (at your
10 (at your option) any later version. 11 * option) any later version.
11 12 *
12 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,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details. 16 * GNU General Public License for more details.
16 17 *
17 You should have received a copy of the GNU General Public License 18 * You should have received a copy of the Affero GNU General Public License
18 along with this program; if not, write to the Free Software 19 * and the GNU General Public License along with this program. If not, see
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * <http://www.gnu.org/licenses/>.
20 21 *
21 The authors can be reached via e-mail at crossfire@schmorp.de 22 * The authors can be reached via e-mail to <support@deliantra.net>
22*/ 23 */
23 24
24#ifndef OBJECT_H 25#ifndef OBJECT_H
25#define OBJECT_H 26#define OBJECT_H
26 27
27#include "cfperl.h" 28#include "cfperl.h"
28#include "shstr.h" 29#include "shstr.h"
29 30
31//+GPL
32
30typedef uint32 tag_t; 33typedef int tag_t;
31#define NUM_BODY_LOCATIONS 12 34
32#define BODY_ARMS 1 35// also see common/item.C
36enum
37{
38 body_skill,
39 body_combat,
40 body_range,
41 body_shield,
42 body_arm,
43 body_torso,
44 body_head,
45 body_neck,
46 body_finger,
47 body_shoulder,
48 body_foot,
49 body_hand,
50 body_wrist,
51 body_waist,
52 NUM_BODY_LOCATIONS
53};
33 54
34/* See common/item.c */ 55/* See common/item.c */
35 56
36typedef struct Body_Locations 57typedef struct Body_Locations
37{ 58{
38 const char *save_name; /* Name used to load/save it to disk */ 59 keyword save_name; /* Name used to load/save it to disk */
39 const char *use_name; /* Name used when describing an item we can use */ 60 const char *use_name; /* Name used when describing an item we can use */
40 const char *nonuse_name; /* Name to describe objects we can't use */ 61 const char *nonuse_name; /* Name to describe objects we can't use */
41} Body_Locations; 62} Body_Locations;
42 63
43extern Body_Locations body_locations[NUM_BODY_LOCATIONS]; 64extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
65
66#define NUM_COINS 4 /* number of coin types */
67extern const char *const coins[NUM_COINS + 1];
44 68
45/* 69/*
46 * Each object (this also means archetypes!) could have a few of these 70 * Each object (this also means archetypes!) could have a few of these
47 * "dangling" from it; this could also end up containing 'parse errors'. 71 * "dangling" from it; this could also end up containing 'parse errors'.
48 * 72 *
49 * key and value are shared-strings. 73 * key and value are shared-strings.
50 * 74 *
51 * Please use get_ob_key_value(), set_ob_key_value() from object.c rather than 75 * Please use kv_get/kv_set/kv_del from object rather than
52 * accessing the list directly. 76 * accessing the list directly.
53 * Exception is if you want to walk this list for some reason. 77 * Exception is if you want to walk this list for some reason.
54 */ 78 */
55struct key_value 79struct key_value : slice_allocated
56{ 80{
57 key_value *next; 81 key_value *next;
58 shstr key, value; 82 shstr key, value;
59}; 83};
60 84
85//-GPL
86
61struct UUID 87struct UUID
62{ 88{
63 uint64 seq; 89 uint64 seq;
90
91 enum { MAX_LEN = 3 + 16 + 1 + 1 }; // <1. + hex + > + \0
92
93 static UUID cur; // last uuid generated
94 static void init ();
95 static UUID gen ();
64 96
65 UUID () { } 97 UUID () { }
66 UUID (uint64 seq) : seq(seq) { } 98 UUID (uint64 seq) : seq(seq) { }
67 operator uint64() { return seq; } 99 operator uint64() { return seq; }
68 void operator =(uint64 seq) { this->seq = seq; } 100 void operator =(uint64 seq) { this->seq = seq; }
101
102 bool parse (const char *s);
103 char *append (char *buf) const;
104 char *c_str () const;
69}; 105};
70 106
71extern void init_uuid (); 107//+GPL
72extern UUID gen_uuid ();
73extern const uint64 UUID_SKIP;
74 108
75/* Definition for WILL_APPLY values. Replaces having harcoded values 109/* Definition for WILL_APPLY values. Replaces having harcoded values
76 * sprinkled in the code. Note that some of these also replace fields 110 * 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 111 * that were in the can_apply area. What is the point of having both
78 * can_apply and will_apply? 112 * can_apply and will_apply?
81#define WILL_APPLY_TREASURE 0x02 115#define WILL_APPLY_TREASURE 0x02
82#define WILL_APPLY_EARTHWALL 0x04 116#define WILL_APPLY_EARTHWALL 0x04
83#define WILL_APPLY_DOOR 0x08 117#define WILL_APPLY_DOOR 0x08
84#define WILL_APPLY_FOOD 0x10 118#define WILL_APPLY_FOOD 0x10
85 119
86/* However, if you're keeping a pointer of some sort, you probably 120struct body_slot
87 * don't just want it copied, so you'll need to add to common/object.C, 121{
88 * e.g. ->copy_to () 122 signed char used:4; /* Calculated value based on items equipped */
89 */ 123 signed char info:4; /* body info as loaded from the file */
124};
90 125
91typedef refptr<object> object_ptr; 126typedef struct oblnk
92typedef refptr<archetype> arch_ptr; 127{ /* Used to link together several objects */
128 object_ptr ob;
129 struct oblnk *next;
130} objectlink;
93 131
132typedef struct oblinkpt
133{ /* Used to link together several object links */
134 struct oblnk *link;
135 struct oblinkpt *next;
136 shstr id; /* Used as connected value in buttons/gates */
137} oblinkpt;
138
139INTERFACE_CLASS (object)
94// these are not being copied 140// these are being copied
95ACC_CLASS (object) 141struct object_copy : attachable
96struct object_keep : refcounted
97{ 142{
143 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
144
145 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
146 uint8 ACC (RW, subtype); /* subtype of object */
147 sint8 ACC (RW, direction); /* Means the object is moving that way. */
148 sint8 ACC (RW, facing); /* Object is oriented/facing that way. */
149
150 shstr ACC (RW, name); /* The name of the object, obviously... */
151 shstr ACC (RW, name_pl); /* The plural name of the object */
152 shstr ACC (RW, title); /* Of foo, etc */
153 shstr ACC (RW, race); /* human, goblin, dragon, etc */
154 shstr ACC (RW, slaying); /* Which race to do double damage to */
155 /* If this is an exit, this is the filename */
156
157 typedef bitset<NUM_FLAGS> flags_t;
158 flags_t flag; /* various flags */
159#if FOR_PERL
160 bool ACC (RW, flag[NUM_FLAGS]);
161#endif
162
163 materialtype_t *material; // What material this object consists of //TODO, make perl-accessible
164 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
165 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
166 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
167 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
168 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
169 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
170 object_ptr ACC (RW, spell); /* Spell that was being cast */
171 object_ptr ACC (RW, current_weapon); /* Pointer to the weapon currently used */
172 arch_ptr ACC (RW, arch); /* Pointer to archetype */
173 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
174
175 float ACC (RW, speed); /* The overall speed of this object */
176 float ACC (RW, speed_left); /* How much speed is left to spend this round */
177
178 sint32 ACC (RW, nrof); /* How many of the objects */
179 /* This next big block is basically used for monsters and equipment */
180 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
181 sint16 ACC (RW, resist[NROFATTACKS]); /* Resistance adjustments for attacks */
182
183 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
184 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
185 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
186 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
187
188 uint16 ACC (RW, materials); /* What materials this object consists of */
189 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
190 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
191 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
192
193 /* Note that the last_.. values are sometimes used for non obvious
194 * meanings by some objects, eg, sp penalty, permanent exp.
195 */
196 sint16 ACC (RW, last_heal); /* Last healed. Depends on constitution */
197 sint16 ACC (RW, last_sp); /* As last_heal, but for spell points */
198 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
199 sint16 ACC (RW, last_eat); /* How long since we last ate */
200
201 sint16 ACC (RW, invisible); /* How much longer the object will be invis */
202 sint16 ACC (RW, level); /* Level of creature or object */
203
204 uint8 ACC (RW, pick_up); /* See crossfire.doc */
205 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
206 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
207 uint8 ACC (RW, weapontype); /* type of weapon */
208
209 body_slot slot [NUM_BODY_LOCATIONS];
210
211 faceidx ACC (RW, face); /* the graphical face */
212
213 faceidx ACC (RW, sound); /* the sound face */
214 faceidx ACC (RW, sound_destroy); /* played on destroy */
215
216 sint32 ACC (RW, weight); /* Attributes of the object */
217 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
218
219 sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
220
221 sint64 ACC (RW, perm_exp); /* Permanent exp */
222 living ACC (RO, stats); /* Str, Con, Dex, etc */
223 /* See the pod/objects.pod for more info about body locations */
224
225 /* Following mostly refers to fields only used for monsters */
226
227 /* Spell related information, may be useful elsewhere
228 * Note that other fields are used - these files are basically
229 * only used in spells.
230 */
231 sint16 ACC (RW, duration); /* How long the spell lasts */
232 uint8 ACC (RW, casting_time); /* time left before spell goes off */
233 uint8 ACC (RW, duration_modifier); /* how level modifies duration */
234
235 uint8 ACC (RW, dam_modifier); /* How going up in level effects damage */
236 sint8 ACC (RW, range); /* Range of the spell */
237 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
238 sint8 ACC (RW, item_power); /* power rating of the object */
239
240 uint8 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
241 MoveType ACC (RW, move_type); /* Type of movement this object uses */
242 MoveType ACC (RW, move_block);/* What movement types this blocks */
243 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
244
245 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */
246 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
247 MoveType ACC (RW, move_slow); /* Movement types this slows down */
248
249 // 8 free bits
250
251 //float ACC (RW, expmul) = 1.0; /* needed experience = (calc_exp*expmul) - means some */
252 // /* races/classes can need less/more exp to gain levels */
253 static const float expmul = 1.0;//D
254 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
255
256 /* Following are values used by any object */
257 /* this objects turns into or what this object creates */
258 treasurelist *ACC (RW, randomitems); /* Items to be generated */
259
260 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
261 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
262 uint8 ACC (RW, will_apply); /* See crossfire.doc */
263 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
264 uint16 ACC (RW, animation_id);/* An index into the animation array */
265 uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
266
267 uint16 ACC (RW, cached_eat); /* cached food, used by esrv_update_spells */
268 uint16 ACC (RW, cached_sp); /* cached spell points used for a spell, used by esrv_update_spells */
269 /* allows different movement patterns for attackers */
270 uint8 ACC (RW, move_status); /* What stage in attack mode */
271 uint8 ACC (RW, attack_movement);/* What kind of attack movement */
272
273 //16+ free bits
274
275 // rarely-accessed members should be at the end
276 shstr ACC (RW, tag); // a tag used to tracking this object
277 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
278 shstr ACC (RW, lore); /* Obscure information about this object, */
279 /* To get put into books and the like. */
280 shstr ACC (RW, custom_name); /* Custom name assigned by player */
281};
282
283const_utf8_string query_weight (const object *op);
284const_utf8_string query_short_name (const object *op);
285const_utf8_string query_name (const object *op);
286const_utf8_string query_base_name (const object *op, int plural);
287sint64 query_cost (const object *tmp, object *who, int flag);
288const char *query_cost_string (const object *tmp, object *who, int flag);
289
290int change_ability_duration (object *spell, object *caster);
291int min_casting_level (object *caster, object *spell);
292int casting_level (object *caster, object *spell);
293sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
294int SP_level_dam_adjust (object *caster, object *spob);
295int SP_level_duration_adjust (object *caster, object *spob);
296int SP_level_range_adjust (object *caster, object *spob);
297
298struct object : zero_initialised, object_copy
299{
98 /* These variables are not changed by ->copy_to */ 300 // These variables are not changed by ->copy_to
301 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
99 302
100 tag_t ACC (RW, count); /* Generation count for this object */
101 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc. 303 UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
304 int ACC (RO, count);
305 object_vector_index ACC (RO, index); // index into objects
306 object_vector_index ACC (RO, active); // index into actives
102 307
103 player *ACC (RW, contr); /* Pointer to the player which control this object */ 308 player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
104 object *ACC (RW, next); /* Pointer to the next object in the free/used list */ 309
105 object *ACC (RW, prev); /* Pointer to the previous object in the free/used list */
106 object *ACC (RW, active_next);/* Next & previous object in the 'active' */
107 object *ACC (RW, 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 object *ACC (RW, below); /* Pointer to the object stacked below this one */ 310 object *ACC (RW, below); /* Pointer to the object stacked below this one */
111 object *ACC (RW, above); /* Pointer to the object stacked above this one */ 311 object *ACC (RW, above); /* Pointer to the object stacked above this one */
112 /* Note: stacked in the *same* environment */ 312 /* Note: stacked in the *same* environment */
113 object *inv; /* Pointer to the first object in the inventory */ 313 object *inv; /* Pointer to the first object in the inventory */
314
315 //TODO: container must move into client
114 object *ACC (RW, container); /* Current container being used. I think this 316 object_ptr ACC (RW, container);/* Currently opened container. I think this
115 * is only used by the player right now. 317 * is only used by the player right now.
116 */ 318 */
117 object *ACC (RW, env); /* Pointer to the object which is the environment. 319 object *ACC (RW, env); /* Pointer to the object which is the environment.
118 * This is typically the container that the object is in. 320 * This is typically the container that the object is in.
119 */ 321 */
120 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */ 322 object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
121 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different 323 object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
122 maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
123};
124
125// these are being copied
126struct object_copy : attachable<object>
127{
128 shstr ACC (RW, name); /* The name of the object, obviously... */
129 shstr ACC (RW, name_pl); /* The plural name of the object */
130 shstr ACC (RW, title); /* Of foo, etc */
131 shstr ACC (RW, race); /* human, goblin, dragon, etc */
132 shstr ACC (RW, slaying); /* Which race to do double damage to */
133 /* If this is an exit, this is the filename */
134 shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
135 shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
136 shstr ACC (RW, lore); /* Obscure information about this object, */
137 /* To get put into books and the like. */
138 shstr ACC (RW, materialname); /* specific material name */
139 shstr ACC (RW, custom_name); /* Custom name assigned by player */
140 object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
141 object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
142 object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
143 object_ptr ACC (RW, chosen_skill); /* the skill chosen to use */
144 object_ptr ACC (RW, spellitem); /* Spell ability monster is choosing to use */
145 object_ptr ACC (RW, spell); /* Spell that was being cast */
146 object_ptr ACC (RW, current_weapon); /* Pointer to the weapon currently used */
147};
148
149// these are being copied and also cleared
150struct object_pod
151{
152 New_Face *ACC (RW, face); /* Face with colors */
153 sint16 ACC (RW, x), ACC (RW, y); /* Position in the map for this object */
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 sint8 ACC (RW, direction); /* Means the object is moving that way. */
158 sint8 ACC (RW, facing); /* Object is oriented/facing that way. */
159
160 /* This next big block are basically used for monsters and equipment */
161 uint8 ACC (RW, type); /* PLAYER, BULLET, etc. See define.h */
162 uint8 ACC (RW, subtype); /* subtype of object */
163 uint16 ACC (RW, client_type); /* Public type information. see doc/Developers/objects */
164 sint16 resist[NROFATTACKS]; /* Resistance adjustments for attacks */
165 uint32 ACC (RW, attacktype); /* Bitmask of attacks this object does */
166 uint32 ACC (RW, path_attuned);/* Paths the object is attuned to */
167 uint32 ACC (RW, path_repelled); /* Paths the object is repelled from */
168 uint32 ACC (RW, path_denied); /* Paths the object is denied access to */
169 uint16 ACC (RW, material); /* What materials this object consist of */
170 sint8 ACC (RW, magic); /* Any magical bonuses to this item */
171 uint8 ACC (RW, state); /* How the object was last drawn (animation) */
172 sint32 ACC (RW, value); /* How much money it is worth (or contains) */
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 ACC (RW, last_heal); /* Last healed. Depends on constitution */
177 sint32 ACC (RW, last_sp); /* As last_heal, but for spell points */
178 sint16 ACC (RW, last_grace); /* as last_sp, except for grace */
179 sint16 ACC (RW, last_eat); /* How long since we last ate */
180 sint16 ACC (RW, invisible); /* How much longer the object will be invis */
181 sint16 ACC (RW, level); /* Level of creature or object */
182 uint8 ACC (RW, pick_up); /* See crossfire.doc */
183 sint8 ACC (RW, item_power); /* power rating of the object */
184 sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
185 sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
186 sint32 ACC (RW, weight); /* Attributes of the object */
187 sint32 ACC (RW, weight_limit);/* Weight-limit of object */
188 sint32 ACC (RW, carrying); /* How much weight this object contains */
189 sint64 ACC (RW, perm_exp); /* Permanent exp */
190 uint32 ACC (RW, weapontype); /* type of weapon */
191 uint32 ACC (RW, 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 living ACC (RO, stats); /* Str, Con, Dex, etc */
195 /* See the doc/Developers/objects for more info about body locations */
196
197 /* Following mostly refers to fields only used for monsters */
198 uint32 ACC (RW, hide); /* The object is hidden, not invisible */
199 /* changes made by kholland@sunlab.cit.cornell.edu */
200 /* allows different movement patterns for attackers */
201 sint32 ACC (RW, move_status); /* What stage in attack mode */
202 uint16 ACC (RW, attack_movement); /* What kind of attack movement */
203 uint16 ACC (RW, run_away); /* Monster runs away if it's hp goes below this percentage. */
204 float ACC (RW, expmul); /* needed experience = (calc_exp*expmul) - means some */
205 /* races/classes can need less/more exp to gain levels */
206
207 /* Spell related information, may be useful elsewhere
208 * Note that other fields are used - these files are basically
209 * only used in spells.
210 */
211 sint16 ACC (RW, duration); /* How long the spell lasts */
212 sint16 ACC (RW, casting_time);/* time left before spell goes off */
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 sint8 ACC (RW, range); /* Range of the spell */
217 uint8 ACC (RW, range_modifier); /* How going up in level effects range */
218 char *ACC (RW, spellarg);
219
220 /* Following are values used by any object */
221 treasurelist *ACC (RW, randomitems); /* Items to be generated */
222 arch_ptr ACC (RW, arch); /* Pointer to archetype */
223 arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
224 key_value *key_values; /* Fields not explictly known by the loader. */ 324 key_value *key_values; /* Fields not explictly known by the loader. */
225 /* this objects turns into or what this object creates */
226 uint32 flags[4]; /* various flags */
227 uint16 ACC (RW, animation_id);/* An index into the animation array */
228 uint8 ACC (RW, anim_speed); /* ticks between animation-frames */
229 uint8 ACC (RW, last_anim); /* last sequence used to draw face */
230 sint32 ACC (RW, elevation); /* elevation of this terrain - not currently used */
231 uint8 ACC (RW, smoothlevel); /* how to smooth this square around */
232 uint8 ACC (RW, will_apply); /* See crossfire.doc */
233 325
234 MoveType ACC (RW, move_type); /* Type of movement this object uses */ 326 // privates / perl
235 MoveType ACC (RW, move_block);/* What movement types this blocks */ 327 shstr_tmp kv_get (shstr_tmp key) const;
236 MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */ 328 void kv_del (shstr_tmp key);
237 MoveType ACC (RW, move_on); /* Move types affected moving on to this space */ 329 void kv_set (shstr_tmp key, shstr_tmp value);
238 MoveType ACC (RW, move_off); /* Move types affected moving off this space */
239 MoveType ACC (RW, move_slow); /* Movement types this slows down */
240 float ACC (RW, move_slow_penalty); /* How much this slows down the object */
241};
242 330
243struct object : zero_initialised, object_keep, object_copy, object_pod 331//-GPL
244{
245 typedef unordered_vector<object *> vector;
246 332
247 static vector mortals; 333 // custom extra fields management
248 static vector active; // active objects, not yet used 334 struct key_value_access_proxy
249 static vector objects; // not used yet, use first->next->... 335 {
250 static object *first; // will be replaced by "objects" 336 object &ob;
337 shstr_tmp key;
251 338
339 key_value_access_proxy (object &ob, shstr_tmp key)
340 : ob (ob), key (key)
341 {
342 }
343
344 const key_value_access_proxy &operator =(shstr_tmp value) const
345 {
346 ob.kv_set (key, value);
347 return *this;
348 }
349
350 operator const shstr_tmp () const { return ob.kv_get (key); }
351 operator const char *() const { return ob.kv_get (key); }
352
353 private:
354 void operator =(int);
355 };
356
357 // operator [] is too annoying to use
358 const key_value_access_proxy kv (shstr_tmp key)
359 {
360 return key_value_access_proxy (*this, key);
361 }
362
363 bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
364 MTH void post_load_check (); // do some adjustments after parsing
365 static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
366 bool write (object_freezer &f);
367
252 static object *create (); 368 MTH static object *create ();
369 const mapxy &operator =(const mapxy &pos);
253 void copy_to (object *dst); 370 MTH void copy_to (object *dst);
254 object *clone (); // create + copy_to 371 MTH object *clone (); // create + copy_to a single object
255 void destroy (bool destroy_inventory = false); 372 MTH object *deep_clone (); // copy whole more chain and inventory
256 void remove (); 373 void do_destroy ();
374 void gather_callbacks (AV *&callbacks, event_type event) const;
375 MTH void destroy ();
376 MTH void drop_and_destroy ()
377 {
378 destroy_inv (true);
379 destroy ();
380 }
381
382 // recursively destroy all objects in inventory, optionally dropping them to the ground instead
383 MTH void destroy_inv (bool drop_to_ground = false);
257 object *insert (object *item); // insert into inventory 384 MTH object *insert (object *item); // insert into inventory
385 MTH void play_sound (faceidx sound) const;
386 MTH void say_msg (const_utf8_string msg) const;
258 387
259 static void free_mortals (); 388 void do_remove ();
389 MTH void remove ()
390 {
391 if (!flag [FLAG_REMOVED])
392 do_remove ();
393 }
394
395 MTH bool blocked (maptile *m, int x, int y) const;
396
397 void move_to (const mapxy &pos)
398 {
399 remove ();
400 *this = pos;
401 insert_at (this, this);
402 }
403
404 // high-level move method.
405 // object op is trying to move in direction dir.
406 // originator is typically the same as op, but
407 // can be different if originator is causing op to
408 // move (originator is pushing op)
409 // returns 0 if the object is not able to move to the
410 // desired space, 1 otherwise (in which case we also
411 // move the object accordingly. This function is
412 // very similiar to move_object.
413 int move (int dir, object *originator);
414
415 int move (int dir)
416 {
417 return move (dir, this);
418 }
419
420 // changes move_type to a new value - handles move_on/move_off effects
421 MTH void change_move_type (MoveType mt);
422
260 static bool can_merge_slow (object *op1, object *op2); 423 static bool can_merge_slow (object *op1, object *op2);
261 424
262 // this is often used in time-critical code, so optimise 425 // this is often used in time-critical code, so optimise
263 static bool can_merge (object *op1, object *op2) 426 MTH static bool can_merge (object *op1, object *op2)
264 { 427 {
265 return op1->value == op2->value 428 return op1->value == op2->value
266 && op1->name == op2->name 429 && op1->name == op2->name
267 && can_merge_slow (op1, op2); 430 && can_merge_slow (op1, op2);
268 } 431 }
269 432
270 void clear ();
271
272 bool destroyed () { return QUERY_FLAG (this, FLAG_FREED); }
273
274 void set_owner (object *owner); 433 MTH void set_owner (object *owner);
434 MTH void set_speed (float speed);
435 MTH void set_glow_radius (sint8 rad);
436 MTH bool change_skill (object *ob); // deprecated?
275 437
438 MTH void open_container (object *new_container);
439 MTH void close_container ()
440 {
441 open_container (0);
442 }
443
444 // potential future accessor for "container"
445 MTH object *container_ () const
446 {
447 return container;
448 }
449
450 MTH bool is_open_container () const
451 {
452 // strangely enough, using ?: here causes code to inflate
453 return type == CONTAINER
454 && ((env && env->container_ () == this)
455 || (!env && flag [FLAG_APPLIED]));
456 }
457
458 MTH object *force_find (shstr_tmp name);
459 MTH void force_set_timer (int duration);
460 MTH object *force_add (shstr_tmp name, int duration = 0);
461
462 oblinkpt *find_link () const;
463 MTH void add_link (maptile *map, shstr_tmp id);
464 MTH void remove_link ();
465
466 // overwrite the attachable should_invoke function with a version that also checks ev_want_type
467 bool should_invoke (event_type event)
468 {
469 return ev_want_event [event] || ev_want_type [type] || cb;
470 }
471
276 void instantiate () 472 MTH void instantiate ();
277 {
278 if (!uuid.seq) // HACK
279 uuid = gen_uuid ();
280 473
281 attachable<object>::instantiate (); 474 // recalculate all stats
282 } 475 MTH void update_stats ();
476 MTH void roll_stats ();
477 MTH void swap_stats (int a, int b);
478 MTH void add_statbonus ();
479 MTH void remove_statbonus ();
480 MTH void drain_stat ();
481 MTH void drain_specific_stat (int deplete_stats);
482 MTH void change_luck (int value);
283 483
284 // info must hold 256 * 3 bytes currently 484 // info must hold 256 * 3 bytes currently
285 const char *debug_desc (char *info) const; 485 const_utf8_string debug_desc (char *info) const;
286 const char *debug_desc () const; 486 MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
487 const_utf8_string flag_desc (char *desc, int len) const;
488
489 MTH bool decrease (sint32 nr = 1); // returns true if anything is left
490 MTH object *split (sint32 nr = 1); // return 0 on failure
491
492 MTH int number_of () const
493 {
494 return nrof ? nrof : 1;
495 }
496
497 MTH sint32 total_weight () const
498 {
499 return (weight + carrying) * number_of ();
500 }
501
502 MTH void update_weight ();
503
504 // return the dominant material of this item, always return something
505 const materialtype_t *dominant_material () const
506 {
507 return material;
508 }
509
510 // return the volume of this object in cm³
511 MTH uint64 volume () const
512 {
513 return (uint64)total_weight ()
514 * 1024 // 1000 actually
515 * (type == CONTAINER ? 128 : 1)
516 / dominant_material ()->density; // ugh, division
517 }
518
519 MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; }
520
521 MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
522 MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
523 MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
524 || type == CLOAK || type == BOOTS || type == GLOVES
525 || type == BRACERS || type == GIRDLE; }
526 MTH bool is_alive () const { return (type == PLAYER
527 || flag [FLAG_MONSTER]
528 || (flag [FLAG_ALIVE] && !flag [FLAG_GENERATOR] && type != DOOR))
529 && !flag [FLAG_IS_A_TEMPLATE]; }
530 MTH bool is_arrow () const { return type == ARROW
531 || (type == SPELL_EFFECT
532 && (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
533 MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
534
535 MTH bool is_dragon () const;
536
537 MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
538
539 // temporary: wether the object can be saved in a map file
540 // contr => is a player
541 // head => only save head of a multitile object
542 // owner => can not reference owner yet
543 MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
544
545 /* This return true if object has still randomitems which
546 * could be expanded.
547 */
548 MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
549
550 static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
551
552 MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
553
554 // returns the outermost owner, never returns 0
555 MTH object *outer_owner ()
556 {
557 object *op;
558
559 for (op = this; op->owner; op = op->owner)
560 ;
561
562 return op;
563 }
564
565 // returns the outermost environment, never returns 0
566 MTH object *outer_env_or_self () const
567 {
568 const object *op;
569
570 for (op = this; op->env; op = op->env)
571 ;
572
573 return const_cast<object *>(op);
574 }
575
576 // returns the outermost environment, may return 0
577 MTH object *outer_env () const
578 {
579 return env ? outer_env_or_self () : 0;
580 }
581
582 // returns the player that has this object in his inventory, or 0
583 // we assume the player is always the outer env
584 MTH object *in_player () const
585 {
586 object *op = outer_env_or_self ();
587
588 return op->type == PLAYER ? op : 0;
589 }
590
591 // "temporary" helper function
592 MTH object *head_ () const
593 {
594 return head ? head : const_cast<object *>(this);
595 }
596
597 MTH bool is_head () const
598 {
599 return head_ () == this;
600 }
601
602 MTH bool is_on_map () const
603 {
604 return !env && !flag [FLAG_REMOVED];
605 }
606
607 MTH bool is_inserted () const
608 {
609 return !flag [FLAG_REMOVED];
610 }
611
612 MTH bool is_player () const
613 {
614 return !!contr;
615 }
616
617 /* elmex: this method checks whether the object is in a shop */
618 MTH bool is_in_shop () const;
619
620 MTH bool affects_los () const
621 {
622 return glow_radius || flag [FLAG_BLOCKSVIEW];
623 }
624
625 MTH bool has_carried_lights () const
626 {
627 return glow_radius;
628 }
629
630 // returns the player that cna see this object, if any
631 MTH object *visible_to () const;
632
633 MTH std::string long_desc (object *who = 0); // query_name . " " . describe
634 MTH std::string describe_monster (object *who = 0);
635 MTH std::string describe_item (object *who = 0);
636 MTH std::string describe (object *who = 0); // long description, without name
637
638 MTH const_utf8_string query_weight () { return ::query_weight (this); }
639 MTH const_utf8_string query_name () { return ::query_name (this); }
640 MTH const_utf8_string query_short_name () { return ::query_short_name (this); }
641 MTH const_utf8_string query_base_name (bool plural) { return ::query_base_name (this, plural); }
642
643 // If this object has no extra parts but should have them,
644 // add them, effectively expanding heads into multipart
645 // objects. This method only works on objects not inserted
646 // anywhere.
647 MTH void expand_tail ();
648
649 MTH void create_treasure (treasurelist *tl, int flags = 0);
650
651 // insert object at same map position as 'where'
652 // handles both inventory and map "positions"
653 MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
654 // check whether we can put this into the map, respect max_nrof, max_volume, max_items
655 MTH bool can_drop_at (maptile *m, int x, int y, object *originator = 0);
656 MTH void drop_unpaid_items ();
657
658 MTH void activate ();
659 MTH void deactivate ();
660 MTH void activate_recursive ();
661 MTH void deactivate_recursive ();
662
663 // set the given flag on all objects in the inventory recursively
664 MTH void set_flag_inv (int flag, int value = 1);
665
666 void enter_exit (object *exit);//Perl
667 MTH void enter_map (maptile *newmap, int x, int y);
668 void player_goto (const_utf8_string path, int x, int y); // only for players
669 MTH bool apply (object *ob, int aflags = AP_APPLY); // ob may be 0
670
671 // returns the mapspace this object is in
672 mapspace &ms () const;
287 673
288 // fully recursive iterator 674 // fully recursive iterator
289 struct iterator_base 675 struct iterator_base
290 { 676 {
291 object *item; 677 object *item;
298 operator object *() const { return item; } 684 operator object *() const { return item; }
299 685
300 object *operator ->() const { return item; } 686 object *operator ->() const { return item; }
301 object &operator * () const { return *item; } 687 object &operator * () const { return *item; }
302 }; 688 };
689
690 MTH unsigned int random_seed () const
691 {
692 return (unsigned int)uuid.seq;
693 }
303 694
304 // depth-first recursive iterator 695 // depth-first recursive iterator
305 struct depth_iterator : iterator_base 696 struct depth_iterator : iterator_base
306 { 697 {
307 depth_iterator (object *container); 698 depth_iterator (object *container);
318 object *end () 709 object *end ()
319 { 710 {
320 return this; 711 return this;
321 } 712 }
322 713
714 /* This returns TRUE if the object is something that
715 * a client might want to know about.
716 */
717 MTH bool client_visible () const
718 {
719 return !invisible && type != PLAYER;
720 }
721
722 // the client does nrof * this weight
723 MTH sint32 client_weight () const
724 {
725 return weight + carrying;
726 }
727
728 MTH struct region *region () const;
729
730 void statusmsg (const_utf8_string msg, int color = NDI_BLACK);
731 void failmsg (const_utf8_string msg, int color = NDI_RED);
732
733 const_utf8_string query_inventory (object *who = 0, const_utf8_string indent = "");
734
735 MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
736 static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
737
738 // make some noise with given item into direction dir,
739 // currently only used for players to make them temporarily visible
740 // when they are invisible.
741 MTH void make_noise ();
742
743 /* animation */
744 MTH bool has_anim () const { return animation_id; }
745 const animation &anim () const { return animations [animation_id]; }
746 MTH faceidx get_anim_frame (int frame) const { return anim ().faces [frame]; }
747 MTH void set_anim_frame (int frame) { face = get_anim_frame (frame); }
748 /* anim_frames () returns the number of animations allocated. The last
749 * usuable animation will be anim_frames () - 1 (for example, if an object
750 * has 8 animations, anim_frames () will return 8, but the values will
751 * range from 0 through 7.
752 */
753 MTH int anim_frames () const { return anim ().num_animations; }
754 MTH int anim_facings () const { return anim ().facings; }
755
756 MTH utf8_string as_string ();
757
323protected: 758protected:
324 friend struct archetype;
325
326 void link (); 759 void link ();
327 void unlink (); 760 void unlink ();
328 761
329 object (); 762 object ();
330 ~object (); 763 ~object ();
764
765private:
766 object &operator =(const object &);
767 object (const object &);
331}; 768};
332 769
333typedef struct oblnk 770// move this object to the top of its env's inventory to speed up
334{ /* Used to link together several objects */ 771// searches for it.
335 object_ptr ob; 772static inline object *
336 struct oblnk *next; 773splay (object *ob)
337} objectlink; 774{
775 if (ob->above && ob->env)
776 {
777 if (ob->above) ob->above->below = ob->below;
778 if (ob->below) ob->below->above = ob->above;
338 779
339typedef struct oblinkpt 780 ob->above = 0;
340{ /* Used to link together several object links */ 781 ob->below = ob->env->inv;
341 struct oblnk *link; 782 ob->below->above = ob;
342 long value; /* Used as connected value in buttons/gates */ 783 ob->env->inv = ob;
343 struct oblinkpt *next; 784 }
344} oblinkpt; 785
786 return ob;
787}
788
789//+GPL
790
791object *find_skill_by_name_fuzzy (object *who, const_utf8_string name);
792object *find_skill_by_name (object *who, shstr_cmp sh);
793object *find_skill_by_number (object *who, int skillno);
345 794
346/* 795/*
347 * The archetype structure is a set of rules on how to generate and manipulate 796 * The archetype structure is a set of rules on how to generate and manipulate
348 * objects which point to archetypes. 797 * objects which point to archetypes.
349 * This probably belongs in arch.h, but there really doesn't appear to 798 * This probably belongs in arch.h, but there really doesn't appear to
350 * be much left in the archetype - all it really is is a holder for the 799 * be much left in the archetype - all it really is is a holder for the
351 * object and pointers. This structure should get removed, and just replaced 800 * object and pointers. This structure should get removed, and just replaced
352 * by the object structure 801 * by the object structure
353 */ 802 */
354 803
804//-GPL
805
355ACC_CLASS (archetype) 806INTERFACE_CLASS (archetype)
356struct archetype : zero_initialised, refcounted 807struct archetype : object
357{ 808{
358 archetype (); 809 static arch_ptr empty; // the empty_archetype
810 MTH static void gc ();
811
812 archetype (const_utf8_string name);
359 ~archetype (); 813 ~archetype ();
814 void gather_callbacks (AV *&callbacks, event_type event) const;
360 815
361 static archetype *find (const char *arch); 816 MTH static archetype *find (const_utf8_string name);
362 817
363 void hash_add (); // add to hastable 818 MTH void link ();
364 void hash_del (); // remove from hashtable 819 MTH void unlink ();
365 820
821 MTH static object *get (const_utf8_string name); // (find() || singularity)->instance()
822 MTH object *instance ();
823
824 MTH void post_load_check (); // do some adjustments after parsing
825
826 object_vector_index ACC (RW, archid); // index in archvector
366 shstr ACC (RW, name); /* More definite name, like "generate_kobold" */ 827 shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
367 struct archetype *ACC (RW, next); /* Next archetype in a linked list */ 828
368 struct archetype *ACC (RW, head); /* The main part of a linked object */ 829 sint8 ACC (RW, max_x); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
369 struct archetype *ACC (RW, more); /* Next part of a linked object */ 830
370 object ACC (RO, clone); /* An object from which to do ->copy_to () */ 831 // support for archetype loading
371 uint32 ACC (RW, editable); /* editable flags (mainly for editor) */ 832 static archetype *read (object_thawer &f);
372 sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is 833 MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
373 * in comparison to the head. 834 static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
374 */
375}; 835};
376 836
837// returns whether the object is a dragon player, which are often specialcased
838inline bool
839object::is_dragon () const
840{
841 return arch->race == shstr_dragon && is_player ();
842}
843
844inline void
845object_freezer::put (const keyword_string k, archetype *v)
846{
847 if (expect_true (v))
848 put (k, v->archname);
849 else
850 put (k);
851}
852
853typedef object_vector<object, &object::index > objectvec;
854typedef object_vector<object, &object::active> activevec;
855typedef object_vector<archetype, &archetype::archid> archvec;
856
377extern object *objects; 857extern objectvec objects;
378extern object *active_objects; 858extern activevec actives;
859extern archvec archetypes;
379 860
380extern int nrofallocobjects; 861// "safely" iterate over inv in a way such that the current item is removable
862// quite horrible, that's why its hidden in some macro
863#define for_inv_removable(op,var) \
864 for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
381 865
382/* This returns TRUE if the object is something that 866#define for_all_objects(var) \
383 * should be displayed in the look window 867 for (unsigned _i = 0; _i < objects.size (); ++_i) \
384 */ 868 statementvar (object *, var, objects [_i])
385#define LOOK_OBJ(ob) (!ob->invisible && ob->type!=PLAYER && ob->type!=EVENT_CONNECTOR) 869
870#define for_all_actives(var) \
871 for (unsigned _i = 0; _i < actives.size (); ++_i) \
872 statementvar (object *, var, actives [_i])
873
874#define for_all_archetypes(var) \
875 for (unsigned _i = 0; _i < archetypes.size (); ++_i) \
876 statementvar (archetype *, var, archetypes [_i])
877
878//+GPL
386 879
387/* Used by update_object to know if the object being passed is 880/* Used by update_object to know if the object being passed is
388 * being added or removed. 881 * being added or removed.
389 */ 882 */
390#define UP_OBJ_INSERT 1 883#define UP_OBJ_INSERT 1
407 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator - 900 * INS_BELOW_ORIGINATOR: Insert new object immediately below originator -
408 * Use for treasure chests so the new object is the highest thing 901 * Use for treasure chests so the new object is the highest thing
409 * beneath the player, but not actually above it. Note - the 902 * beneath the player, but not actually above it. Note - the
410 * map and x,y coordinates for the object to be inserted must 903 * map and x,y coordinates for the object to be inserted must
411 * match the originator. 904 * match the originator.
412 * INS_MAP_LOAD: disable lots of checkings done at insertion to
413 * speed up map loading process, as we assume the ordering in
414 * loaded map is correct.
415 * 905 *
416 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY 906 * Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
417 * are mutually exclusive. The behaviour for passing more than one 907 * are mutually exclusive. The behaviour for passing more than one
418 * should be considered undefined - while you may notice what happens 908 * should be considered undefined - while you may notice what happens
419 * right now if you pass more than one, that could very well change 909 * right now if you pass more than one, that could very well change
422#define INS_NO_MERGE 0x0001 912#define INS_NO_MERGE 0x0001
423#define INS_ABOVE_FLOOR_ONLY 0x0002 913#define INS_ABOVE_FLOOR_ONLY 0x0002
424#define INS_NO_WALK_ON 0x0004 914#define INS_NO_WALK_ON 0x0004
425#define INS_ON_TOP 0x0008 915#define INS_ON_TOP 0x0008
426#define INS_BELOW_ORIGINATOR 0x0010 916#define INS_BELOW_ORIGINATOR 0x0010
427#define INS_MAP_LOAD 0x0020
428 917
429#define ARCH_SINGULARITY "singularity" 918//-GPL
430#define ARCH_SINGULARITY_LEN 11
431#define ARCH_DETECT_MAGIC "detect_magic"
432#define ARCH_DEPLETION "depletion"
433#define ARCH_SYMPTOM "symptom"
434 919
435#endif 920#endif
436 921

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines