[an error occurred while processing this directive]
[<a href="index.shtml">Package Index</a></code> | <a href="index_std.shtml">Mudlib Index</a></code> | <a href="index_eff.shtml">Effect Index</a></code>]<br><h2>File /std/object.c</h2>
The basic object.  This pulls together all the bits needed to create
a basic object.
<p><b>See also:</b><br>/std/room.c
<br /><p>Written by Pinkfish<h2>Inherits</h2>
This class inherits the following classes <a href="std.basic.effects.c.shtml">/std/basic/effects.c</a>, <a href="std.basic.auto_load.c.shtml">/std/basic/auto_load.c</a>, <a href="std.basic.id.c.shtml">/std/basic/id.c</a>, <a href="std.basic.identity_hold.c.shtml">/std/basic/identity_hold.c</a>, <a href="std.basic.help_files.c.shtml">/std/basic/help_files.c</a>, <a href="std.basic.extra_look.c.shtml">/std/basic/extra_look.c</a>, /std/basic/theft_callback.c, <a href="std.basic.property.c.shtml">/std/basic/property.c</a>, <a href="std.basic.misc.c.shtml">/std/basic/misc.c</a>, <a href="std.basic.enchant.c.shtml">/std/basic/enchant.c</a>, <a href="std.basic.init.c.shtml">/std/basic/init.c</a> and <a href="std.basic.read_desc.c.shtml">/std/basic/read_desc.c</a><h2>Includes</h2>
This class includes the following files <a href="include.cmr.h.shtml">/include/cmr.h</a> and <a href="include.move_failures.h.shtml">/include/move_failures.h</a><h2>Method index</h2>
<ul>
<li><a href="#add_material">add_material</a>(mixed)<br/>
This method adds a material to the end of the list of current materials.
<li><a href="#clean_up">clean_up</a>(int)<li><a href="#long">long</a>(string, int)<br/>
The description of an object when someone looks at it.
<li><a href="#move">move</a>(mixed, string, string)<li><a href="#parse_command_adjectiv_id_list">parse_command_adjectiv_id_list</a>()<li><a href="#parse_command_id_list">parse_command_id_list</a>()<li><a href="#query_cloned_by">query_cloned_by</a>()<br/>
Who cloned the object.
<li><a href="#query_colour">query_colour</a>()<br/>
The colour of the object.
<li><a href="#query_material">query_material</a>()<br/>
This gives the primary material of the object, that is, the one listed first
in its materials array.
<li><a href="#query_materials">query_materials</a>()<br/>
This returns all of the materials of the object.
<li><a href="#query_objective">query_objective</a>()<br/>
The objective of the object.
<li><a href="#query_possessive">query_possessive</a>()<br/>
The possessive of the object.
<li><a href="#query_pronoun">query_pronoun</a>()<br/>
The pronoun of the object.
<li><a href="#query_quality">query_quality</a>()<br/>
This method returns the quality of the object.
<li><a href="#replace_long_dollars">replace_long_dollars</a>(object, string)<br/>
This method replaces any colours of materials in the given string
with the appropriate ccolours or materials for this object.
<li><a href="#reset_materials">reset_materials</a>()<br/>
This resets all of the materials of the object (i.
<li><a href="#set_colour">set_colour</a>(string)<br/>
Sets the colour of the object.
<li><a href="#set_material">set_material</a>(mixed, int)<br/>
This method adds a material to the front of the list of current materials.
<li><a href="#set_name">set_name</a>(string)<br/>
Gives the object a name.
<li><a href="#set_player">set_player</a>(object)<br/>
Sets the player associated with the object.
<li><a href="#set_quality">set_quality</a>(int)<br/>
This method sets the quality of the object.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_material">
add_material</a><pre class="autodocfuncdef">
void add_material(mixed material)
</pre><dd><br />
This method adds a material to the end of the list of current materials.  If
you would like the material to be added to the beginning of the materials
array instead, use set_material().<br />
<br /><dl>
<dd><b>Parameters:</b><br />
material - the material to add<br />
<br />
<dd><b>See also:</b>
<br /><a href="#set_material">set_material()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="clean_up">
clean_up</a><pre class="autodocfuncdef">
int clean_up(int inherited)
</pre>
<dt class="autodocfuncname"><a name="long">
long</a><pre class="autodocfuncdef">
string long(string word,
            int dark)
</pre><dd><br />
The description of an object when someone looks at it.  This handles
the extra code for messages, colour and material.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
word - the word it was matched on<br />
dark - is it dark from the player's perspecitive<br />
<br />
<dd><b>Returns:</b>
<br />the long description
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="move">
move</a><pre class="autodocfuncdef">
varargs int move(mixed dest,
                 string messin,
                 string messout)
</pre>
<dt class="autodocfuncname"><a name="parse_command_adjectiv_id_list">
parse_command_adjectiv_id_list</a><pre class="autodocfuncdef">
string * parse_command_adjectiv_id_list()
</pre>
<dt class="autodocfuncname"><a name="parse_command_id_list">
parse_command_id_list</a><pre class="autodocfuncdef">
string * parse_command_id_list()
</pre>
<dt class="autodocfuncname"><a name="query_cloned_by">
query_cloned_by</a><pre class="autodocfuncdef">
string query_cloned_by()
</pre><dd><br />
Who cloned the object.  Used for security reasoin to trace who have
been cloning up objects for players.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the person who cloned the object
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_colour">
query_colour</a><pre class="autodocfuncdef">
string query_colour()
</pre><dd><br />
The colour of the object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the colour of the objecy
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_material">
query_material</a><pre class="autodocfuncdef">
string query_material()
</pre><dd><br />
This gives the primary material of the object, that is, the one listed first
in its materials array.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the name of the object's primary material, or 0 if no materials set<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_materials">query_materials()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_materials">
query_materials</a><pre class="autodocfuncdef">
string * query_materials()
</pre><dd><br />
This returns all of the materials of the object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />an array contaning all the object's materials<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_material">query_material()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_objective">
query_objective</a><pre class="autodocfuncdef">
string query_objective()
</pre><dd><br />
The objective of the object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />always returns "it"
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_possessive">
query_possessive</a><pre class="autodocfuncdef">
string query_possessive()
</pre><dd><br />
The possessive of the object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />always returns "its"
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_pronoun">
query_pronoun</a><pre class="autodocfuncdef">
string query_pronoun()
</pre><dd><br />
The pronoun of the object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />always returns "it"
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_quality">
query_quality</a><pre class="autodocfuncdef">
int query_quality()
</pre><dd><br />
This method returns the quality of the object.  The quality is used
in the crafts system, amongst other things.
<br />

<dt class="autodocfuncname"><a name="replace_long_dollars">
replace_long_dollars</a><pre class="autodocfuncdef">
string replace_long_dollars(object player,
                            string text)
</pre><dd><br />
This method replaces any colours of materials in the given string
with the appropriate ccolours or materials for this object.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
player - the player attempting to check the colour/material.<br />
text - the text to replace<br />
<br />
<dd><b>Returns:</b>
<br />a new string with the dollar identities expanded.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="reset_materials">
reset_materials</a><pre class="autodocfuncdef">
void reset_materials()
</pre><dd><br />
This resets all of the materials of the object (i.e. empties out its
materials array).
<br />

<dt class="autodocfuncname"><a name="set_colour">
set_colour</a><pre class="autodocfuncdef">
void set_colour(string word)
</pre><dd><br />
Sets the colour of the object.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
word - the colour to make the object
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_material">
set_material</a><pre class="autodocfuncdef">
varargs void set_material(mixed word,
                          int clear_old_materials)
</pre><dd><br />
This method adds a material to the front of the list of current materials.
Optionally, it can also clear out any existing materials first, although
this behaviour is not the default, requiring the second argument to be
nonzero.  If you would like the material to be added to the end of the
materials array instead, use add_material().<br />
<br /><dl>
<dd><b>Parameters:</b><br />
word - the material to add<br />
clear_old_materials - 1 to clear out the existing materials, 0 to not<br />
<br />
<dd><b>See also:</b>
<br /><a href="#add_material">add_material()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="set_name">
set_name</a><pre class="autodocfuncdef">
void set_name(string word)
</pre><dd><br />
Gives the object a name.  Sets the name to the word and makes it the
short description  and attempts to create the pural short description
from it.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name to use
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_player">
set_player</a><pre class="autodocfuncdef">
void set_player(object thing)
</pre><dd><br />
Sets the player associated with the object.  This is used during the
autoload sequence.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
thing - the player object we belong to<br />
<br />
<dd><b>See also:</b>
<br />/global/auto_load.c
<br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="set_quality">
set_quality</a><pre class="autodocfuncdef">
void set_quality(int quality)
</pre><dd><br />
This method sets the quality of the object.  All objects are by
default 'normal' quality.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
quality - the quality of the object
<br />
<br />
<br /></dl>

</dl>
[an error occurred while processing this directive]