[ViewVC] Diff of: cvs/deliantra/server/include/object.h

Comparing deliantra/server/include/object.h (file contents):
Revision 1.188 by root, Sun Nov 16 03:52:12 2008 UTC vs.
Revision 1.217 by root, Sun Nov 8 22:28:10 2009 UTC

 /*
  * This file is part of Deliantra, the Roguelike Realtime MMORPG.
  *
- * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
+ * 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
+ * Deliantra is free software: you can redistribute it and/or modify it under
- * it under the terms of the GNU General Public License as published by
+ * the terms of the Affero GNU General Public License as published by the
- * the Free Software Foundation, either version 3 of the License, or
+ * Free Software Foundation, either version 3 of the License, or (at your
- * (at your option) any later version.
+ * 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
+ * You should have received a copy of the Affero GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * and the GNU General Public License along with this program. If not, see
+ * <http://www.gnu.org/licenses/>.
  *
  * The authors can be reached via e-mail to <support@deliantra.net>
  */
 #ifndef OBJECT_H
 #include <bitset>
 #include "cfperl.h"
 #include "shstr.h"
+//+GPL
 typedef int tag_t;
 enum {
   body_skill,
 {
   key_value *next;
   shstr key, value;
 };
+//-GPL
 struct UUID
 {
   uint64 seq;
   static UUID cur; // last uuid generated
     static BUF buf;
     return c_str (buf, sizeof (buf));
   }
 };
+//+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
  * can_apply and will_apply?
 #define WILL_APPLY_DOOR         0x08
 #define WILL_APPLY_FOOD         0x10
 struct body_slot
 {
+  signed char used:4;	/* Calculated value based on items equipped */
   signed char info:4;	/* body info as loaded from the file */
-  signed char used:4;	/* Calculated value based on items equipped */
 };
