[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 /obj/handlers/housing.c</h2>
A handler to track player houses.  This handler should only be used for
general houses that are available for sale or rent. Don't add club or
special (eg. guildmaster) houses here or they'll get sold or rented :)

The handler stores information about registered player houses, makes houses
vacant if their owners are idle and charges rent on rented houses.
<p>Written by Ceres
<h2>Includes</h2>
This class includes the following files /include/housing.h, /include/clubs.h, /include/nomic_system.h, /include/login_handler.h, /include/money.h, /include/player_handler.h, /include/shops/bank.h and /include/am_time.h<h2>Method index</h2>
<ul>
<li><a href="#add_house">add_house</a>(string, string *, string, string, int)<br/>
Add a new house to the handler.
<li><a href="#add_rooms">add_rooms</a>(string, string *)<br/>
Add secondary rooms to a house.
<li><a href="#clear_in_arrears">clear_in_arrears</a>(string)<br/>
Mark a house as no longer being in arrears.
<li><a href="#for_sale_name">for_sale_name</a>(string)<br/>
Test to see if the provided name is a reserved name for housing which is
for sale.
<li><a href="#is_house_club">is_house_club</a>(string)<br/>
This method checks to see if the house is a club house property.
<li><a href="#is_house_lease">is_house_lease</a>(string)<br/>
This method checks to see if the house is a leaseable property.
<li><a href="#is_house_rental">is_house_rental</a>(string)<br/>
This method checks to see if the house is a rental property.
<li><a href="#is_owned">is_owned</a>(string)<br/>
This function determines if the specific house is owned by someone
properly and not for sale or under offer.
<li><a href="#modify_house">modify_house</a>(string, string *, string, string, int)<br/>
Modify a houses information.
<li><a href="#query_address">query_address</a>(string)<br/>
Find out the address of a house.
<li><a href="#query_all_housing_area_citizenships">query_all_housing_area_citizenships</a>()<br/>
This method returns all of the current mappings between the housing
area and the citizenship.
<li><a href="#query_bank">query_bank</a>(string)<br/>
Return which bank account rent will be removed from for a house.
<li><a href="#query_city">query_city</a>(string)<br/>
Query the city name for this house
<li><a href="#query_house">query_house</a>(string)<br/>
Check if a given house is registered.
<li><a href="#query_housing_area_bank">query_housing_area_bank</a>(string)<br/>
This method returns the current mappings between the housing area and the
initial bank to use.
<li><a href="#query_housing_area_citizenship">query_housing_area_citizenship</a>(string)<br/>
This method returns the current mappings between the housing area and the
required citizenship.
<li><a href="#query_housing_area_place">query_housing_area_place</a>(string)<br/>
This method returns the current mappings between the housing area and the
money area ("Ankh-Morpork", "Counterweight Continent", etc) to use.
<li><a href="#query_in_arrears">query_in_arrears</a>(string)<br/>
Check to see if the house is in arrears.
<li><a href="#query_lease">query_lease</a>(string)<br/>
Find out when the lease ends

<li><a href="#query_main_room">query_main_room</a>(string)<br/>
Query the main registered room for a given room in a house.
<li><a href="#query_owner">query_owner</a>(string)<br/>
Find out the current owner of this house.
<li><a href="#query_owner_houses">query_owner_houses</a>(string, string)<br/>
The list of houses owned by the specific person in the specific
region.
<li><a href="#query_previous_owner">query_previous_owner</a>(string)<br/>
Query the previous owner (for while a house is up for auction)
<li><a href="#query_region">query_region</a>(string)<br/>
Find out the region a house is in for sale/rental purposes.
<li><a href="#query_rooms">query_rooms</a>(string)<br/>
Get a list of the houses rooms.
<li><a href="#query_street_exit">query_street_exit</a>(string)<br/>
Query the non-player room to which trapped players can be transported
<li><a href="#query_type">query_type</a>(string)<br/>
Find out the type of a house.
<li><a href="#query_vacant">query_vacant</a>(string)<br/>
Function to get a list of houses that are vacant in a given region.
<li><a href="#query_value">query_value</a>(string)<br/>
Find out the current value of a house.
<li><a href="#recover_from_backup">recover_from_backup</a>(string)<li><a href="#remove_house">remove_house</a>(string)<br/>
Remove a house from the list of houses

<li><a href="#remove_housing_area_citizenship">remove_housing_area_citizenship</a>(string)<br/>
This method removes the mapping between a housing area and it's citizenship
requirements.
<li><a href="#remove_rooms">remove_rooms</a>(string, string *)<br/>
Remove secondary rooms from a house.
<li><a href="#rename_house">rename_house</a>(string, string)<br/>
Rename a house.
<li><a href="#set_address">set_address</a>(string, string)<br/>
Set the address of this house.
<li><a href="#set_bank">set_bank</a>(string, string)<br/>
Set the bank account to be used for rent on this house.
<li><a href="#set_city">set_city</a>(string, string)<br/>
Set the city (display) name for this property
<li><a href="#set_for_sale">set_for_sale</a>(string)<br/>
Mark a house as being For Sale this puts it in the list of possible
houses to go into the vacant list.
<li><a href="#set_housing_area_citizenship">set_housing_area_citizenship</a>(string, string)<br/>
This method sets a mapping between a housing area and the citizenship
required to hold a house there.
<li><a href="#set_housing_area_money">set_housing_area_money</a>(string, string, string)<br/>
This sets the type of money to use for the specific housing area.
<li><a href="#set_in_arrears">set_in_arrears</a>(string)<br/>
Mark a house as being in arrears.
<li><a href="#set_lease">set_lease</a>(string, int)<br/>
Set the term of the lease if the property is leased.
<li><a href="#set_owner">set_owner</a>(string, string)<br/>
Set the owner of this house.
<li><a href="#set_region">set_region</a>(string, string)<br/>
Set the region of this house.
<li><a href="#set_street_exit">set_street_exit</a>(string, string)<br/>
Set the street exit for the house
<li><a href="#set_type">set_type</a>(string, int)<br/>
Set the type of a house.
<li><a href="#set_under_offer">set_under_offer</a>(string)<br/>
Mark a house as being Under Offer (to prevent anyone else trying to sell
it too.
<li><a href="#set_value">set_value</a>(string, int)<br/>
Set the value of a particular house.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_house">
add_house</a><pre class="autodocfuncdef">
int add_house(string house,
              string * other_rooms,
              string address,
              string region,
              int type)
</pre><dd><br />
Add a new house to the handler.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the basename of the house<br />
other_rooms - an array of other rooms in the house<br />
address - a string for the address<br />
region - the region (used for house sales)<br />
type - an integer. 1 for owned, 0 for rented.<br />
<br />
<dd><b>Returns:</b>
<br />1 for success, 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_rooms">
add_rooms</a><pre class="autodocfuncdef">
int add_rooms(string house,
              string * rooms)
</pre><dd><br />
Add secondary rooms to a house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the basename of the house<br />
an - array of basenames for the rooms<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="clear_in_arrears">
clear_in_arrears</a><pre class="autodocfuncdef">
int clear_in_arrears(string house)
</pre><dd><br />
Mark a house as no longer being in arrears.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the base name of the house<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="for_sale_name">
for_sale_name</a><pre class="autodocfuncdef">
int for_sale_name(string name)
</pre><dd><br />
Test to see if the provided name is a reserved name for housing which is
for sale.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - Name to test<br />
<br />
<dd><b>Returns:</b>
<br />1 if the name is reserved for the sale process, 0 otherwise
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_house_club">
is_house_club</a><pre class="autodocfuncdef">
int is_house_club(string house)
</pre><dd><br />
This method checks to see if the house is a club house property.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the house to check for<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is club house property<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_vacant">query_vacant()</a>, <a href="#is_house_lease">is_house_lease()</a> and <a href="#is_house_rental">is_house_rental()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="is_house_lease">
is_house_lease</a><pre class="autodocfuncdef">
int is_house_lease(string house)
</pre><dd><br />
This method checks to see if the house is a leaseable property.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the house to check for<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is lease property<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_vacant">query_vacant()</a>, <a href="#is_house_club">is_house_club()</a> and <a href="#is_house_rental">is_house_rental()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="is_house_rental">
is_house_rental</a><pre class="autodocfuncdef">
int is_house_rental(string house)
</pre><dd><br />
This method checks to see if the house is a rental property.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the house to check for<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is rental<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_vacant">query_vacant()</a>, <a href="#is_house_club">is_house_club()</a> and <a href="#is_house_lease">is_house_lease()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="is_owned">
is_owned</a><pre class="autodocfuncdef">
int is_owned(string house)
</pre><dd><br />
This function determines if the specific house is owned by someone
properly and not for sale or under offer.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the house to look up<br />
<br />
<dd><b>Returns:</b>
<br />1 if the house is owned<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_vacant">query_vacant()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="modify_house">
modify_house</a><pre class="autodocfuncdef">
int modify_house(string house,
                 string * other_rooms,
                 string address,
                 string region,
                 int type)
</pre><dd><br />
Modify a houses information.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the basename of the house<br />
other_rooms - an array of other rooms in the house<br />
address - a string for the address<br />
region - the region (used for house sales)<br />
type - an integer. 1 for owned, 0 for rented.<br />
<br />
<dd><b>Returns:</b>
<br />1 for success, 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_address">
query_address</a><pre class="autodocfuncdef">
string query_address(string house)
</pre><dd><br />
Find out the address of a house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />the address.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_all_housing_area_citizenships">
query_all_housing_area_citizenships</a><pre class="autodocfuncdef">
mapping query_all_housing_area_citizenships()
</pre><dd><br />
This method returns all of the current mappings between the housing
area and the citizenship.  This should not be used for anything
except debugging.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />all the housing area stuff
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_bank">
query_bank</a><pre class="autodocfuncdef">
string query_bank(string house)
</pre><dd><br />
Return which bank account rent will be removed from for a house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />the bank name.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_city">
query_city</a><pre class="autodocfuncdef">
string query_city(string house)
</pre><dd><br />
Query the city name for this house<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the registered name of the house<br />
<br />
<dd><b>Returns:</b>
<br />the city in which the house exists
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_house">
query_house</a><pre class="autodocfuncdef">
int query_house(string house)
</pre><dd><br />
Check if a given house is registered.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />1 if its registered, 0 otherwise.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_housing_area_bank">
query_housing_area_bank</a><pre class="autodocfuncdef">
string query_housing_area_bank(string area)
</pre><dd><br />
This method returns the current mappings between the housing area and the
initial bank to use.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to check<br />
<br />
<dd><b>Returns:</b>
<br />the initial bank used, DEFAULT_BANK if none set
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_housing_area_citizenship">
query_housing_area_citizenship</a><pre class="autodocfuncdef">
string query_housing_area_citizenship(string area)
</pre><dd><br />
This method returns the current mappings between the housing area and the
required citizenship.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to check<br />
<br />
<dd><b>Returns:</b>
<br />the citizenship required, 0 if none
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_housing_area_place">
query_housing_area_place</a><pre class="autodocfuncdef">
string query_housing_area_place(string area)
</pre><dd><br />
This method returns the current mappings between the housing area and the
money area ("Ankh-Morpork", "Counterweight Continent", etc) to use.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to check<br />
<br />
<dd><b>Returns:</b>
<br />the money area used, DEFAULT_PLACE if none set
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_in_arrears">
query_in_arrears</a><pre class="autodocfuncdef">
int query_in_arrears(string house)
</pre><dd><br />
Check to see if the house is in arrears.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the main registered room of the house<br />
<br />
<dd><b>Returns:</b>
<br />-1 for unknown house, 0 for not in arrears, 1 for in arrears
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_lease">
query_lease</a><pre class="autodocfuncdef">
int query_lease(string house)
</pre><dd><br />
Find out when the lease ends
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />the time the lease ends.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_main_room">
query_main_room</a><pre class="autodocfuncdef">
string query_main_room(string room)
</pre><dd><br />
Query the main registered room for a given room in a house.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
room - base_name() of the room to test<br />
<br />
<dd><b>Returns:</b>
<br />The main registered room, or 0 if one cannot be found.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_owner">
query_owner</a><pre class="autodocfuncdef">
string query_owner(string house)
</pre><dd><br />
Find out the current owner of this house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />the owners name.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_owner_houses">
query_owner_houses</a><pre class="autodocfuncdef">
string * query_owner_houses(string region,
                            string owner)
</pre><dd><br />
The list of houses owned by the specific person in the specific
region.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
region - the region to find the hosues in<br />
owner - the owner of the houses<br />
<br />
<dd><b>Returns:</b>
<br />the owners of the houses
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_previous_owner">
query_previous_owner</a><pre class="autodocfuncdef">
string query_previous_owner(string house)
</pre><dd><br />
Query the previous owner (for while a house is up for auction)<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the "main" registered room of the house<br />
<br />
<dd><b>Returns:</b>
<br />0 for unknown house or no previous owner, else the previous owner name
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_region">
query_region</a><pre class="autodocfuncdef">
string query_region(string house)
</pre><dd><br />
Find out the region a house is in for sale/rental purposes.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />the region.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_rooms">
query_rooms</a><pre class="autodocfuncdef">
string * query_rooms(string house)
</pre><dd><br />
Get a list of the houses rooms.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />a list of rooms.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_street_exit">
query_street_exit</a><pre class="autodocfuncdef">
string query_street_exit(string house)
</pre><dd><br />
Query the non-player room to which trapped players can be transported<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - Registered name of the house<br />
<br />
<dd><b>Returns:</b>
<br />0 on error (or unregistered exit), otherwise the exit.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_type">
query_type</a><pre class="autodocfuncdef">
int query_type(string house)
</pre><dd><br />
Find out the type of a house. ie. Whether it's rented or owned.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />the type.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_vacant">
query_vacant</a><pre class="autodocfuncdef">
string * query_vacant(string region)
</pre><dd><br />
Function to get a list of houses that are vacant in a given region.
This function is used by the auction system or other sales mechanism.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
region - Region to list houses in<br />
<br />
<dd><b>Returns:</b>
<br />a list of houses.<br /><br />
<dd><b>See also:</b>
<br /><a href="#is_owned">is_owned()</a>, <a href="#is_house_rental">is_house_rental()</a>, <a href="#is_house_lease">is_house_lease()</a> and <a href="#is_house_club">is_house_club()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_value">
query_value</a><pre class="autodocfuncdef">
int query_value(string house)
</pre><dd><br />
Find out the current value of a house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />the value.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="recover_from_backup">
recover_from_backup</a><pre class="autodocfuncdef">
int recover_from_backup(string backup_file)
</pre>
<dt class="autodocfuncname"><a name="remove_house">
remove_house</a><pre class="autodocfuncdef">
int remove_house(string house)
</pre><dd><br />
Remove a house from the list of houses
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_housing_area_citizenship">
remove_housing_area_citizenship</a><pre class="autodocfuncdef">
void remove_housing_area_citizenship(string area)
</pre><dd><br />
This method removes the mapping between a housing area and it's citizenship
requirements.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the housing area to remove the link from
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_rooms">
remove_rooms</a><pre class="autodocfuncdef">
int remove_rooms(string house,
                 string * rooms)
</pre><dd><br />
Remove secondary rooms from a house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the basename of the house<br />
an - array of basenames for the rooms<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="rename_house">
rename_house</a><pre class="autodocfuncdef">
int rename_house(string house,
                 string newhouse)
</pre><dd><br />
Rename a house. This will remove the "main" room and replace it with
another.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the current basename of the house<br />
newhouse - the new basename.
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_address">
set_address</a><pre class="autodocfuncdef">
int set_address(string house,
                string address)
</pre><dd><br />
Set the address of this house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
address - The new address of the house<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_bank">
set_bank</a><pre class="autodocfuncdef">
int set_bank(string house,
             string bank)
</pre><dd><br />
Set the bank account to be used for rent on this house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
owner - The new bank to use<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_city">
set_city</a><pre class="autodocfuncdef">
int set_city(string house,
             string city)
</pre><dd><br />
Set the city (display) name for this property<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - Base registered name of the property<br />
city - Display name for the city<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_for_sale">
set_for_sale</a><pre class="autodocfuncdef">
int set_for_sale(string house)
</pre><dd><br />
Mark a house as being For Sale this puts it in the list of possible
houses to go into the vacant list.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_housing_area_citizenship">
set_housing_area_citizenship</a><pre class="autodocfuncdef">
void set_housing_area_citizenship(string area,
                                  string citizenship)
</pre><dd><br />
This method sets a mapping between a housing area and the citizenship
required to hold a house there.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the housing area to link<br />
citizenship - the citizenship the housing area needs
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_housing_area_money">
set_housing_area_money</a><pre class="autodocfuncdef">
void set_housing_area_money(string area,
                            string bank,
                            string place)
</pre><dd><br />
This sets the type of money to use for the specific housing area.  It
also sets the default bank for the region.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to set the money for<br />
bank - the default bank to use<br />
place - the money type to use (coinage)
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_in_arrears">
set_in_arrears</a><pre class="autodocfuncdef">
int set_in_arrears(string house)
</pre><dd><br />
Mark a house as being in arrears.  This is the step just prior to being
repossessed.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_lease">
set_lease</a><pre class="autodocfuncdef">
int set_lease(string house,
              int lease)
</pre><dd><br />
Set the term of the lease if the property is leased.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
lease - The time the lease ends. If this is zero the default
will be applied.
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_owner">
set_owner</a><pre class="autodocfuncdef">
int set_owner(string house,
              string owner)
</pre><dd><br />
Set the owner of this house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
owner - The new owner of the house<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_region">
set_region</a><pre class="autodocfuncdef">
int set_region(string house,
               string region)
</pre><dd><br />
Set the region of this house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
region - The new region of the house<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_street_exit">
set_street_exit</a><pre class="autodocfuncdef">
int set_street_exit(string house,
                    string exit)
</pre><dd><br />
Set the street exit for the house<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - base registered name of the property<br />
exit - The non-player room to which a player can be safely sent.<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure, 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_type">
set_type</a><pre class="autodocfuncdef">
int set_type(string house,
             int type)
</pre><dd><br />
Set the type of a house. ie. Whether it's rented or owned.
(2 for leased, 1 for rented, 0 for owned).
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - The basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />the type.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_under_offer">
set_under_offer</a><pre class="autodocfuncdef">
int set_under_offer(string house)
</pre><dd><br />
Mark a house as being Under Offer (to prevent anyone else trying to sell
it too.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the basename of the house<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_value">
set_value</a><pre class="autodocfuncdef">
int set_value(string house,
              int value)
</pre><dd><br />
Set the value of a particular house.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
house - the basename of the house<br />
value - the value in monetary units.<br />
<br />
<dd><b>Returns:</b>
<br />1 for success 0 for failure
<br /><br />
<br /></dl>

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