[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/help_files.c</h2>
This inheritable allows objects or rooms to have help attached to them.<p>Written by Pinkfish
<h2>Includes</h2>
This class includes the following files /include/nroff.h and /include/room.h<h2>Method index</h2>
<ul>
<li><a href="#add_help_file">add_help_file</a>(string)<br/>
This method sets up the help for the room.
<li><a href="#help_function">help_function</a>()<br/>
This method returns the help data as a function pointer.
<li><a href="#help_string">help_string</a>()<br/>
This method returns the help as a string.
<li><a href="#query_help_file_directory">query_help_file_directory</a>()<br/>
This method is used to get the directory for the help files.
<li><a href="#query_help_files">query_help_files</a>()<br/>
This method returns the help files for the current room.
<li><a href="#remove_help_file">remove_help_file</a>(string)<br/>
This method removes the specified help file from the current ones.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_help_file">
add_help_file</a><pre class="autodocfuncdef">
void add_help_file(string help_file)
</pre><dd><br />
This method sets up the help for the room.  All the help file names are
relative to /doc/room unless a complete path is specified.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
help_file - the help file name<br />
<br />
<dd><b>See also:</b>
<br />nroff
.c<br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="help_function">
help_function</a><pre class="autodocfuncdef">
mixed * help_function()
</pre><dd><br />
This method returns the help data as a function pointer.
The function pointer needs to be evaluated to create the actual text.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the function pointer for the help text
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="help_string">
help_string</a><pre class="autodocfuncdef">
string help_string()
</pre><dd><br />
This method returns the help as a string.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the help as a string
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_help_file_directory">
query_help_file_directory</a><pre class="autodocfuncdef">
string query_help_file_directory()
</pre><dd><br />
This method is used to get the directory for the help files.
This should be overridden in higher up objects that use this object.
<br />

<dt class="autodocfuncname"><a name="query_help_files">
query_help_files</a><pre class="autodocfuncdef">
string * query_help_files()
</pre><dd><br />
This method returns the help files for the current room.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the array of help files
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_help_file">
remove_help_file</a><pre class="autodocfuncdef">
void remove_help_file(string help_file)
</pre><dd><br />
This method removes the specified help file from the current ones.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
help_file - the help file name to remove
<br />
<br />
<br /></dl>

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