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