[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/basic/id_match.c</h2>
This inheritable contains all the code to deal with matching objects in
the parser.<p>Written by Pinkfish.
<h2>Includes</h2>
This class includes the following files <a href="include.obj_parser.h.shtml">/include/obj_parser.h</a><h2>Method index</h2>
<dl><ul>
<li><a href="#is_matching_object">is_matching_object</a>(string *, object, class obj_match_context)<br/>
This method is used by upper objects that only wish to match the
ids and not mess with all the context stuff.
<li><a href="#parse_match_object">parse_match_object</a>(string *, object, class obj_match_context)<br/>
This code is for the new parser.
<li><a href="#query_no_all">query_no_all</a>()<br/>
This method returns the no all flag's current value.
<li><a href="#set_no_all">set_no_all</a>(int)<br/>
This sets the no all flag.
<li><a href="#update_parse_match_context">update_parse_match_context</a>(class obj_match_context, int, int)<br/>
This method updates the context.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="parse_match_object">
parse_match_object</a><pre>
mixed parse_match_object(string * input,
                         object viewer,
                         class obj_match_context context)
</pre></br>
This code is for the new parser...  It returns an array which contains
two elements.  The first is the type of the match, plural or singular,
and the second is the object it matched.  Usualy this_object() but
it can be used to swap new objects.
<br/><ul>
<li><b>Parameters:</b>
<br/>input - the input string
<br/>viewer - the person viewing the object
<br/>context - the contex this is to be taken in
<li><b>Returns:</b>
<br/>({ type, ob }), 0 on failure

</dl>

<ul><a name="query_no_all">
query_no_all</a><pre>
int query_no_all()
</pre></br>
This method returns the no all flag's current value.
If this flag is set to true then the object
will not respond to 'all' requests and must be accessed with it's real
name.
<br/><ul>
<li><b>Returns:</b>
<br/>the current value of the flag

</dl>


<h2>Protected Functions</h2>
These are functions that only objects inheriting the class can access.<p>
<ul><a name="is_matching_object">
is_matching_object</a><pre>
int is_matching_object(string * input,
                       object viewer,
                       class obj_match_context context)
</pre></br>
This method is used by upper objects that only wish to match the
ids and not mess with all the context stuff.  This method will
return a combination of OBJ_PARSER_MATCH_SINGULAR and
OBJ_PARSER_MATCH_PLURAL.
<br/><ul>
<li><b>Parameters:</b>
<br/>input - the input string
<br/>viewer - the person viewing the object
<br/>context - the contex this is to be taken in
<li><b>Returns:</b>
<br/>the singular/plural match flags

</dl>

<ul><a name="set_no_all">
set_no_all</a><pre>
void set_no_all(int no_all)
</pre></br>
This sets the no all flag.  If this flag is set to true then the object
will not respond to 'all' requests and must be accessed with it's real
name.
<br/><ul>
<li><b>Parameters:</b>
<br/>no_all - the no all flag value

</dl>

<ul><a name="update_parse_match_context">
update_parse_match_context</a><pre>
int update_parse_match_context(class obj_match_context context,
                               int num,
                               int singular)
</pre></br>
This method updates the context.  It returns the number of the objects
we match, and you pass in the number of objects that we are.
<br/><ul>
<li><b>Parameters:</b>
<br/>context - the context to update
<br/>num - the number of objects
<br/>singular - return from is_matching_object
<li><b>Returns:</b>
<br/>the number of matched objects

</dl>


[an error occurred while processing this directive]