--- deliantra/server/include/object.h 2009/06/27 08:35:03 1.203
+++ deliantra/server/include/object.h 2012/10/29 23:55:53 1.263
@@ -1,75 +1,68 @@
/*
* This file is part of Deliantra, the Roguelike Realtime MMORPG.
- *
- * Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
- * Copyright (©) 2001,2007 Mark Wedel & Crossfire Development Team
- * Copyright (©) 1992,2007 Frank Tore Johansen
- *
- * Deliantra is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
+ *
+ * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
+ * Copyright (©) 2001 Mark Wedel & Crossfire Development Team
+ * Copyright (©) 1992 Frank Tore Johansen
+ *
+ * Deliantra is free software: you can redistribute it and/or modify it under
+ * the terms of the Affero GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see .
- *
+ *
+ * You should have received a copy of the Affero GNU General Public License
+ * and the GNU General Public License along with this program. If not, see
+ * .
+ *
* The authors can be reached via e-mail to
*/
#ifndef OBJECT_H
#define OBJECT_H
-#include
-
#include "cfperl.h"
#include "shstr.h"
-typedef int tag_t;
+//+GPL
-enum {
- body_skill,
- body_combat,
- body_range,
- body_shield,
- body_arm,
- body_torso,
- body_head,
- body_neck,
- body_finger,
- body_shoulder,
- body_foot,
- body_hand,
- body_wrist,
- body_waist,
- NUM_BODY_LOCATIONS
-};
+typedef int tag_t;
-enum slottype_t
+// also see common/item.C
+enum
{
- slot_none,
- slot_combat,
- slot_ranged,
+# define def(name, use, nonuse) body_ ## name,
+# include "slotinc.h"
+# undef def
+ NUM_BODY_LOCATIONS
};
/* See common/item.c */
-typedef struct Body_Locations
+struct Body_Locations
{
- keyword save_name; /* Name used to load/save it to disk */
+ const char *name; /* Short name/identifier */
+ keyword kw; /* Name used to load/save it to disk */
const char *use_name; /* Name used when describing an item we can use */
const char *nonuse_name; /* Name to describe objects we can't use */
-} Body_Locations;
+};
extern Body_Locations body_locations[NUM_BODY_LOCATIONS];
+// for each set of directions (1 == up, 2 == right, 4 == down, 8 == left)
+// contains the wall suffix (0, 1_3, 1_4 and so on).
+extern const char *wall_suffix[16];
+
#define NUM_COINS 4 /* number of coin types */
extern const char *const coins[NUM_COINS + 1];
+// restart server when object_count reaches this value
+#define RESTART_COUNT 0xe0000000
+
/*
* Each object (this also means archetypes!) could have a few of these
* "dangling" from it; this could also end up containing 'parse errors'.
@@ -82,14 +75,67 @@
*/
struct key_value : slice_allocated
{
- key_value *next;
+ key_value *next; // must be first element
shstr key, value;
};
+// "crossfires version of a perl hash."
+struct key_values
+{
+ key_value *first; // must be first element
+
+ bool empty() const
+ {
+ return !first;
+ }
+
+ void clear ();
+ shstr_tmp get (shstr_tmp key) const;
+ void del (shstr_tmp key);
+ void set (shstr_tmp key, shstr_tmp value);
+
+ void add (shstr_tmp key, shstr_tmp value); // liek set, but doesn't check for duplicates
+ void reverse (); // reverses the ordering, to be used after loading an object
+ key_values &operator =(const key_values &kv);
+
+ // custom extra fields management
+ struct access_proxy
+ {
+ key_values &kv;
+ shstr_tmp key;
+
+ access_proxy (key_values &kv, shstr_tmp key)
+ : kv (kv), key (key)
+ {
+ }
+
+ const access_proxy &operator =(shstr_tmp value) const
+ {
+ kv.set (key, value);
+ return *this;
+ }
+
+ operator const shstr_tmp () const { return kv.get (key); }
+ operator const char *() const { return kv.get (key); }
+
+ private:
+ void operator =(int);
+ };
+
+ const access_proxy operator [](shstr_tmp key)
+ {
+ return access_proxy (*this, key);
+ }
+};
+
+//-GPL
+
struct UUID
{
uint64 seq;
+ enum { MAX_LEN = 3 + 16 + 1 + 1 }; // <1. + hex + > + \0
+
static UUID cur; // last uuid generated
static void init ();
static UUID gen ();
@@ -99,28 +145,13 @@
operator uint64() { return seq; }
void operator =(uint64 seq) { this->seq = seq; }
- typedef char BUF [32];
-
- bool parse (const char *s)
- {
- return sscanf (s, "<1.%" SCNx64 ">", &seq) == 1;
- }
-
- const char *c_str (char *buf, int len) const
- {
- snprintf (buf, len, "<1.%" PRIx64 ">", seq);
-
- return buf;
- }
-
- const char *c_str () const
- {
- static BUF buf;
-
- return c_str (buf, sizeof (buf));
- }
+ bool parse (const char *s);
+ char *append (char *buf) const;
+ char *c_str () const;
};
+//+GPL
+
/* Definition for WILL_APPLY values. Replaces having harcoded values
* sprinkled in the code. Note that some of these also replace fields
* that were in the can_apply area. What is the point of having both
@@ -134,8 +165,8 @@
struct body_slot
{
- signed char info:4; /* body info as loaded from the file */
signed char used:4; /* Calculated value based on items equipped */
+ signed char info:4; /* body info as loaded from the file */
};
typedef struct oblnk
@@ -175,9 +206,8 @@
bool ACC (RW, flag[NUM_FLAGS]);
#endif
- shstr ACC (RW, materialname); /* specific material name */
+ materialtype_t *material; // What material this object consists of //TODO, make perl-accessible
shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
-// materialtype_t *ACC (RW, material); /* What material this object consists of */
object_ptr ACC (RW, owner); /* Pointer to the object which controls this one */
object_ptr ACC (RW, enemy); /* Monster/player to follow even if not closest */
object_ptr ACC (RW, attacked_by); /* This object start to attack us! only player & monster */
@@ -222,13 +252,13 @@
sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
uint8 ACC (RW, weapontype); /* type of weapon */
+ body_slot slot [NUM_BODY_LOCATIONS];
+
faceidx ACC (RW, face); /* the graphical face */
faceidx ACC (RW, sound); /* the sound face */
faceidx ACC (RW, sound_destroy); /* played on destroy */
- body_slot slot [NUM_BODY_LOCATIONS];
-
sint32 ACC (RW, weight); /* Attributes of the object */
sint32 ACC (RW, weight_limit);/* Weight-limit of object */
@@ -296,18 +326,34 @@
shstr ACC (RW, custom_name); /* Custom name assigned by player */
};
-const char *query_weight (const object *op);
-const char *query_short_name (const object *op);
-const char *query_name (const object *op);
-const char *query_base_name (const object *op, int plural);
+const_utf8_string query_weight (const object *op);
+const_utf8_string query_short_name (const object *op);
+const_utf8_string query_name (const object *op);
+const_utf8_string query_base_name (const object *op, int plural);
+sint64 query_cost (const object *tmp, object *who, int flag);
+const char *query_cost_string (const object *tmp, object *who, int flag);
+
+int change_ability_duration (object *spell, object *caster);
+int min_casting_level (object *caster, object *spell);
+int casting_level (object *caster, object *spell);
+sint16 SP_level_spellpoint_cost (object *caster, object *spell, int flags);
+int SP_level_dam_adjust (object *caster, object *spob);
+int SP_level_duration_adjust (object *caster, object *spob);
+int SP_level_range_adjust (object *caster, object *spob);
+
+struct freelist_item
+{
+ freelist_item *next;
+ uint32_t count;
+};
-struct object : zero_initialised, object_copy
+struct object : object_copy
{
// These variables are not changed by ->copy_to
maptile *ACC (RW, map); /* Pointer to the map in which this object is present */
UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
- int ACC (RO, count);
+ uint32_t ACC (RO, count);
object_vector_index ACC (RO, index); // index into objects
object_vector_index ACC (RO, active); // index into actives
@@ -319,7 +365,7 @@
object *inv; /* Pointer to the first object in the inventory */
//TODO: container must move into client
- object_ptr ACC (RW, container); /* Current container being used. I think this
+ object_ptr ACC (RW, container);/* Currently opened container. I think this
* is only used by the player right now.
*/
object *ACC (RW, env); /* Pointer to the object which is the environment.
@@ -327,50 +373,27 @@
*/
object *ACC (RW, more); /* Pointer to the rest of a large body of objects */
object *head; /* Points to the main object of a large body */ // NO ACC, perl semantics are different
- client_container *seen_by; // seen by which player/container currently?
- key_value *key_values; /* Fields not explictly known by the loader. */
- // privates / perl
- shstr_tmp kv_get (shstr_tmp key) const;
- void kv_del (shstr_tmp key);
- void kv_set (shstr_tmp key, shstr_tmp value);
-
- // custom extra fields management
- struct key_value_access_proxy
+ MTH void set_flag (int flagnum)
{
- object &ob;
- shstr_tmp key;
-
- key_value_access_proxy (object &ob, shstr_tmp key)
- : ob (ob), key (key)
- {
- }
-
- const key_value_access_proxy &operator =(shstr_tmp value) const
- {
- ob.kv_set (key, value);
- return *this;
- }
-
- operator const shstr_tmp () const { return ob.kv_get (key); }
- operator const char *() const { return ob.kv_get (key); }
-
- private:
- void operator =(int);
- };
+ flag [flagnum] = true;
+ }
- // operator [] is too annoying to use
- const key_value_access_proxy kv (shstr_tmp key)
+ MTH void clr_flag (int flagnum)
{
- return key_value_access_proxy (*this, key);
+ flag [flagnum] = false;
}
+ // extra key value pairs
+ key_values kv;
+
+//-GPL
+
bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
MTH void post_load_check (); // do some adjustments after parsing
static object *read (object_thawer &f, maptile *map = 0); // map argument due to toal design bogosity, must go.
bool write (object_freezer &f);
- MTH int slottype () const;
MTH static object *create ();
const mapxy &operator =(const mapxy &pos);
MTH void copy_to (object *dst);
@@ -387,9 +410,10 @@
// recursively destroy all objects in inventory, optionally dropping them to the ground instead
MTH void destroy_inv (bool drop_to_ground = false);
+ MTH void destroy_inv_fast (); // like destroy_inv (false), but only works when *this is destroyed, too
MTH object *insert (object *item); // insert into inventory
MTH void play_sound (faceidx sound) const;
- MTH void say_msg (const char *msg) const;
+ MTH void say_msg (const_utf8_string msg) const;
void do_remove ();
MTH void remove ()
@@ -407,7 +431,15 @@
insert_at (this, this);
}
- // high-level move functions, return true if successful
+ // high-level move method.
+ // object op is trying to move in direction dir.
+ // originator is typically the same as op, but
+ // can be different if originator is causing op to
+ // move (originator is pushing op)
+ // returns 0 if the object is not able to move to the
+ // desired space, 1 otherwise (in which case we also
+ // move the object accordingly. This function is
+ // very similiar to move_object.
int move (int dir, object *originator);
int move (int dir)
@@ -415,6 +447,9 @@
return move (dir, this);
}
+ // changes move_type to a new value - handles move_on/move_off effects
+ MTH void change_move_type (MoveType mt);
+
static bool can_merge_slow (object *op1, object *op2);
// this is often used in time-critical code, so optimise
@@ -425,11 +460,9 @@
&& can_merge_slow (op1, op2);
}
- MTH void set_owner (object *owner);
+ MTH void set_owner (object_ornull *owner);
MTH void set_speed (float speed);
MTH void set_glow_radius (sint8 rad);
- MTH bool change_weapon (object *ob);
- MTH bool change_skill (object *ob);
MTH void open_container (object *new_container);
MTH void close_container ()
@@ -437,7 +470,22 @@
open_container (0);
}
+ // potential future accessor for "container"
+ MTH object *container_ () const
+ {
+ return container;
+ }
+
+ MTH bool is_open_container () const
+ {
+ // strangely enough, using ?: here causes code to inflate
+ return type == CONTAINER
+ && ((env && env->container_ () == this)
+ || (!env && flag [FLAG_APPLIED]));
+ }
+
MTH object *force_find (shstr_tmp name);
+ MTH void force_set_timer (int duration);
MTH object *force_add (shstr_tmp name, int duration = 0);
oblinkpt *find_link () const;
@@ -463,9 +511,9 @@
MTH void change_luck (int value);
// info must hold 256 * 3 bytes currently
- const char *debug_desc (char *info) const;
- MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
- const char *flag_desc (char *desc, int len) const;
+ const_utf8_string debug_desc (char *info) const;
+ MTH const_utf8_string debug_desc () const; // uses at least 3 round-robin buffers
+ const_utf8_string flag_desc (char *desc, int len) const;
MTH bool decrease (sint32 nr = 1); // returns true if anything is left
MTH object *split (sint32 nr = 1); // return 0 on failure
@@ -483,17 +531,22 @@
MTH void update_weight ();
// return the dominant material of this item, always return something
- const materialtype_t *dominant_material () const;
+ const materialtype_t *dominant_material () const
+ {
+ return material;
+ }
// return the volume of this object in cm³
MTH uint64 volume () const
{
return (uint64)total_weight ()
- * 1000
- * (type == CONTAINER ? 1000 : 1)
- / dominant_material ()->density;
+ * 1024 // 1000 actually
+ * (type == CONTAINER ? 128 : 1)
+ / dominant_material ()->density; // ugh, division
}
+ MTH bool is_arch () const { return this == (const object *)(const archetype *)arch; }
+
MTH bool is_wiz () const { return flag [FLAG_WIZ]; }
MTH bool is_weapon () const { return type == ARROW || type == BOW || type == WEAPON; }
MTH bool is_armor () const { return type == ARMOUR || type == SHIELD || type == HELMET
@@ -508,7 +561,11 @@
&& (subtype == SP_BULLET || subtype == SP_MAGIC_MISSILE)); }
MTH bool is_range () const { return type == BOW || type == ROD || type == WAND || type == HORN; }
- MTH bool has_active_speed () const { return FABS(speed) >= MIN_ACTIVE_SPEED; }
+ MTH bool is_dragon () const;
+
+ MTH bool is_immunity () const { return invisible && type == SIGN; }
+
+ MTH bool has_active_speed () const { return speed >= MIN_ACTIVE_SPEED; }
// temporary: wether the object can be saved in a map file
// contr => is a player
@@ -521,7 +578,15 @@
*/
MTH bool has_random_items () const { return randomitems && !flag [FLAG_IS_A_TEMPLATE]; }
- MTH bool has_dialogue () const { return *&msg == '@'; }
+ static bool msg_has_dialogue (const char *msg) { return *msg == '@'; }
+
+ MTH bool has_dialogue () const { return msg_has_dialogue (&msg); }
+
+ /* need_identify returns true if the item should be identified. This
+ * function really should not exist - by default, any item not identified
+ * should need it.
+ */
+ MTH bool need_identify () const;
// returns the outermost owner, never returns 0
MTH object *outer_owner ()
@@ -535,7 +600,7 @@
}
// returns the outermost environment, never returns 0
- MTH object *outer_env () const
+ MTH object *outer_env_or_self () const
{
const object *op;
@@ -545,11 +610,17 @@
return const_cast