[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 /d/cwc/inherit/well_inherit.c</h2>
Well support for the CWC City room.<p>Written by Taffyd<p>Started Wed Jan 12 21:59:36 2000
<h2>Method index</h2>
<dl><ul>
<li><a href="#create_well">create_well</a>()<br/>
This method creates a well.
<li><a href="#query_well">query_well</a>()<br/>
Bing!
<li><a href="#query_well_func">query_well_func</a>()<br/>
This method returns the well function.
<li><a href="#query_well_position">query_well_position</a>()<br/>
This method is used to determine the current well object's position.
<li><a href="#query_well_refill">query_well_refill</a>()<br/>
This method is used to determine the current state of automatic well 
refilling.
<li><a href="#set_well_func">set_well_func</a>(mixed)<br/>
This method is used to set the well creation function.
<li><a href="#set_well_position">set_well_position</a>(string)<br/>
This method sets the well's position in the room.
<li><a href="#set_well_refill">set_well_refill</a>(int)<br/>
This method is used to enable/disable automatic well filling.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="query_well">
query_well</a><pre>
object query_well()
</pre></br>
Bing! What's our well object?
<br/><ul>
<li><b>Returns:</b>
<br/>the well object 

</dl>

<ul><a name="query_well_func">
query_well_func</a><pre>
mixed query_well_func()
</pre></br>
This method returns the well function.
<br/><ul>
<li><b>Returns:</b>
<br/>the well function, either a function pointer or an array of two 
elements where the first element is an object, the second a string.

</dl>

<ul><a name="query_well_position">
query_well_position</a><pre>
string query_well_position()
</pre></br>
This method is used to determine the current well object's position.
<br/><ul>
<li><b>Returns:</b>
<br/>a string indicating the well's position

</dl>

<ul><a name="query_well_refill">
query_well_refill</a><pre>
int query_well_refill()
</pre></br>
This method is used to determine the current state of automatic well 
refilling. 
<br/><ul>
<li><b>Returns:</b>
<br/>1 if the well is automatically refilled with water, 0 if it is
not.  

</dl>

<ul><a name="set_well_func">
set_well_func</a><pre>
int set_well_func(mixed args)
</pre></br>
This method is used to set the well creation function.  If this function
is not specified, then a standard well object is created.
<br/><ul>
<li><b>Parameters:</b>
<br/>args - the well function.  This can either be a function pointer,
a function, or an array specifying the object in the first element of the
array and the function name as a string in the second element.
<li><b>Returns:</b>
<br/>1 if the well function was correctly set, 0 if it was not.

<li><b>Example:</b>
<br/><pre>set_well_func( (: create_my_well :) );</pre><br/><pre>
set_well_func( "create_my_well" );
set_well_func( ({ this_object(), "create_my_well" }) );</pre><br/><pre>
set_well_func( ({ DISTRICT_HANDLER, "query_well" }) );</pre></dl>

<ul><a name="set_well_position">
set_well_position</a><pre>
void set_well_position(string s)
</pre></br>
This method sets the well's position in the room. It is added as the well's
"there" property.

<ul><a name="set_well_refill">
set_well_refill</a><pre>
void set_well_refill(int i)
</pre></br>
This method is used to enable/disable automatic well filling.  If this is
not used, then your well will not refill and it will have to be done
manually in either your well code or elsewhere. This is enabled by default!
<br/><ul>
<li><b>Parameters:</b>
<br/>i - the status of auto refill. Set this to 1 to enable automatic
refilling.

</dl>


<h2>Protected Functions</h2>
These are functions that only objects inheriting the class can access.<p>
<ul><a name="create_well">
create_well</a><pre>
object create_well()
</pre></br>
This method creates a well. It uses the well function to create a customised 
well, otherwise it creates a normal well with a volume of 50000.
<br/><ul>
<li><b>Returns:</b>
<br/>a well object.

</dl>


[an error occurred while processing this directive]