+typedef struct oblnk
+{				/* Used to link together several objects */
+  object_ptr ob;
+  struct oblnk *next;
+} objectlink;
+typedef struct oblinkpt
+{				/* Used to link together several object links */
+  struct oblnk *link;
+  struct oblinkpt *next;
+  shstr id;			/* Used as connected value in buttons/gates */
+} oblinkpt;
 INTERFACE_CLASS (object)
 // these are being copied
 struct object_copy : attachable
 {
   arch_ptr ACC (RW, arch);	/* Pointer to archetype */
   arch_ptr ACC (RW, other_arch);/* Pointer used for various things - mostly used for what */
   float ACC (RW, speed);	/* The overall speed of this object */
   float ACC (RW, speed_left);	/* How much speed is left to spend this round */
   sint32 ACC (RW, nrof);	/* How many of the objects */
   /* This next big block is basically used for monsters and equipment */
   uint16 ACC (RW, client_type);	/* Public type information.  see doc/Developers/objects */
   sint16 ACC (RW, resist[NROFATTACKS]);	/* Resistance adjustments for attacks */
   uint32 ACC (RW, attacktype);	/* Bitmask of attacks this object does */
   uint32 ACC (RW, path_denied);	/* Paths the object is denied access to */
   uint16 ACC (RW, materials);	/* What materials this object consists of */
   sint8 ACC (RW, magic);	/* Any magical bonuses to this item */
   uint8 ACC (RW, state);	/* How the object was last drawn (animation) */
   sint32 ACC (RW, value);	/* How much money it is worth (or contains) */
   /* Note that the last_.. values are sometimes used for non obvious
    * meanings by some objects, eg, sp penalty, permanent exp.
    */
-  sint32 ACC (RW, last_heal);	/* Last healed. Depends on constitution */
+  sint16 ACC (RW, last_heal);	/* Last healed. Depends on constitution */
-  sint32 ACC (RW, last_sp);	/* As last_heal, but for spell points */
+  sint16 ACC (RW, last_sp);	/* As last_heal, but for spell points */
   sint16 ACC (RW, last_grace);	/* as last_sp, except for grace */
   sint16 ACC (RW, last_eat);	/* How long since we last ate */
   sint16 ACC (RW, invisible);	/* How much longer the object will be invis */
   sint16 ACC (RW, level);	/* Level of creature or object */
   uint8 ACC (RW, pick_up);	/* See crossfire.doc */
   sint8 ACC (RW, gen_sp_armour);/* sp regen penalty this object has (was last_heal) */
   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 */
   sint32 ACC (RW, carrying);	/* How much weight this object contains, must be 0 if nrof == 0 */
   sint64 ACC (RW, perm_exp);	/* Permanent exp */
   living ACC (RO, stats);	/* Str, Con, Dex, etc */
   /* See the pod/objects.pod for more info about body locations */
   /* Following mostly refers to fields only used for monsters */
-  /* allows different movement patterns for attackers */
-  sint32 ACC (RW, move_status);	/* What stage in attack mode */
-  uint16 ACC (RW, attack_movement);	/* What kind of attack movement */
-  uint16 ACC (RW, run_away);	/* Monster runs away if it's hp goes below this percentage. */
-  float ACC (RW, expmul);	/* needed experience = (calc_exp*expmul) - means some */
-				/* races/classes can need less/more exp to gain levels */
   /* Spell related information, may be useful elsewhere
    * Note that other fields are used - these files are basically
    * only used in spells.
    */
   sint16 ACC (RW, duration);	/* How long the spell lasts */
-  sint16 ACC (RW, casting_time);/* time left before spell goes off */
+  uint8 ACC (RW, casting_time); /* time left before spell goes off */
   uint8 ACC (RW, duration_modifier);	/* how level modifies duration */
   uint8 ACC (RW, dam_modifier);	/* How going up in level effects damage */
   sint8 ACC (RW, range);	/* Range of the spell */
   uint8 ACC (RW, range_modifier);	/* How going up in level effects range  */
+  sint8 ACC (RW, item_power);	/* power rating of the object */
+  uint8 ACC (RW, run_away);	/* Monster runs away if it's hp goes below this percentage. */
   MoveType ACC (RW, move_type);	/* Type of movement this object uses */
   MoveType ACC (RW, move_block);/* What movement types this blocks */
   MoveType ACC (RW, move_allow);/* What movement types explicitly allowd */
   MoveType ACC (RW, move_on);	/* Move types affected moving on to this space */
   MoveType ACC (RW, move_off);	/* Move types affected moving off this space */
   MoveType ACC (RW, move_slow);	/* Movement types this slows down */
-  sint8 ACC (RW, item_power);	/* power rating of the object */
   // 8 free bits
+  //float ACC (RW, expmul) = 1.0;	/* needed experience = (calc_exp*expmul) - means some */
+  //                                    /* races/classes can need less/more exp to gain levels */
+  static const float expmul = 1.0;//D
   float ACC (RW, move_slow_penalty);	/* How much this slows down the object */
-  char *ACC (RW, spellarg);
   /* Following are values used by any object */
   /* this objects turns into or what this object creates */
   treasurelist *ACC (RW, randomitems);	/* Items to be generated */
-  uint16 ACC (RW, animation_id);/* An index into the animation array */
-  uint8 ACC (RW, anim_speed);	/* ticks between animation-frames */
   uint8 ACC (RW, last_anim);	/* last sequence used to draw face */
   uint8 ACC (RW, smoothlevel);	/* how to smooth this square around */
   uint8 ACC (RW, will_apply);	/* See crossfire.doc */
+  uint8 ACC (RW, anim_speed);	/* ticks between animation-frames */
+  uint16 ACC (RW, animation_id);/* An index into the animation array */
+  uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
+  uint16 ACC (RW, cached_eat);  /* cached food, used by esrv_update_spells */
   uint16 ACC (RW, cached_sp);   /* cached spell points used for a spell, used by esrv_update_spells */
+  /* allows different movement patterns for attackers */
+  uint8 ACC (RW, move_status);	/* What stage in attack mode */
+  uint8 ACC (RW, attack_movement);/* What kind of attack movement */
-  uint16 ACC (RW, cached_grace);/* cached grace points used for a spell, used by esrv_update_spells */
+  //16+ free bits
-  uint16 ACC (RW, cached_eat);  /* cached food, used by esrv_update_spells */
   // rarely-accessed members should be at the end
   shstr ACC (RW, tag);          // a tag used to tracking this object
   shstr ACC (RW, msg);		/* If this is a book/sign/magic mouth/etc */
   shstr ACC (RW, lore);		/* Obscure information about this object, */
 				/* To get put into books and the like. */
   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);
 struct object : zero_initialised, object_copy
 {
   // These variables are not changed by ->copy_to
   maptile *ACC (RW, map);	/* Pointer to the map in which this object is present */
   object *ACC (RW, above);	/* Pointer to the object stacked above this one */
                                 /* Note: stacked in the *same* environment */
   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.
 				 * This is typically the container that the object is in.
 				 */
   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
-  const shstr &kv_get (const shstr &key) const;
+  shstr_tmp kv_get (shstr_tmp key) const;
-  void kv_del (const shstr &key);
+  void kv_del (shstr_tmp key);
-  void kv_set (const shstr &key, const shstr &value);
+  void kv_set (shstr_tmp key, shstr_tmp value);
+//-GPL
   // custom extra fields management
   struct key_value_access_proxy
   {
     object &ob;
-    shstr key;
+    shstr_tmp key;
-    key_value_access_proxy (object &ob, const shstr &key)
+    key_value_access_proxy (object &ob, shstr_tmp key)
     : ob (ob), key (key)
     {
     }
-    const key_value_access_proxy &operator =(const shstr &value) const
+    const key_value_access_proxy &operator =(shstr_tmp value) const
     {
       ob.kv_set (key, value);
       return *this;
     }
-    operator const shstr &() const { return ob.kv_get (key); }
+    operator const shstr_tmp () const { return ob.kv_get (key); }
-    operator const char  *() const { return ob.kv_get (key); }
+    operator const char     *() const { return ob.kv_get (key); }
   private:
     void operator =(int);
   };
   // operator [] is too annoying to use
-  const key_value_access_proxy kv (const shstr &key)
+  const key_value_access_proxy kv (shstr_tmp key)
   {
     return key_value_access_proxy (*this, key);
   }
   bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
   }
   // recursively destroy all objects in inventory, optionally dropping them to the ground instead
   MTH void destroy_inv (bool drop_to_ground = false);
   MTH object *insert (object *item); // insert into inventory
