STD/OBJECT
----------
		 This is Shattered World's Generic Object.

o Use it to clone a copy, and setup local values.
eg.
     rock = clone_object("std/object");
     rock->set_id( ({ "rock", "small rock" }) );
     rock->set_short("A small rock");
     rock->set_long("This is what appears to be a hand smoothed "+
                    "lump of granite.\n");
     rock->set_weight(2);
    	
o Or inherit it for all normal objects handled by players.
  (that need more than this standard file). 
eg.
      inherit "std/object";

      reset(arg) {
          ::reset(arg);
          if (!arg) {
              set_id( ({ "rock" ,"small rock" }); 
              set_short("A small rock");
              set_long("This is what appears to be a hand smoothed "+
                   "lump of granite.\n");
              set_weight(2);    	 
              }
          }
      }

o DON'T JUST COPY THE FILE - INHERIT std/object !
  REFER TO THE EXAMPLES IN DOC/EXAMPLE ! 
	- simple_object.c
	- bag.c , chest.c
	- signpost.c
        - soap_bubble.c  , flower.c

o Standard properties that are implemented :
	NO_GET, <fail msg | ob:func>
	NO_DROP, <fail msg | ob:func>
        NO_PLAYER_GET
	NO_SAVE 
	PREVENT_INSERT, <msg>
	CONTAINER, 0 , max amount can hold.
	CAN_OPEN	
	LIGHT, <>, lit 
	WATERPROOF, <msg>
	READ, < msg >, <optional minimum intelligence>
	BREAK,< optional msg >, <minimum strength needed>
        DECAY , <optional ob:func >, <time>

o flag properties which indicate state of object:			
	MAGIC 
	ENCHANTED	
	BLESSED
	WORN
	OPEN
	BROKEN, <msg appended to short_desc>
	HIDDEN

  where < msg > maybe of the form "players/dredd/item:func"
  to specify a function to call rather than a message.

o REFER TO DOC/STD/OBJECT.PROPERTY FOR DOCS ON THESE PROPERTIES

Global Variables:
-----------------
string short_desc	: the short description of the object,
			without appended "(lit)", "(worn)", "(broken)" etc.
string long_desc	: long description of the object.
string info		: information on the object for wizard usage.

int value		: 1/2 of the item's purchase value in gold coins.
int local_weight	: the physical weight of the object, not including
			contents.	
array name_list		: array of strings containing all the object's id's.
array property		: array of the object's properties. Each property
			occupies three cells of the array.

	Although you can use the variables of an inherited object in
your code, please do not as these variables are not guaranteed to stay
the same. Always use an appropiate set_XXXX or query_XXXX function. 

The Functions defined:
----------------------
	The functions described in std/object are listed below in groups
of associated functions, not alphabetic order.


boolean id(string str)
		Returns 1 if str is a valid id of the object.
void set_id(string/array str)
		Sets the id of the object as the string.
                str can also be an array of strings (see the examples). 
int add_id(string str)
		Adds an id to the object. returns 1 if successful. 
int remove_id(string str)
		Removes an id from the object. 1 is returned if successful. 
void set_alias(string str)
void set_name(string str)
		Backwards hacks. DO NOT USE IN NEW CODE!
string query_alias()	
		Returns the first id of the object.

void set_items( array )
		Sets a list of items that are on the object worth a 
		further mention (as in room/room)
		array is in the form ({ id, desc , id, desc ..}).
		eg, a treasure chest has a lock ("look lock")
void add_item(string id, string desc)
		adds a single item worth mention
remove_item(string id)
		remove the item description

int add_property(string str, arg1, arg2)
		Adds the standard property to the item.
                This function will NOT add properties that already exist,
                use change_property. Returns 1 if successful.
		Refer notes on properties for their uses. 
int remove_property(string str)
		Removes the property specified. 
		Returns 1 is successful
int change_property(string str, arg1 arg2)
		Changes the arguments of the labeled property, by first 
		removing the old property and adding the new information. 
array query_property(string str)
		Returns in array form the details of the property.
		cell[0] is the property
		cell[1] is the first argument
		cell[2] is the second argument 
boolean find_property(string str)
		Fast method for checking if a property exists.

int set_flag_property(int x, string str)
		Some properties are used as flags regarding the current
		state of the object, and these have no arguments.
		Use this function to set/reset the flag (0 to reset, 1 to set)
		(This function only simplifies the code esp. in 
		set_magic, set_waterproof etc.)


void set_short(string str)
		Sets the short description of the item, and the long
	        description to "You see nothing special.\n" if long_desc
                has not been set.
string short() 	Returns the short description of the object as a string.
		Depending upon what properties the object has, descriptors
		in brakets are added and returned (refer properties) 
string query_short()
		Return the short_desc.
string query_name()
		Returns short_desc with leading 'A' 'An' or 'The' stripped.


void set_long(string str)
		Use this to set long_desc of the object
void long()	Writes the long description of the object.	
string query_long()
		Returns the long description of the object as a string.


int get() 	Returns 1 by default, specifing that the object can
		be picked up by players. The return value also depends on
		what current properties the object has.
int drop()	Returns 0 by default, indicating the object can be dropped.
		This return value also depends on the current state and 
		properties.
int can_put_and_get()
		Depending on the properties and current state of the object,
		either 0 or 1 is returned.
int prevent_insert()
		Again the return result depends on the state and properties
		of the item.


int query_value() 	
		Returns the value of the item.
void set_value(int v) 
		Set the value of the item (1/2 purchase cost). default 0

int query_weight() 	
		Returns the weight of the object plus half of the sum of
		the contents (query_contents_weight()).
