[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/furniture/commercial.c</h2>
This is a fucniture object for makeing all kinds of commercial
furniture.<p>Written by Pinkfish<p>Started Sat Jun  2 16:27:27 PDT 2001
<h2>Inherits</h2>
This class inherits the following classes <a href="std.room.furniture.inherit.furniture_base.c.shtml">/std/room/furniture/inherit/furniture_base.c</a>, <a href="std.basic.item_chat.c.shtml">/std/basic/item_chat.c</a> and <a href="std.object.c.shtml">/std/object.c</a><h2>Includes</h2>
This class includes the following files <a href="include.money.h.shtml">/include/money.h</a>, <a href="include.position.h.shtml">/include/position.h</a>, <a href="include.move_failures.h.shtml">/include/move_failures.h</a> and /include/shops/bank.h<h2>Method index</h2>
<dl><ul>
<li><a href="#adjust_float">adjust_float</a>(int)<br/>
This method adjusts the float of the current room.
<li><a href="#adjust_royalty">adjust_royalty</a>(string, int)<br/>
This method adjusts the royalty for the specific person.
<li><a href="#can_trash_furniture">can_trash_furniture</a>()<br/>
This method checks to see if the furniture can be trashed or not.
<li><a href="#is_allowed">is_allowed</a>(string)<br/>
This method checks to see if the specified person is allowed
to use the room or not.
<li><a href="#is_open_for">is_open_for</a>(string, string)<br/>
This method checks to see if the place is open for the spefic type of
activity.
<li><a href="#query_allowed">query_allowed</a>()<br/>
This method returns the list of people that are allowed.
<li><a href="#query_commercial_furniture">query_commercial_furniture</a>()<br/>
This method checks to see if the item is a commercial
furniture item.
<li><a href="#query_commercial_id">query_commercial_id</a>()<br/>
This returns a unique id for the commercial item.
<li><a href="#query_commercial_information">query_commercial_information</a>()<br/>
This method returns the extra information about the shoip to be used
in the browse.
<li><a href="#query_commercial_name">query_commercial_name</a>()<br/>
This method returns the name of the item for use in finding this specic
type of item in a room.
<li><a href="#query_commercial_size">query_commercial_size</a>()<br/>
This method returns the size of the commericial property.
<li><a href="#query_commercial_type">query_commercial_type</a>()<br/>
This method returns the type of the commericial property.
<li><a href="#query_float">query_float</a>()<br/>
This method returns the float in the current room.
<li><a href="#query_help_file_directory">query_help_file_directory</a>()<li><a href="#query_language">query_language</a>()<br/>
This method returns the owner of the establishment.
<li><a href="#query_money_place">query_money_place</a>()<br/>
This method returns the money place of the object.
<li><a href="#query_owner">query_owner</a>()<br/>
This method returns the owner of the establishment.
<li><a href="#query_parcel_post">query_parcel_post</a>()<br/>
This method returns the parcel post room defined for the room.
<li><a href="#query_revenue">query_revenue</a>()<br/>
This method returns the revenue for this item.
<li><a href="#query_royalty">query_royalty</a>(string)<br/>
This method returns the royalties for the specific person.
<li><a href="#query_save_dir">query_save_dir</a>()<br/>
This method returns the save directory of the outside room.
<li><a href="#query_shop_use_types">query_shop_use_types</a>()<br/>
This method returns the types of thingies for the commercial property.
<li><a href="#query_weekly_status_string">query_weekly_status_string</a>()<br/>
This method returns the weekly status for this furniture object.
<li><a href="#query_weekly_upkeep_cost">query_weekly_upkeep_cost</a>()<br/>
This method sets the weekly upkeep cost for the furniture item.
<li><a href="#reset_weekly_status">reset_weekly_status</a>()<br/>
This resets the weekly statistics for the object.
<li><a href="#set_commercial_id">set_commercial_id</a>(int)<br/>
This method sets the commercial id for the item.
<li><a href="#set_commercial_information">set_commercial_information</a>(string)<br/>
THis method sets any extra information about the shop to be told
when someone does a browse.
<li><a href="#set_commercial_name">set_commercial_name</a>(string)<br/>
This method sets the name of the item for use in finding this specific
type of item in a room.
<li><a href="#set_commercial_size">set_commercial_size</a>(int)<br/>
This method sets the size of the item in terms of commericial
property.
<li><a href="#set_commercial_type">set_commercial_type</a>(string)<br/>
This method sets the type of the item in terms of commericial
property.
<li><a href="#set_revenue">set_revenue</a>(int)<br/>
This method sets the current revenue of the item.
<li><a href="#set_shop_use_types">set_shop_use_types</a>(string *)<br/>
This method sets the types which this item will use for checking.
<li><a href="#set_weekly_upkeep_cost">set_weekly_upkeep_cost</a>(int)<br/>
This method sets the weekly upkeep cost for the furniture item.
<li><a href="#setup_new_commercial_id">setup_new_commercial_id</a>()<br/>
This method sets up a new commercial id for the place.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="adjust_float">
adjust_float</a><pre>
int adjust_float(int amt)
</pre></br>
This method adjusts the float of the current room.
<br/><ul>
<li><b>Parameters:</b>
<br/>amt - the amount to adjust by

</dl>

<ul><a name="adjust_royalty">
adjust_royalty</a><pre>
int adjust_royalty(string person,
                   int amount)
</pre></br>
This method adjusts the royalty for the specific person.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person to adjust the royalty of
<br/>amount - the amount to adjust it by

</dl>

<ul><a name="can_trash_furniture">
can_trash_furniture</a><pre>
int can_trash_furniture()
</pre></br>
This method checks to see if the furniture can be trashed or not.  This
will check to make sure the item can be trashed or not.  The item should
be unable to be trashed if it still contains some player data of
some sort.
<br/><ul>
<li><b>Returns:</b>
<br/>1 if it can be trashed, 0 if not

</dl>

<ul><a name="is_allowed">
is_allowed</a><pre>
int is_allowed(string person)
</pre></br>
This method checks to see if the specified person is allowed
to use the room or not.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person to check

</dl>

<ul><a name="is_open_for">
is_open_for</a><pre>
int is_open_for(string type,
                string person)
</pre></br>
This method checks to see if the place is open for the spefic type of
activity.
<br/><ul>
<li><b>Parameters:</b>
<br/>type - the type of open to check rfor
<br/>person - the person to check for

</dl>

<ul><a name="query_allowed">
query_allowed</a><pre>
string query_allowed()
</pre></br>
This method returns the list of people that are allowed.
<br/><ul>
<li><b>Returns:</b>
<br/>the people that are allowed

</dl>

<ul><a name="query_commercial_furniture">
query_commercial_furniture</a><pre>
int query_commercial_furniture()
</pre></br>
This method checks to see if the item is a commercial
furniture item.
<br/><ul>
<li><b>Returns:</b>
<br/>1 if the item is commercial furniture

</dl>

<ul><a name="query_commercial_id">
query_commercial_id</a><pre>
int query_commercial_id()
</pre></br>
This returns a unique id for the commercial item.  This id will be
unique within the room*
<br/><ul>
<li><b>Returns:</b>
<br/>a unique id

</dl>

<ul><a name="query_commercial_information">
query_commercial_information</a><pre>
string query_commercial_information()
</pre></br>
This method returns the extra information about the shoip to be used
in the browse.
<br/><ul>
<li><b>Returns:</b>
<br/>the extra inforation

</dl>

<ul><a name="query_commercial_name">
query_commercial_name</a><pre>
string query_commercial_name()
</pre></br>
This method returns the name of the item for use in finding this specic
type of item in a room.
<br/><ul>
<li><b>Returns:</b>
<br/>the extra inforation
<li><b>See also:</b>
<br/><a href="std.shops.inherit.commercial.c.shtml#find_commercial_items">/std/shops/inherit/commercial->find_commercial_items()
</a></dl>

<ul><a name="query_commercial_size">
query_commercial_size</a><pre>
int query_commercial_size()
</pre></br>
This method returns the size of the commericial property.
<br/><ul>
<li><b>Returns:</b>
<br/>the size of the commercial property

</dl>

<ul><a name="query_commercial_type">
query_commercial_type</a><pre>
string query_commercial_type()
</pre></br>
This method returns the type of the commericial property.
<br/><ul>
<li><b>Returns:</b>
<br/>the type of the commercial property

</dl>

<ul><a name="query_float">
query_float</a><pre>
int query_float()
</pre></br>
This method returns the float in the current room.
<br/><ul>
<li><b>Returns:</b>
<br/>the float

</dl>

<ul><a name="query_help_file_directory">
query_help_file_directory</a><pre>
string query_help_file_directory()
</pre>
<ul><a name="query_language">
query_language</a><pre>
string query_language()
</pre></br>
This method returns the owner of the establishment.
<br/><ul>
<li><b>Returns:</b>
<br/>the owener of the establishment

</dl>

<ul><a name="query_money_place">
query_money_place</a><pre>
string query_money_place()
</pre></br>
This method returns the money place of the object.
<br/><ul>
<li><b>Returns:</b>
<br/>the money place

</dl>

<ul><a name="query_owner">
query_owner</a><pre>
string query_owner()
</pre></br>
This method returns the owner of the establishment.
<br/><ul>
<li><b>Returns:</b>
<br/>the owener of the establishment

</dl>

<ul><a name="query_parcel_post">
query_parcel_post</a><pre>
string query_parcel_post()
</pre></br>
This method returns the parcel post room defined for the room.
<br/><ul>
<li><b>Returns:</b>
<br/>the parcel post room defined for the room

</dl>

<ul><a name="query_revenue">
query_revenue</a><pre>
int query_revenue()
</pre></br>
This method returns the revenue for this item.


<ul><a name="query_royalty">
query_royalty</a><pre>
int query_royalty(string person)
</pre></br>
This method returns the royalties for the specific person.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person to get the royalty of
<li><b>Returns:</b>
<br/>the royalty

</dl>

<ul><a name="query_save_dir">
query_save_dir</a><pre>
string query_save_dir()
</pre></br>
This method returns the save directory of the outside room.
<br/><ul>
<li><b>Returns:</b>
<br/>the save directory

</dl>

<ul><a name="query_shop_use_types">
query_shop_use_types</a><pre>
string * query_shop_use_types()
</pre></br>
This method returns the types of thingies for the commercial property.
<br/><ul>
<li><b>Returns:</b>
<br/>the shop types

</dl>

<ul><a name="query_weekly_status_string">
query_weekly_status_string</a><pre>
string query_weekly_status_string()
</pre></br>
This method returns the weekly status for this furniture object.
<br/><ul>
<li><b>Returns:</b>
<br/>the weekly status for the this object

</dl>

<ul><a name="query_weekly_upkeep_cost">
query_weekly_upkeep_cost</a><pre>
int query_weekly_upkeep_cost()
</pre></br>
This method sets the weekly upkeep cost for the furniture item.


<ul><a name="reset_weekly_status">
reset_weekly_status</a><pre>
void reset_weekly_status()
</pre></br>
This resets the weekly statistics for the object.


<ul><a name="set_commercial_id">
set_commercial_id</a><pre>
void set_commercial_id(int id)
</pre></br>
This method sets the commercial id for the item.
<br/><ul>
<li><b>Parameters:</b>
<br/>id - the unique id to use

</dl>

<ul><a name="set_commercial_information">
set_commercial_information</a><pre>
void set_commercial_information(string info)
</pre></br>
THis method sets any extra information about the shop to be told
when someone does a browse.
<br/><ul>
<li><b>Parameters:</b>
<br/>info - the infomation

</dl>

<ul><a name="set_commercial_name">
set_commercial_name</a><pre>
void set_commercial_name(string name)
</pre></br>
This method sets the name of the item for use in finding this specific
type of item in a room.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name
<li><b>See also:</b>
<br/><a href="std.shops.inherit.commercial.c.shtml#find_commercial_items">/std/shops/inherit/commercial->find_commercial_items()
</a></dl>

<ul><a name="set_commercial_size">
set_commercial_size</a><pre>
void set_commercial_size(int size)
</pre></br>
This method sets the size of the item in terms of commericial
property.  100 is very large and takes up all of a large
commercial property.  For example, a 100 item shop will be
size 100.
<br/><ul>
<li><b>Parameters:</b>
<br/>size - the new size of the item

</dl>

<ul><a name="set_commercial_type">
set_commercial_type</a><pre>
void set_commercial_type(string type)
</pre></br>
This method sets the type of the item in terms of commericial
property.
<br/><ul>
<li><b>Parameters:</b>
<br/>type - the new type of the item

</dl>

<ul><a name="set_revenue">
set_revenue</a><pre>
void set_revenue(int revenue)
</pre></br>
This method sets the current revenue of the item.
<br/><ul>
<li><b>Parameters:</b>
<br/>revenue - the new revenue of the object

</dl>

<ul><a name="set_shop_use_types">
set_shop_use_types</a><pre>
void set_shop_use_types(string * types)
</pre></br>
This method sets the types which this item will use for checking.
<br/><ul>
<li><b>Parameters:</b>
<br/>types - this sets the types for the shop

</dl>

<ul><a name="set_weekly_upkeep_cost">
set_weekly_upkeep_cost</a><pre>
void set_weekly_upkeep_cost(int cost)
</pre></br>
This method sets the weekly upkeep cost for the furniture item.


<ul><a name="setup_new_commercial_id">
setup_new_commercial_id</a><pre>
void setup_new_commercial_id()
</pre></br>
This method sets up a new commercial id for the place.



[an error occurred while processing this directive]