[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>Includes</h2>
This class includes the following files <a href="include.parse_command.h.shtml">/include/parse_command.h</a> and <a href="include.obj_parser.h.shtml">/include/obj_parser.h</a><h2>Method index</h2>
<dl><ul>
<li><a href="#modify_item_by_index">modify_item_by_index</a>(int, mixed)<br/>
This method non-destructively modifies the items values.
<li><a href="#modify_item_by_name">modify_item_by_name</a>(string, mixed)<br/>
This method non-destructively modifies the items values.
<li><a href="#print_stuff">print_stuff</a>()<li><a href="#query_count">query_count</a>()<li><a href="#query_creator_room">query_creator_room</a>()<li><a href="#query_cur_desc">query_cur_desc</a>()<br/>
This returns the currently matching indexes for the item object.
<li><a href="#query_gather">query_gather</a>()<br/>
This method figures out what gatherables are available for the
current description set.
<li><a href="#query_lng">query_lng</a>()<br/>
This method returns all the long descriptions for the item object.
<li><a href="#query_plurals">query_plurals</a>()<br/>
This method returns the plurals mapping used in the item object.
<li><a href="#query_short_array">query_short_array</a>()<br/>
This method returns the base array of shorts to be processed in the
other short methods.
<li><a href="#query_shrt">query_shrt</a>()<br/>
This method returns all the short descriptions for the item object.
<li><a href="#query_verbs">query_verbs</a>()<br/>
This method returns the verbs mapping used in the item object.
<li><a href="#remove_item_by_index">remove_item_by_index</a>(int)<br/>
This method removes an item by the returned index number from the
add_item method.
<li><a href="#remove_item_by_name">remove_item_by_name</a>(string)<br/>
This method removes an item by the short description.
<li><a href="#setup_item">setup_item</a>(mixed, mixed, int)<br/>
This method setups the item initially.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="modify_item_by_index">
modify_item_by_index</a><pre>
int modify_item_by_index(int index,
                         mixed long)
</pre></br>
This method non-destructively modifies the items values.  It will not
remove the value for this item, remember this!  If you add again
and again you will end up with multiple of the same object.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the name to reference the object by
<br/>long - the long bits to change on the item
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

<li><b>See also:</b>
<br/><a href="std.room.c.shtml#modify_item_by_name">/std/room->modify_item_by_name()</a></dl>

<ul><a name="modify_item_by_name">
modify_item_by_name</a><pre>
int modify_item_by_name(string str,
                        mixed long)
</pre></br>
This method non-destructively modifies the items values.  It will not
remove the value for this item, remember this!  If you add again
and again you will end up with multiple of the same object.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the name to reference the object by
<br/>long - the long bits to change on the item
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

<li><b>See also:</b>
<br/><a href="std.room.c.shtml#modify_item_by_name">/std/room->modify_item_by_name()</a></dl>

<ul><a name="print_stuff">
print_stuff</a><pre>
void print_stuff()
</pre>
<ul><a name="query_count">
query_count</a><pre>
int query_count()
</pre>
<ul><a name="query_creator_room">
query_creator_room</a><pre>
string query_creator_room()
</pre>
<ul><a name="query_cur_desc">
query_cur_desc</a><pre>
int * query_cur_desc()
</pre></br>
This returns the currently matching indexes for the item object.
<br/><ul>
<li><b>Returns:</b>
<br/>the array of currently matchig indexes

</dl>

<ul><a name="query_gather">
query_gather</a><pre>
mixed * query_gather()
</pre></br>
This method figures out what gatherables are available for the
current description set.  The array contains the values passed
into the add_item stuff with the "gather" index.
<br/><ul>
<li><b>Returns:</b>
<br/>the current gatherables

</dl>

<ul><a name="query_lng">
query_lng</a><pre>
string * query_lng()
</pre></br>
This method returns all the long descriptions for the item object.  The
positions in the array correspond to the index used to reference the
items.
<br/><ul>
<li><b>Returns:</b>
<br/>the array of long descriptions

</dl>

<ul><a name="query_plurals">
query_plurals</a><pre>
mapping query_plurals()
</pre></br>
This method returns the plurals mapping used in the item object.
<br/><ul>
<li><b>Returns:</b>
<br/>the plurals in the item object

</dl>

<ul><a name="query_short_array">
query_short_array</a><pre>
string * query_short_array()
</pre></br>
This method returns the base array of shorts to be processed in the
other short methods.  This is the short without the leading
'the', 'a' whatever...
<br/><ul>
<li><b>Returns:</b>
<br/>the array of shorts

</dl>

<ul><a name="query_shrt">
query_shrt</a><pre>
string * query_shrt()
</pre></br>
This method returns all the short descriptions for the item object.  The
positions in the array correspond to the index used to reference the
items.
<br/><ul>
<li><b>Returns:</b>
<br/>the array of long descriptions

</dl>

<ul><a name="query_verbs">
query_verbs</a><pre>
mapping query_verbs()
</pre></br>
This method returns the verbs mapping used in the item object.
<br/><ul>
<li><b>Returns:</b>
<br/>the verbs in the item object

</dl>

<ul><a name="remove_item_by_index">
remove_item_by_index</a><pre>
int remove_item_by_index(int index)
</pre></br>
This method removes an item by the returned index number from the
add_item method.
<br/><ul>
<li><b>Parameters:</b>
<br/>index - the index number to remove
<li><b>Returns:</b>
<br/>1 on success, 0 on failure
<li><b>Example:</b>
<br/><pre>int _item_number;

void bing {
   _item_numer = add_item("frog", "It wombles!");
} /* bing() */

void remove_bing() {
   remove_item(_item_number);
} /* remove_bing() */
</pre></dl>

<ul><a name="remove_item_by_name">
remove_item_by_name</a><pre>
int remove_item_by_name(string str)
</pre></br>
This method removes an item by the short description.
<br/><ul>
<li><b>Parameters:</b>
<br/>index - the index number to remove
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="setup_item">
setup_item</a><pre>
int setup_item(mixed nam,
               mixed long,
               int no_plural)
</pre></br>
This method setups the item initially.   This is called by the
add_item method in the room itself.
<br/><ul>
<li><b>Parameters:</b>
<br/>nam - the name(s) to add the item for
<br/>long - the long description of the item
<br/>no_plural - do not add a plural flag
<li><b>Returns:</b>
<br/>the index associated with the item

</dl>


[an error occurred while processing this directive]