void set_weight(int w)
		Set the weight. Default 1
int add_weight(int extra)
		If the extra weight can fit inside the object (ie 
		container) return 1, otherwise 0.
void set_max_weight(int max)
		By calling this function the object now becomes a 
		container, with maximum holding capacity max.
int query_max_weight()
		Returns the maximum holding capacity of the object.	
int query_contents_weight()
		returns the total sum of all the weights of the 
		items within the object
int query_local_weight()
		Old code hack. Exactly the same as query_contents_weight.
		(formerly in obj/container).


string query_info() 	
		Returns a string of information about the item.
void set_info(string str)
		Sets the info string of the item

void set_read(string str)
		Sets a string that players can 'read' on the item.

void init()	Depending on the current state and properties of the item
		this init function adds various actions. If you inherit 
		std/object, make sure you call the inherited function
		with '::init()' in the first line of your init code.

The Following functions have add_actions assosiated, 
depending on the properties of the object. If you inherit std/object, it
might be worth your while calling the inherited functions.

int search(string str)
		If the object can be searched (SEARCH property)
		this simple search function just goes through the contents
		of the object and makes all hidden objects visible.
int wear(string str)
		If the object has the 'wear' property, this add_action is
		enabled. All wear does is marks the object as 'worn', if it
		isn't already.
int remove(string str)
		The opposite to wear. Only enabled if the object has the
		'wear' property. 
int wield(string str)
		As for wear, but the required property is WIELD.
int read(string str)
		Returns the read message if it exists 
int break_object(string str)
		Abstract object break code, if id(str) is true,
		and the strength of this_player() is greater than the
		strength defined by the BREAK property (rf), the object
		gets the property of BROKEN (refer properties)

int open(string str)
		Code to open the object if set_can_open(1) has been called.
int close(string str)
		Code to handle closing of the object by players.
int light(string str)
		Code to light the object light a torch if the
		object is actually a light.
int extinguish(string str)
		Code to extinguish the light.


The follow four methods are used by the property code in std/object:

string get_function_ob(string str)
		Returns the object refered to in the str "ob:func"
string get_function_name(string str) 
		Returns the function refered to in the str "ob:func"
boolean query_valid_hook(string str) 
		Returns true if str is of the form "ob:func", ie.
		o there are no spaces
		o there is only one colon ":"
int call_function(string str) 
		Calls the function in the object defined by str,
		returning 0 if str is not of the form "ob:func" or
		the function returns 0 itself, otherwise the return 
		value of the function called is returned.	

void decay()		( call_out )
                This function is called out if the DECAY property is set.
                The abstract implementation in std/object either destructs
                the object or calls an object:function call depending on
                the second argument (refer the DECAY documantation).
 
void spill_contents(int silent)
		If the object is a container then attempt to move
		everything inside the container to outside the container.
		When a container is broken this function is called.


int set_can_open(int x)
		Sets if the object can be opened and closed like
		a chest. 0 == no open  1 == can open
int query_can_open()
		Returns 1 if the object can be opened-closed.
boolean query_opened()
		Returns the opened state of the object.
		This function replaces the opened variable in obj/container.
int set_opened(int opened_state)
		Set the opened state of the object, IF the object can 
		be opened (ie set_can_open(1) has been called) 


int query_quest_item()
		Returns 1 if the object cannot be saved
		(Generally means its a quest object)
int set_quest_item(int x)
		If x == 1 disables saving of the object via use of
		the query_no_external_restore lfun.


int query_magic()
		return 1 if the object is a magical object.
int set_magic(int x)
		Set the magical state of the object (0 == no magic)


array init_light()
		Creates a default array for lights if the
		object doesn't already have a light property. This
		doesn't actually add the property.
     		 
void set_fuel(int x)
		Make the object into a light with fuel to last for
		x/2 real time seconds burning.
int query_fuel() 
		return the amount of fuel left.

void set_lit(int state)
		Turn the light on/off (0 == off  1 == on),
		this doesn't decrement fuel.
int query_lit()	Returns the lit state.
int query_is_lit()
		Returns the current lit state of the light.
		(same as query_lit(), this is a backwards hack)

void set_lit_desc(string desc)
		Sets the long description that the light has while lit
string query_long_lit_desc()
		returns the long desc the light has while lit.
void set_unlit_desc(string desc)
		Sets the unlit description of the object
string query_long_unlit_desc()
		Returns the unlit description.

int is_light()
		returns 1 if the object has the properties of a light.

void out_of_fuel() 	(call out)
		Call out function called when the light is out of fuel.   
void set_water(int waterproof, string wet_message)
		sets the item to waterproof state 'waterproof',
		and the message printed when the light gets wet.
string query_wet_msg()
		Returns the light's wet message


int set_waterproof(int x)  
		If x == 1 make the object waterproof.
int query_waterproof()
		return the current waterproof state of the object.


int set_broken(int x)
		Set the broken state of the object (x == 1 is broken)
		refer to the BROKEN property info.
int query_broken()
		Query broken state of the object.

 
int set_hidden(int x)
		Set the hidden property of the object (x == 1 is hidden)
		refer to the HIDDEN property
int query_hidden()
		Query the hidden state of the object.


void preserve_call_outs()
                Preserve the current state of the object. This is called 
                by query_no_external_save with std/object.
void notify_wet(int x)
		Will extinguish a torch, if (x). Its usually called
		by /obj/wet.c
 
Debugging Information:
void show_stats()     
		This function writes all variables of the object and
		other interesting info about the property. This is
		the function used by the wiz command 'stat'. If you
		inherit std/object, and add more variables, please 
		add a show_stats function that first calls ::show_stats()
		then write's the variables.