-
add_adjacent_item
void add_adjacent_item(string name,
string desc)
This method sets an item which will be visible as an add_item from adjacent
rooms.
- Parameters:
name - the name of the item
desc - the description of the item
-
find_base_terrain_room
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)
This method figures out the base path to use for the specified room.
- Parameters:
x - the x position
y - the y position
z - the z position
air - checking upwards in air land.
- Returns:
the base room
-
query_adjacent_description
mixed query_adjacent_description()
This method returns the string to use for adjancent descriptions. THis is
the bit tacked onto the end of the long in another room.
- Returns:
the adjacent description
-
query_adjacent_items
mapping query_adjacent_items()
This method returns all the adjacent items.
- Returns:
the mapping of all the adjacent items
-
query_default_height
int query_default_height()
This method returns the default height for the room.
- Returns:
the default height for the room
-
query_exit_to_default_height
int query_exit_to_default_height()
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.
- Returns:
the default height flag
-
query_follow_road
int query_follow_road()
This method returns the follow road flag for the road.
- Returns:
the follow road flag
-
query_minimum_height
int query_minimum_height()
This method returns the mimum height allowed for this factory.
- Returns:
the mimuim height
-
query_room_jump_size
int query_room_jump_size()
This method returns the room jump size for the room
- Returns:
the room jump size
-
query_use_relative_heights
int query_use_relative_heights()
This method returns the use of relative heights for use with
topology based terrians.
- Returns:
the use relative heights flag
-
set_adjacent_description
void set_adjacent_description(mixed desc)
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.
- Parameters:
desc - the adjacent description
-
set_default_height
void set_default_height(int height)
This method sets the default height for the room.
- Parameters:
def - the default height for the room
-
set_exit_to_default_height
void set_exit_to_default_height(int flag)
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.
- Parameters:
flag - set the default height flag
-
set_follow_road
void set_follow_road(int follow)
This method sets the flag that makes us follow the road.
- Parameters:
follow - the follow road flag
-
set_height_rooms
void set_height_rooms(mapping map)
This method sets the height information for the room, setting up
which rooms are used at which heights.
- Parameters:
heights - the heights for the rooms
-
set_minimum_height
void set_minimum_height(int height)
This method sets the minimum height, this is only really useful
in locations which have multiple depth rooms.
- Parameters:
height - the minimum height
-
set_room_jump_size
void set_room_jump_size(int jump)
This method sets the room jump size for the room.
- Parameters:
jump - the room jump size
-
set_use_relative_heights
void set_use_relative_heights(int relative)
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.
- Parameters:
relative - use relative heights for the diffs