[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/room/inherit/terrain_map/factory_base.c</h2>
This is specifically for creating rooms in the world map system, where
it just makes and passes out the room details.  So it does not need to
include all the room crap.<p>Written by Pinkfish<p>Started Fri Jun 28 16:14:19 PDT 2002
<h2>Includes</h2>
This class includes the following files <a href="include.terrain_map.h.shtml">/include/terrain_map.h</a><h2>Method index</h2>
<ul>
<li><a href="#add_adjacent_item">add_adjacent_item</a>(string, string)<br/>
This method sets an item which will be visible as an add_item from adjacent
rooms.
<li><a href="#find_base_terrain_room">find_base_terrain_room</a>(int, int, int, string, int, int ref, int, int)<br/>
This method figures out the base path to use for the specified room.
<li><a href="#query_adjacent_description">query_adjacent_description</a>()<br/>
This method returns the string to use for adjancent descriptions.
<li><a href="#query_adjacent_items">query_adjacent_items</a>()<br/>
This method returns all the adjacent items.
<li><a href="#query_default_height">query_default_height</a>()<br/>
This method returns the default height for the room.
<li><a href="#query_exit_to_default_height">query_exit_to_default_height</a>()<br/>
This method sets if there is a second exit, as well as the normal one
in each direction, which leads to the default height of the room.
<li><a href="#query_follow_road">query_follow_road</a>()<br/>
This method returns the follow road flag for the road.
<li><a href="#query_minimum_height">query_minimum_height</a>()<br/>
This method returns the mimum height allowed for this factory.
<li><a href="#query_room_jump_size">query_room_jump_size</a>()<br/>
This method returns the room jump size for the room
<li><a href="#query_use_relative_heights">query_use_relative_heights</a>()<br/>
This method returns the use of relative heights for use with
topology based terrians.
<li><a href="#set_adjacent_description">set_adjacent_description</a>(mixed)<br/>
This method sets the string to use for adjancent descriptions.
<li><a href="#set_default_height">set_default_height</a>(int)<br/>
This method sets the default height for the room.
<li><a href="#set_exit_to_default_height">set_exit_to_default_height</a>(int)<br/>
This method sets if there is a second exit, as well as the normal one
in each direction, which leads to the default height of the room.
<li><a href="#set_follow_road">set_follow_road</a>(int)<br/>
This method sets the flag that makes us follow the road.
<li><a href="#set_height_rooms">set_height_rooms</a>(mapping)<br/>
This method sets the height information for the room, setting up
which rooms are used at which heights.
<li><a href="#set_minimum_height">set_minimum_height</a>(int)<br/>
This method sets the minimum height, this is only really useful
in locations which have multiple depth rooms.
<li><a href="#set_room_jump_size">set_room_jump_size</a>(int)<br/>
This method sets the room jump size for the room.
<li><a href="#set_use_relative_heights">set_use_relative_heights</a>(int)<br/>
This method sets the use of relative heights for use with
topology based terrians.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_adjacent_item">
add_adjacent_item</a><pre class="autodocfuncdef">
void add_adjacent_item(string name,
                       string desc)
</pre><dd><br />
This method sets an item which will be visible as an add_item from adjacent
rooms.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the item<br />
desc - the description of the item
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="find_base_terrain_room">
find_base_terrain_room</a><pre class="autodocfuncdef">
string find_base_terrain_room(int x,
                              int y,
                              int z,
                              string base_name,
                              int map_room,
                              int ref new_z,
                              int height,
                              int height_here)
</pre><dd><br />
This method figures out the base path to use for the specified room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
x - the x position<br />
y - the y position<br />
z - the z position<br />
air - checking upwards in air land.<br />
<br />
<dd><b>Returns:</b>
<br />the base room
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_adjacent_description">
query_adjacent_description</a><pre class="autodocfuncdef">
mixed query_adjacent_description()
</pre><dd><br />
This method returns the string to use for adjancent descriptions.  THis is
the bit tacked onto the end of the long in another room.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the adjacent description
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_adjacent_items">
query_adjacent_items</a><pre class="autodocfuncdef">
mapping query_adjacent_items()
</pre><dd><br />
This method returns all the adjacent items.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the mapping of all the adjacent items
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_default_height">
query_default_height</a><pre class="autodocfuncdef">
int query_default_height()
</pre><dd><br />
This method returns the default height for the room.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the default height for the room
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_exit_to_default_height">
query_exit_to_default_height</a><pre class="autodocfuncdef">
int query_exit_to_default_height()
</pre><dd><br />
This method sets if there is a second exit, as well as the normal one
in each direction, which leads to the default height of the room.  This
is only true if the default height is different to the current rooms
height.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the default height flag
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_follow_road">
query_follow_road</a><pre class="autodocfuncdef">
int query_follow_road()
</pre><dd><br />
This method returns the follow road flag for the road.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the follow road flag
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_minimum_height">
query_minimum_height</a><pre class="autodocfuncdef">
int query_minimum_height()
</pre><dd><br />
This method returns the mimum height allowed for this factory.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the mimuim height
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_room_jump_size">
query_room_jump_size</a><pre class="autodocfuncdef">
int query_room_jump_size()
</pre><dd><br />
This method returns the room jump size for the room<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the room jump size
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_use_relative_heights">
query_use_relative_heights</a><pre class="autodocfuncdef">
int query_use_relative_heights()
</pre><dd><br />
This method returns the use of relative heights for use with
topology based terrians.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the use relative heights flag
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_adjacent_description">
set_adjacent_description</a><pre class="autodocfuncdef">
void set_adjacent_description(mixed desc)
</pre><dd><br />
This method sets the string to use for adjancent descriptions.  This is
the bit tacked onto the end of the long in another room.  This can be
set to an array of the form ({ obj, func }) or to a function pointer.
In both of these cases it calls the function with two arguements,
room, new_room.  Room is the room being setup and new_room is the
base of the object being joined to.  In both cases, $D will be replaced
with a list of directions, and $d will become a list of directions prepended
with "to the", or "all directions" if it is in every direction.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
desc - the adjacent description
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_default_height">
set_default_height</a><pre class="autodocfuncdef">
void set_default_height(int height)
</pre><dd><br />
This method sets the default height for the room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
def - the default height for the room
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_exit_to_default_height">
set_exit_to_default_height</a><pre class="autodocfuncdef">
void set_exit_to_default_height(int flag)
</pre><dd><br />
This method sets if there is a second exit, as well as the normal one
in each direction, which leads to the default height of the room.  This
is only true if the default height is different to the current rooms
height.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
flag - set the default height flag
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_follow_road">
set_follow_road</a><pre class="autodocfuncdef">
void set_follow_road(int follow)
</pre><dd><br />
This method sets the flag that makes us follow the road.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
follow - the follow road flag
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_height_rooms">
set_height_rooms</a><pre class="autodocfuncdef">
void set_height_rooms(mapping map)
</pre><dd><br />
This method sets the height information for the room, setting up
which rooms are used at which heights.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
heights - the heights for the rooms
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_minimum_height">
set_minimum_height</a><pre class="autodocfuncdef">
void set_minimum_height(int height)
</pre><dd><br />
This method sets the minimum height, this is only really useful
in locations which have multiple depth rooms.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
height - the minimum height <br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_room_jump_size">
set_room_jump_size</a><pre class="autodocfuncdef">
void set_room_jump_size(int jump)
</pre><dd><br />
This method sets the room jump size for the room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
jump - the room jump size
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_use_relative_heights">
set_use_relative_heights</a><pre class="autodocfuncdef">
void set_use_relative_heights(int relative)
</pre><dd><br />
This method sets the use of relative heights for use with
topology based terrians.  If this flag is enabled then
the numbers used in the set_height_rooms are considered
relative to the 'height' of the area, rather than being
fixed numbers.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
relative - use relative heights for the diffs
<br />
<br />
<br /></dl>

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