-  MTH void play_sound (faceidx sound);
+  MTH void play_sound (faceidx sound) const;
+  MTH void say_msg (const char *msg) const;
   void do_remove ();
   MTH void remove ()
   {
     if (!flag [FLAG_REMOVED])
     remove ();
     *this = pos;
     insert_at (this, this);
   }
+  // high-level move functions, return true if successful
+  int move (int dir, object *originator);
+  int move (int dir)
+  {
+    return move (dir, this);
+  }
   static bool can_merge_slow (object *op1, object *op2);
   // this is often used in time-critical code, so optimise
   MTH static bool can_merge (object *op1, object *op2)
   {
         && can_merge_slow (op1, op2);
   }
   MTH void set_owner (object *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 ()
   {
     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 (const shstr name);
+  MTH object *force_find (shstr_tmp name);
+  MTH void force_set_timer (int duration);
-  MTH void force_add (const shstr name, int duration = 0);
+  MTH object *force_add (shstr_tmp name, int duration = 0);
+  oblinkpt *find_link () const;
+  MTH void add_link (maptile *map, shstr_tmp id);
+  MTH void remove_link ();
   // overwrite the attachable should_invoke function with a version that also checks ev_want_type
   bool should_invoke (event_type event)
   {
     return ev_want_event [event] || ev_want_type [type] || cb;
   const materialtype_t *dominant_material () const;
   // return the volume of this object in cm³
   MTH uint64 volume () const
   {
-    return total_weight ()
+    return (uint64)total_weight ()
            * 1000
            * (type == CONTAINER ? 1000 : 1)
            / dominant_material ()->density;
   }
+  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
                                     || type == CLOAK   || type == BOOTS  || type == GLOVES
   MTH bool is_arrow  () const { return type == ARROW
                                        || (type == SPELL_EFFECT
                                            && (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 has_active_speed () const { return fabs (speed) >= MIN_ACTIVE_SPEED; }
   // temporary: wether the object can be saved in a map file
   // contr => is a player
   // head  => only save head of a multitile object
   // owner => can not reference owner yet
   /* This return true if object has still randomitems which
    * could be expanded.
    */
   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); }
   // returns the outermost owner, never returns 0
   MTH object *outer_owner ()
   {
     object *op;
     return op;
   }
   // returns the outermost environment, never returns 0
-  MTH object *outer_env ()
+  MTH object *outer_env_or_self () const
   {
-    object *op;
+    const object *op;
     for (op = this; op->env; op = op->env)
       ;
-    return op;
+    return const_cast<object *>(op);
+  }
+  // returns the outermost environment, may return 0
+  MTH object *outer_env () const
+  {
+    return env ? outer_env_or_self () : 0;
   }
   // returns the player that has this object in his inventory, or 0
   // we assume the player is always the outer env
-  MTH object *in_player ()
+  MTH object *in_player () const
   {
-    object *op = outer_env ();
+    object *op = outer_env_or_self ();
     return op->type == PLAYER ? op : 0;
   }
   // "temporary" helper function
-  MTH object *head_ ()
+  MTH object *head_ () const
   {
-    return head ? head : this;
+    return head ? head : const_cast<object *>(this);
   }
-  MTH bool is_head ()
+  MTH bool is_head () const
   {
     return head_ () == this;
   }
   MTH bool is_on_map () const
   }
   MTH bool is_inserted () const
   {
     return !flag [FLAG_REMOVED];
+  }
+  MTH bool is_player () const
+  {
+    return !!contr;
+  }
+  MTH bool affects_los () const
+  {
+    return glow_radius || flag [FLAG_BLOCKSVIEW];
+  }
+  MTH bool has_carried_lights () const
+  {
+    return glow_radius;
   }
   // returns the player that cna see this object, if any
   MTH object *visible_to () const;
-  MTH std::string long_desc        (object *who = 0);
+  MTH std::string long_desc        (object *who = 0); // query_name . " " . describe
   MTH std::string describe_monster (object *who = 0);
   MTH std::string describe_item    (object *who = 0);
-  MTH std::string describe         (object *who = 0);
+  MTH std::string describe         (object *who = 0); // long description, without name
+  MTH const char *query_weight     () { return ::query_weight     (this); }
+  MTH const char *query_name       () { return ::query_name       (this); }
+  MTH const char *query_short_name () { return ::query_short_name (this); }
+  MTH const char *query_base_name  (bool plural) { return ::query_base_name (this, plural); }
   // If this object has no extra parts but should have them,
   // add them, effectively expanding heads into multipart
   // objects. This method only works on objects not inserted
   // anywhere.
   MTH void create_treasure (treasurelist *tl, int flags = 0);
   // insert object at same map position as 'where'
   // handles both inventory and map "positions"
   MTH object *insert_at (object *where, object *originator = 0, int flags = 0);
+  // check whether we can put this into the map, respect max_nrof, max_volume, max_items
+  MTH bool can_drop_at (maptile *m, int x, int y, object *originator = 0);
   MTH void drop_unpaid_items ();
   MTH void activate   ();
   MTH void deactivate ();
   MTH void activate_recursive   ();
   const char *query_inventory (object *who = 0, const char *indent = "");
   MTH const_octet_string ref () const; // creates and returns a consistent persistent object reference
   static object *deref (const_octet_string ref); // returns the object from the generated refreence, if possible
+  // make some noise with given item into direction dir,
+  // currently only used for players to make them temporarily visible
+  // when they are invisible.
+  MTH void make_noise ();
+  /* animation */
+  MTH bool has_anim () const { return animation_id; }
+  const animation &anim () const { return animations [animation_id]; }
+  MTH faceidx get_anim_frame (int frame) const { return anim ().faces [frame]; }
+  MTH void set_anim_frame (int frame) { face = get_anim_frame (frame); }
+  /* anim_frames () returns the number of animations allocated.  The last
+   * usuable animation will be anim_frames () - 1 (for example, if an object
+   * has 8 animations, anim_frames () will return 8, but the values will
+   * range from 0 through 7.
+   */
+  MTH int anim_frames  () const { return anim ().num_animations; }
+  MTH int anim_facings () const { return anim ().facings; }
+  MTH char *as_string ();
 protected:
   void link   ();
   void unlink ();
   object ();
   object (const object &);
 };
 // move this object to the top of its env's inventory to speed up
 // searches for it.
-static object *
+static inline object *
 splay (object *ob)
 {
-  if (ob->env && ob->env->inv != ob)
+  if (ob->above && ob->env)
     {
       if (ob->above) ob->above->below = ob->below;
       if (ob->below) ob->below->above = ob->above;
       ob->above = 0;
     }
   return ob;
 }
-typedef struct oblnk
+//+GPL
-{				/* Used to link together several objects */
-  object_ptr ob;
-  struct oblnk *next;
-} objectlink;
-typedef struct oblinkpt
-{				/* Used to link together several object links */
-  struct oblnk *link;
-  sint32 value;			/* Used as connected value in buttons/gates */
-  struct oblinkpt *next;
-} oblinkpt;
-object *find_skill_by_name (object *who, const char *name);
+object *find_skill_by_name_fuzzy (object *who, const char *name);
-object *find_skill_by_name (object *who, const shstr &sh);
+object *find_skill_by_name (object *who, shstr_cmp sh);
 object *find_skill_by_number (object *who, int skillno);
 /*
  * The archetype structure is a set of rules on how to generate and manipulate
  * objects which point to archetypes.
  * be much left in the archetype - all it really is is a holder for the
  * object and pointers.  This structure should get removed, and just replaced
  * by the object structure
  */
+//-GPL
 INTERFACE_CLASS (archetype)
 struct archetype : object
 {
   static arch_ptr empty; // the empty_archetype
   MTH static void gc ();
   MTH void link   ();
   MTH void unlink ();
   MTH static object *get (const char *name); // (find() || singularity)->instance()
   MTH object *instance ();
+  MTH void post_load_check ();          // do some adjustments after parsing
   object_vector_index ACC (RW, archid);         // index in archvector
   shstr ACC (RW, archname);		   	/* More definite name, like "generate_kobold" */
   sint8 ACC (RW, min_x), ACC (RW, min_y);       /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
 extern objectvec objects;
 extern activevec actives;
 extern archvec   archetypes;
 // "safely" iterate over inv in a way such that the current item is removable
-// quite horrible, thats why its hidden in some macro
+// quite horrible, that's why its hidden in some macro
 #define for_inv_removable(op,var)			\
   for (object *var, *next_ = (op)->inv; (var = next_), var && (next_ = var->below), var; )
 #define for_all_objects(var)                    	\
   for (unsigned _i = 0; _i < objects.size (); ++_i)     \
     statementvar (object *, var, actives [_i])
 #define for_all_archetypes(var)                 	\
   for (unsigned _i = 0; _i < archetypes.size (); ++_i)  \
     statementvar (archetype *, var, archetypes [_i])
+//+GPL
 /* Used by update_object to know if the object being passed is
  * being added or removed.
  */
 #define UP_OBJ_INSERT   1
 #define INS_ABOVE_FLOOR_ONLY    0x0002
 #define INS_NO_WALK_ON          0x0004
 #define INS_ON_TOP              0x0008
 #define INS_BELOW_ORIGINATOR    0x0010
-#define ARCH_DEPLETION          "depletion"
+//-GPL
 #endif

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing deliantra/server/include/object.h (file contents): Revision 1.188 by root, Sun Nov 16 03:52:12 2008 UTC vs. Revision 1.217 by root, Sun Nov 8 22:28:10 2009 UTC

Diff Legend

Comparing deliantra/server/include/object.h (file contents):
Revision 1.188 by root, Sun Nov 16 03:52:12 2008 UTC vs.
Revision 1.217 by root, Sun Nov 8 22:28:10 2009 UTC