--- deliantra/server/include/object.h 2007/05/14 21:32:26 1.122
+++ deliantra/server/include/object.h 2008/04/24 00:30:52 1.168
@@ -1,25 +1,24 @@
/*
- * CrossFire, A Multiplayer Online RPG
- *
- * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
- * Copyright (C) 2001 Mark Wedel & Crossfire Development Team
- * Copyright (C) 1992 Frank Tore Johansen
- *
- * This program is free software; you can redistribute it and/or modify
+ * This file is part of Deliantra, the Roguelike Realtime MMORPG.
+ *
+ * Copyright (©) 2005,2006,2007,2008 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 2 of the License, or
+ * 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
+ * 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, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * The authors can be reached via e-mail at crossfire@schmorp.de
+ * along with this program. If not, see .
+ *
+ * The authors can be reached via e-mail to
*/
#ifndef OBJECT_H
@@ -61,13 +60,16 @@
typedef struct Body_Locations
{
- const char *save_name; /* Name used to load/save it to disk */
+ keyword save_name; /* 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];
+#define NUM_COINS 4 /* number of coin types */
+extern const char *const coins[NUM_COINS + 1];
+
/*
* Each object (this also means archetypes!) could have a few of these
* "dangling" from it; this could also end up containing 'parse errors'.
@@ -88,15 +90,36 @@
{
uint64 seq;
+ static UUID cur; // last uuid generated
+ static void init ();
+ static UUID gen ();
+
UUID () { }
UUID (uint64 seq) : seq(seq) { }
operator uint64() { return seq; }
void operator =(uint64 seq) { this->seq = seq; }
-};
-extern void init_uuid ();
-extern UUID gen_uuid ();
-extern const uint64 UUID_SKIP;
+ 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));
+ }
+};
/* Definition for WILL_APPLY values. Replaces having harcoded values
* sprinkled in the code. Note that some of these also replace fields
@@ -109,11 +132,6 @@
#define WILL_APPLY_DOOR 0x08
#define WILL_APPLY_FOOD 0x10
-/* However, if you're keeping a pointer of some sort, you probably
- * don't just want it copied, so you'll need to add to common/object.C,
- * e.g. ->copy_to ()
- */
-
struct body_slot
{
signed char info:4; /* body info as loaded from the file */
@@ -139,6 +157,7 @@
shstr ACC (RW, race); /* human, goblin, dragon, etc */
shstr ACC (RW, slaying); /* Which race to do double damage to */
/* If this is an exit, this is the filename */
+ shstr ACC (RW, tag); // a tag used to tracking this object
shstr ACC (RW, skill); /* Name of the skill this object uses/grants */
shstr ACC (RW, msg); /* If this is a book/sign/magic mouth/etc */
shstr ACC (RW, lore); /* Obscure information about this object, */
@@ -187,12 +206,14 @@
sint8 ACC (RW, glow_radius); /* indicates the glow radius of the object */
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 */
+ sint32 ACC (RW, carrying); /* How much weight this object contains, must be 0 if nrof == 0 */
sint64 ACC (RW, perm_exp); /* Permanent exp */
uint32 ACC (RW, weapontype); /* type of weapon */
uint32 ACC (RW, tooltype); /* type of tool or build facility */
body_slot slot [NUM_BODY_LOCATIONS];
- faceidx ACC (RW, face); /* Face with colors */
+ faceidx ACC (RW, face); /* the graphical face */
+ faceidx ACC (RW, sound); /* the sound face */
+ faceidx ACC (RW, sound_destroy); /* played on destroy */
living ACC (RO, stats); /* Str, Con, Dex, etc */
/* See the pod/objects.pod for more info about body locations */
@@ -253,10 +274,10 @@
UUID ACC (RW, uuid); // Unique Identifier, survives saves etc.
int ACC (RO, count);
- int ACC (RO, index); // index into objects
- int ACC (RO, active); // index into actives
+ object_vector_index ACC (RO, index); // index into objects
+ object_vector_index ACC (RO, active); // index into actives
- player_ptr ACC (RW, contr); /* Pointer to the player which control this object */
+ player_ptr ACC (RW, contr); /* Pointer to the player which control this object, ALWAYS set *iff* type == PLAYER */
object *ACC (RW, below); /* Pointer to the object stacked below this one */
object *ACC (RW, above); /* Pointer to the object stacked above this one */
@@ -276,12 +297,13 @@
key_value *key_values; /* Fields not explictly known by the loader. */
bool parse_kv (object_thawer &f); // parse kv pairs, (ab-)used by archetypes, which should not exist at all
- void post_load_check (); // do some adjustments after parsing
+ 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);
object &operator =(const object &src);
MTH void copy_to (object *dst);
MTH object *clone (); // create + copy_to
@@ -292,6 +314,8 @@
// 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);
+
void do_remove ();
MTH void remove ()
{
@@ -299,22 +323,13 @@
do_remove ();
}
- // move this object to the top of its env's inventory to speed up
- // searches for it.
- MTH object *inv_splay ()
- {
- if (env && env->inv != this)
- {
- if (above) above->below = below;
- if (below) below->above = above;
-
- above = 0;
- below = env->inv;
- below->above = this;
- env->inv = this;
- }
+ MTH bool blocked (maptile *m, int x, int y) const;
- return this;
+ void move_to (const mapxy &pos)
+ {
+ remove ();
+ *this = pos;
+ insert_at (this, this);
}
static bool can_merge_slow (object *op1, object *op2);
@@ -330,6 +345,7 @@
MTH void set_owner (object *owner);
MTH void set_speed (float speed);
MTH bool change_weapon (object *ob);
+ MTH bool change_skill (object *ob);
MTH void open_container (object *new_container);
MTH void close_container ()
@@ -337,6 +353,15 @@
open_container (0);
}
+ MTH object *force_find (const shstr name);
+ MTH void force_add (const shstr name, int duration = 0);
+
+ // 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;
+ }
+
MTH void instantiate ();
// recalculate all stats
@@ -354,21 +379,26 @@
MTH const char *debug_desc () const; // uses at least 3 round-robin buffers
const char *flag_desc (char *desc, int len) const;
- int number_of () const
+ MTH bool decrease (sint32 nr = 1); // returns true if anything is left
+ MTH object *split (sint32 nr = 1); // return 0 on failure
+
+ MTH int number_of () const
{
return nrof ? nrof : 1;
}
- uint64 total_weight () const
+ MTH sint32 total_weight () const
{
- return weight * number_of ();
+ return (weight + carrying) * number_of ();
}
+ MTH void update_weight ();
+
// return the dominant material of this item, always return something
const materialtype_t *dominant_material () const;
// return the volume of this object in cm³
- uint64 volume () const
+ MTH uint64 volume () const
{
return total_weight ()
* 1000
@@ -395,21 +425,28 @@
// contr => is a player
// head => only save head of a multitile object
// owner => can not reference owner yet
- MTH bool can_map_save () const { return !contr && !head && !owner && !flag [FLAG_NO_MAP_SAVE]; }
+ MTH bool can_map_save () const { return !head && (!owner || owner->contr) && !contr && !flag [FLAG_NO_MAP_SAVE]; }
/* 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]; }
- // returns the player that has this object in his inventory, or 0
- MTH object *in_player () const
+ // returns the outermost environment, never returns 0
+ MTH object *outer_env ()
{
- for (object *op = env; op; op = op->env)
- if (op->type == PLAYER)
+ for (object *op = this; ; op = op->env)
+ if (!op->env)
return op;
+ }
+
+ // 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 ()
+ {
+ object *op = outer_env ();
- return 0;
+ return op->type == PLAYER ? op : 0;
}
// "temporary" helper function
@@ -418,6 +455,19 @@
return head ? head : this;
}
+ MTH bool is_head ()
+ {
+ return head_ () == this;
+ }
+
+ MTH bool is_on_map () const
+ {
+ return !env && !flag [FLAG_REMOVED];
+ }
+
+ // 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 describe_monster (object *who = 0);
MTH std::string describe_item (object *who = 0);
@@ -434,13 +484,14 @@
// 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);
+ MTH void drop_unpaid_items ();
MTH void activate ();
MTH void deactivate ();
MTH void activate_recursive ();
MTH void deactivate_recursive ();
- // set the givne flag on all objects in the inventory recursively
+ // set the given flag on all objects in the inventory recursively
MTH void set_flag_inv (int flag, int value = 1);
void enter_exit (object *exit);//Perl
@@ -490,38 +541,55 @@
}
/* This returns TRUE if the object is something that
- * should be displayed in the floorbox/inventory window
+ * a client might want to know about.
*/
MTH bool client_visible () const
{
return !invisible && type != PLAYER;
}
+ // the client does nrof * this weight
+ MTH sint32 client_weight () const
+ {
+ return weight + carrying;
+ }
+
MTH struct region *region () const;
-protected:
- friend struct archetype;
+ void statusmsg (const char *msg, int color = NDI_BLACK);
+ void failmsg (const char *msg, int color = NDI_RED);
- void link ();
+ 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
+
+protected:
+ void link ();
void unlink ();
object ();
~object ();
};
-typedef object_vector objectvec;
-typedef object_vector activevec;
+// move this object to the top of its env's inventory to speed up
+// searches for it.
+static object *
+splay (object *ob)
+{
+ if (ob->env && ob->env->inv != ob)
+ {
+ if (ob->above) ob->above->below = ob->below;
+ if (ob->below) ob->below->above = ob->above;
-extern objectvec objects;
-extern activevec actives;
+ ob->above = 0;
+ ob->below = ob->env->inv;
+ ob->below->above = ob;
+ ob->env->inv = ob;
+ }
-#define for_all_objects(var) \
- for (unsigned _i = 0; _i < objects.size (); ++_i) \
- declvar (object *, var, objects [_i])
-
-#define for_all_actives(var) \
- for (unsigned _i = 0; _i < actives.size (); ++_i) \
- declvar (object *, var, actives [_i])
+ return ob;
+}
typedef struct oblnk
{ /* Used to link together several objects */
@@ -532,14 +600,13 @@
typedef struct oblinkpt
{ /* Used to link together several object links */
struct oblnk *link;
- long value; /* Used as connected value in buttons/gates */
+ 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 (object *who, const shstr &sh);
object *find_skill_by_number (object *who, int skillno);
-int change_skill (object *who, object *new_skill, int flag);
/*
* The archetype structure is a set of rules on how to generate and manipulate
@@ -551,31 +618,60 @@
*/
INTERFACE_CLASS (archetype)
-struct archetype : zero_initialised, attachable
+struct archetype : object
{
- archetype ();
+ static arch_ptr empty; // the empty_archetype
+ MTH static void gc ();
+
+ archetype (const char *name);
~archetype ();
void gather_callbacks (AV *&callbacks, event_type event) const;
- static archetype *read (object_thawer &f);
- static archetype *get (const char *name); // find or create
- static archetype *find (const char *name);
+ MTH static archetype *find (const_utf8_string name);
+
+ MTH void link ();
+ MTH void unlink ();
+
+ MTH object *instance ();
+
+ object_vector_index ACC (RW, archid); // index in archvector
+ shstr ACC (RW, archname); /* More definite name, like "generate_kobold" */
- void hash_add (); // add to hashtable
- void hash_del (); // remove from hashtable
+ sint8 ACC (RW, min_x), ACC (RW, min_y); /* extents, compared to the head (min_x, min_y should be zero, but aren't...) */
+ sint8 ACC (RW, max_x), ACC (RW, max_y);
- shstr ACC (RW, name); /* More definite name, like "generate_kobold" */
- struct archetype *ACC (RW, next); /* Next archetype in a linked list */
- struct archetype *ACC (RW, head); /* The main part of a linked object */
- struct archetype *ACC (RW, more); /* Next part of a linked object */
- object ACC (RO, clone); /* An object from which to do ->copy_to () */
- uint32 ACC (RW, editable); /* editable flags (mainly for editor) */
- bool ACC (RW, linked); // linked into list of heads
- sint8 ACC (RW, tail_x), ACC (RW, tail_y); /* Where the lower right most portion of the object is
- * in comparison to the head.
- */
+ // support for archetype loading
+ static archetype *read (object_thawer &f);
+ MTH static void commit_load (); // commit any objects loaded, resolves cyclic dependencies and more
+ static void postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch); /* postpone other_arch reference */
};
+inline void
+object_freezer::put (keyword k, archetype *v)
+{
+ put (k, v ? &v->archname : (const char *)0);
+}
+
+typedef object_vector objectvec;
+typedef object_vector activevec;
+typedef object_vector archvec;
+
+extern objectvec objects;
+extern activevec actives;
+extern archvec archetypes;
+
+#define for_all_objects(var) \
+ for (unsigned _i = 0; _i < objects.size (); ++_i) \
+ statementvar (object *, var, objects [_i])
+
+#define for_all_actives(var) \
+ for (unsigned _i = 0; _i < actives.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])
+
/* Used by update_object to know if the object being passed is
* being added or removed.
*/
@@ -601,9 +697,6 @@
* beneath the player, but not actually above it. Note - the
* map and x,y coordinates for the object to be inserted must
* match the originator.
- * INS_MAP_LOAD: disable lots of checkings done at insertion to
- * speed up map loading process, as we assume the ordering in
- * loaded map is correct.
*
* Note that INS_BELOW_ORIGINATOR, INS_ON_TOP, INS_ABOVE_FLOOR_ONLY
* are mutually exclusive. The behaviour for passing more than one
@@ -616,12 +709,8 @@
#define INS_NO_WALK_ON 0x0004
#define INS_ON_TOP 0x0008
#define INS_BELOW_ORIGINATOR 0x0010
-#define INS_MAP_LOAD 0x0020
-#define ARCH_SINGULARITY "singularity"
-#define ARCH_DETECT_MAGIC "detect_magic"
#define ARCH_DEPLETION "depletion"
-#define ARCH_SYMPTOM "symptom"
#endif