[Package Index | Mudlib Index | Effect Index]

Inherits

This class inherits the following classes /std/shops/auction_house.c

Includes

This class includes the following files /include/housing.h, /include/shops/bank.h, /include/money.h, /include/move_failures.h, /include/room/auction.h, /include/clubs.h and /include/am_time.h

Method index

Public Functions

These are functions that everyone can access.

add_house
int add_house(string house)

Add a property for auction.

Returns:
1 on success, 0 on failure


add_housing_area
void add_housing_area(string area)

This method adds in an area to which the real estate office will look for properties.

Parameters:
area - the area to look in


after_reset
void after_reset()

This runs through the list of vacant properties and checks to see if it should add them up for auction or not.
check_can_bid
int check_can_bid(object person,
                  class auction which,
                  int bid_amount,
                  string extra)

This method checks to make sure they have enough money in their bank accounts to make the bid. This function should be setup to be called as the big checking function in the inherit of this room.

Parameters:
person - the person being checked for bidding
which - the auction being tested to be bid on
bid_amount - how much they are bidding
extra - the extra sale information, specific for club houses


do_agreement
int do_agreement()

Request a new rental agreement for a property they might have lost.
do_agreement_club
int do_agreement_club(string which)

Request a new rental agreement for a property they might have lost.
housing_auction
void housing_auction(int event_type,
                     class auction auct,
                     string house,
                     string buyer,
                     int cost,
                     object * obs)

This function is called during the various phases of the housing auction. When each phase ends this method is called and anything that needs to be done for the end of the phase is sorted out.

Parameters:
event_type - the event that has finished
auct - the auction that just finished
house - the path of the property being auctioned
buyer - the buyer of the property (if sold)
cost - how much the property costs
obs - the things that were sold (rental agreementsin this case)


query_city
string query_city()

Returns the city the real estate place thinks it lives in.
query_club_reserve
int query_club_reserve()

Returns the reserve price for club properties
query_default_bank
string query_default_bank(string region)

This returns the default bank for a region. If not set, it uses Bing's.
query_deposit_fee
int query_deposit_fee(string id)

This method sets the deposit required to be deposit * number of rooms
query_housing_areas
string * query_housing_areas()

This method returns all the areas in which the real estate office will look for properties.

Returns:
the areas to look for properties


query_language
string query_language()

Returns the language the real estate place will use for its agreements.
query_lease_reserve
int query_lease_reserve()

Returns the reserve price for leased properties
query_maximum_bids
int query_maximum_bids()

This method returns the maximum number of bids that a player may have open simultaneously at this auction house.
query_rent_reserve
int query_rent_reserve()

Returns the reserve price for rental properties
query_sale_reserve
int query_sale_reserve()

Returns the reserve price for sale properties
reset_auctions_to_under_offer
void reset_auctions_to_under_offer()

This function runs down the list of current auctions and makes sure they are all registered as "Under Offer" so if for some reason they are not, they won't be put up for sale again.
set_city
void set_city(string where)

This is just a cosmetic function to help set up the agreements.

Parameters:
where - the city to which the agreements will say the property defaults to when you cease to own it


set_language
void set_language(string lang)

This is just a cosmetic function to help set up the agreements.

Parameters:
the - agreements be written in


set_maximum_bids
int set_maximum_bids(int val)

This method allows an auction house to set a maximum number of concurrent bids.

Protected Functions

These are functions that only objects inheriting the class can access.

set_club_reserve
void set_club_reserve(int amount)

Sets the reserve price for club properties

Parameters:
amount - The amount to set the reserve to


set_lease_reserve
void set_lease_reserve(int amount)

Sets the reserve price for leased properties

Parameters:
amount - The amount to set the reserve to


set_rent_reserve
void set_rent_reserve(int amount)

Sets the reserve price for rental properties

Parameters:
amount - The amount to set the reserve to


set_sale_reserve
void set_sale_reserve(int amount)

Sets the reserve price for sale properties

Parameters:
amount - The amount to set the reserve to