[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>Inherits</h2>
This class inherits the following classes <a href="std.room.basic_room.c.shtml">/std/room/basic_room.c</a><h2>Includes</h2>
This class includes the following files <a href="include.weather.h.shtml">/include/weather.h</a> and <a href="include.room.h.shtml">/include/room.h</a><h2>Method index</h2>
<dl><ul>
<li><a href="#add_gatherables">add_gatherables</a>(string, string, mixed args)<br/>
Add a gatherable item (or items) to an outside room.
<li><a href="#can_use_for_co_ords">can_use_for_co_ords</a>(string)<li><a href="#cloud_look">cloud_look</a>()<br/>
Returns the cloud look for the cloud item.
<li><a href="#query_climate">query_climate</a>()<br/>
This method returns the climate type for this room
<li><a href="#query_day_light">query_day_light</a>()<br/>
This method returns the current level of day light in the room.
<li><a href="#query_fast_clean_up">query_fast_clean_up</a>()<br/>
This function allows you to check whether or not fast clean-up
is currently allowed.
<li><a href="#query_gatherables">query_gatherables</a>()<br/>
List the gatherables registered in this room.
<li><a href="#query_light_change">query_light_change</a>()<li><a href="#query_weather_handler">query_weather_handler</a>()<br/>
This returns the path to the weather handler currently being used.
<li><a href="#rain_look">rain_look</a>()<br/>
Returns the rain look for the rain item.
<li><a href="#remove_gatherable">remove_gatherable</a>(string)<br/>
Remove a registered gatherable.
<li><a href="#set_climate">set_climate</a>(string)<br/>
This method sets the climate for this room from the standard
climate types.
<li><a href="#set_fast_clean_up">set_fast_clean_up</a>(int)<br/>
This function allows you to disable the fast clean-up of outside
rooms.
<li><a href="#set_light_change">set_light_change</a>(string)<br/>
Sets the function that is called when the light level in a room changes
from day to night, and vice versa.
<li><a href="#set_weather_handler">set_weather_handler</a>(string)<br/>
This sets the weather handler that the room will use.
<li><a href="#sleet_look">sleet_look</a>()<br/>
Returns the sleet look for the sleet item.
<li><a href="#snow_look">snow_look</a>()<br/>
Returns the snow look for the snow item.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="add_gatherables">
add_gatherables</a><pre>
varargs int add_gatherables(string type,
                            string desc,
                            mixed args ...)
</pre></br>
Add a gatherable item (or items) to an outside room.  This function takes
care of everything needed to enable players to gather stuff in outside
rooms.  It utilizes the gathering system and encapsulates the whole process
into a single function.

The only caveat is that in order to be gathered the item(s) must already be
registered with the gather handler.

<br/><ul>
<li><b>Parameters:</b>
<br/>type - the type of item e.g. flower, plant, rock, leaf, fungus, berry
<br/>desc - the items long description in the room
<br/>args - a list of items and their scarcity (percentage probability of
finding this item in a given room). e.g. blackberry, 50, raspberry, 10.

<li><b>Returns:</b>
<br/>1 or 0 for success or failure.

<li><b>See also:</b>
<br/>gathering
.c<li><b>Example:</b>
<br/><pre>add_gatherables("flowers",
                "Here and there spring flowers are clustered on the "
                "forest floor.  It appears that there are bluebells and "
                "primroses among them.",
                "bluebells", 15, "primroses", 25, "snowdrops", 5);

</pre></dl>

<ul><a name="can_use_for_co_ords">
can_use_for_co_ords</a><pre>
int can_use_for_co_ords(string other)
</pre>
<ul><a name="cloud_look">
cloud_look</a><pre>
string cloud_look()
</pre></br>
Returns the cloud look for the cloud item.


<ul><a name="query_climate">
query_climate</a><pre>
string query_climate()
</pre></br>
This method returns the climate type for this room
<br/><ul>
<li><b>Returns:</b>
<br/>climate string
<li><b>See also:</b>
<br/>/obj/handlers/weather
.c</dl>

<ul><a name="query_day_light">
query_day_light</a><pre>
int query_day_light()
</pre></br>
This method returns the current level of day light in the room.  The
day light is the light level the room is set to if there was full sun
and no darkness at all.  Mostly a percentage of this is calculated
in the query_light() method.
<br/><ul>
<li><b>Returns:</b>
<br/>the current daylight level

</dl>

<ul><a name="query_fast_clean_up">
query_fast_clean_up</a><pre>
int query_fast_clean_up()
</pre></br>
This function allows you to check whether or not fast clean-up
is currently allowed.

<br/><ul>
<li><b>Returns:</b>
<br/>0 if it is disabled, 1 if it is allowed

</dl>

<ul><a name="query_gatherables">
query_gatherables</a><pre>
string * query_gatherables()
</pre></br>
List the gatherables registered in this room.

<br/><ul>
<li><b>Returns:</b>
<br/>an array of gatherables.

</dl>

<ul><a name="query_light_change">
query_light_change</a><pre>
string query_light_change()
</pre>
<ul><a name="query_weather_handler">
query_weather_handler</a><pre>
string query_weather_handler()
</pre></br>
This returns the path to the weather handler currently being used.


<ul><a name="rain_look">
rain_look</a><pre>
string rain_look()
</pre></br>
Returns the rain look for the rain item.


<ul><a name="remove_gatherable">
remove_gatherable</a><pre>
int remove_gatherable(string item)
</pre></br>
Remove a registered gatherable.

<br/><ul>
<li><b>Parameters:</b>
<br/>item - the item to be removed.
<li><b>Returns:</b>
<br/>1 or 0 for success or failure.

</dl>

<ul><a name="set_climate">
set_climate</a><pre>
int set_climate(string climate)
</pre></br>
This method sets the climate for this room from the standard
climate types.
<br/><ul>
<li><b>Parameters:</b>
<br/>a - climate type string
<li><b>See also:</b>
<br/>/obj/handlers/weather
.c</dl>

<ul><a name="set_fast_clean_up">
set_fast_clean_up</a><pre>
void set_fast_clean_up(int number)
</pre></br>
This function allows you to disable the fast clean-up of outside
rooms.

<br/><ul>
<li><b>Parameters:</b>
<br/>number - 1 to allow fast clean-up, 0 to disable it

<li><b>See also:</b>
<br/>clean_up_room.c</dl>

<ul><a name="set_light_change">
set_light_change</a><pre>
void set_light_change(string s)
</pre></br>
Sets the function that is called when the light level in a room changes
from day to night, and vice versa.  The light change function is called
with an argument of 0 for sunset, and 1 for sunrise.

Note that the light change function is called from reset(), so it is
imperative to call ::reset() if you have masked reset() and want this
method to work.  This also means that the function will not trigger
immediately the time changes from day to night, but during the next
reset.


<ul><a name="set_weather_handler">
set_weather_handler</a><pre>
void set_weather_handler(string handler)
</pre></br>
This sets the weather handler that the room will use.
NOTE: this call will eventually be removed, so don't use it.


<ul><a name="sleet_look">
sleet_look</a><pre>
string sleet_look()
</pre></br>
Returns the sleet look for the sleet item.


<ul><a name="snow_look">
snow_look</a><pre>
string snow_look()
</pre></br>
Returns the snow look for the snow item.



[an error occurred while processing this directive]