File /std/shops/inherit/auction_house.c

Written by Pinkfish

Started Mon Apr 30 22:47:38 PDT 2001

Inherits

Includes

Class Index

• auction

Method index

• add_item_to_auction(object *, string, int, string, int, string, mixed)
  This method puts an item up for auction.
• bid_on_item(class auction, int, string)
  This method makes a bid on an item.
• confirm_auction(string, string, object *, int, int)
  Confirm the addition
• do_add(string, object *, string, string)
  This method adds an item for bidding.
• do_bid(string, string)
  This method makes a bid on the specified item.
• do_browse(string)
  This method allows you to browse the item.
• do_claim()
  This method claims anything that you can bought and is waiting for pickup.
• do_info()
  This method shoes information about the auction house, like the amount of time for each type of auction.
• do_list()
  This method lists all the current auctions.
• do_withdraw(string)
  This method withdraws the item from bidding.
• finish_auction(class auction)
  This method finishes the aution on the specified item.
• force_finish_auction(string)
  This method forcibly finishes the auction on the specified item.
• load_me()
  This method loads the auction house up.
• next_auction_finish()
  This method figures out when the next auction finishes and sets up a timeout.
• query_auction_end_string(class auction)
  This method printsd a nice string showing how long till the auction ends.
• query_auction_item(string)
  This method finds the item based on some useful string.
• query_auction_objects(class auction)
  This method finds the objects associated with the auction item.
• query_auction_times()
  This method returns the length of auctions in seconds.
• query_auctions()
  This method returns the current list of available auctions.
• query_finished_auctions()
  This method returns the current list of finished auctions.
• query_last_auction_finish_time()
  This method figures out when the last auction will finish.
• query_save_file()
  This method queries the save file name.
• query_time_end_string(int)
  This method prints a nice string showing how long it is till then end of the thing.
• remove_auction_item(class auction)
  This method removes the specified auction from the list.
• remove_finished_auction_item(class auction)
  This method removes the specified auction from the list.
• remove_finished_auction_number(int)
• retry_auction(class auction)
  This method retries the aution on the specified item.
• save_me()
  This method saves the auction house.
• set_allowed_add(int)
  This method sets the allowed add flag.
• set_auction_time(string, int)
  This method sets the length of auctions in seconds.
• set_check_can_bid(function)
  This method sets a function to be called to check if someone can bid or not.
• set_max_auctions(int)
  This method sets the maximum number of simultaneous auctions.
• set_max_retries(int)
  This method sets the number of times an item will be retried before the auction is failed.
• set_min_bid_increase(int)
  This method sets the minimum bid increase (as a percentage of the current bid).
• set_retrieval_time(int)
  This method sets the length of the retrieval time.
• set_save_file(string)
  This method sets the save file name.

Public Functions

These are functions that everyone can access.

.

add_item_to_auction

int add_item_to_auction(object * obs,
                        string name,
                        int reserve,
                        string seller,
                        int length,
                        string end_function,
                        mixed extra)


This method puts an item up for auction.

• Parameters:
  obs - the objects to sell
  name - the name of the item
  reserve - the reserve price of the item
  seller - the seller of the item
  length - the length of the auction
  end_function - the function to call when the item is sold
• Returns:
  1 on success, 0 on failure

bid_on_item

void bid_on_item(class auction auct,
                 int bid,
                 string person)


This method makes a bid on an item.

• Parameters:
  item - the item to bid on
  bid - the amount to bid
  person - the person making the bid
  confirm_auction

  void confirm_auction(string check,
                       string name,
                       object * obs,
                       int reserve,
                       int len)
  

  
  Confirm the addition
  do_add

  int do_add(string name,
             object * obs,
             string res_str,
             string length)
  

  
  This method adds an item for bidding.
  
  • Parameters:
    name - the name to put them up for bidding as
    obs - the objects to auction
    res_str - the reserve price
    length - the length of the auction
  • Returns:
    1 on success, 0 on failed
    do_bid

    int do_bid(string id,
               string bid)
    

    
    This method makes a bid on the specified item.
    
    • Parameters:
      id - the item to bid on
      bid - the amount to bid
    • Returns:
      1 on success, 0 on failure
      do_browse

      int do_browse(string id)
      

      
      This method allows you to browse the item.
      
      • Parameters:
        id - the id of the auction thing to browse
        do_claim

        int do_claim()
        

        
        This method claims anything that you can bought and is waiting for pickup.
        do_info

        int do_info()
        

        
        This method shoes information about the auction house, like the amount of time for each type of auction.
        
        • Returns:
          1 on success
          do_list

          int do_list()
          

          
          This method lists all the current auctions.
          do_withdraw

          int do_withdraw(string id)
          

          
          This method withdraws the item from bidding. You pay a penalty when you do this, 10% of the current item cost.
          
          • Parameters:
            id - the id to withdraw
            finish_auction

            void finish_auction(class auction auction)
            

            
            This method finishes the aution on the specified item.
            
            • Parameters:
              auction - the auction item that is being finished
              force_finish_auction

              void force_finish_auction(string id)
              

              
              This method forcibly finishes the auction on the specified item. This is only to be used for debugging purposes.
              
              • Parameters:
                auction - the auction item that is being finished
                load_me

                void load_me()
                

                
                This method loads the auction house up.
                next_auction_finish

                void next_auction_finish()
                

                
                This method figures out when the next auction finishes and sets up a timeout.
                query_auction_end_string

                string query_auction_end_string(class auction auction)
                

                
                This method printsd a nice string showing how long till the auction ends.
                
                • Parameters:
                  auction - the auction to get an end string for
                • Returns:
                  auction end string
                  query_auction_item

                  class auction query_auction_item(string id)
                  

                  
                  This method finds the item based on some useful string.
                  
                  • Parameters:
                    id - the id to lookup
                  • Returns:
                    the auction item, 0 in the case of error
                    query_auction_objects

                    object * query_auction_objects(class auction auct)
                    

                    
                    This method finds the objects associated with the auction item.
                    
                    • Parameters:
                      auction - the auction item
                    • Returns:
                      the objects associated with it
                      query_auction_times

                      mapping query_auction_times()
                      

                      
                      This method returns the length of auctions in seconds.
                      
                      • Returns:
                        the length of auctions.
                        query_auctions

                        class auction * query_auctions()
                        

                        
                        This method returns the current list of available auctions.
                        
                        • Returns:
                          the current auctions
                          query_finished_auctions

                          class auction * query_finished_auctions()
                          

                          
                          This method returns the current list of finished auctions.
                          
                          • Returns:
                            the current auctions
                            query_last_auction_finish_time

                            int query_last_auction_finish_time()
                            

                            
                            This method figures out when the last auction will finish.
                            
                            • Returns:
                              when the last auction finished
                              query_save_file

                              string query_save_file()
                              

                              
                              This method queries the save file name.
                              query_time_end_string

                              string query_time_end_string(int left)
                              

                              
                              This method prints a nice string showing how long it is till then end of the thing.
                              
                              • Parameters:
                                left - the time to get the difference for
                              • Returns:
                                time end string
                                remove_auction_item

                                void remove_auction_item(class auction auction)
                                

                                
                                This method removes the specified auction from the list.
                                
                                • Parameters:
                                  auction - the auction item that is being removed
                                  remove_finished_auction_item

                                  void remove_finished_auction_item(class auction auction)
                                  

                                  
                                  This method removes the specified auction from the list.
                                  
                                  • Parameters:
                                    auction - the auction item that is being removed
                                    remove_finished_auction_number

                                    void remove_finished_auction_number(int i)
                                    

                                    retry_auction

                                    void retry_auction(class auction auction)
                                    

                                    
                                    This method retries the aution on the specified item.
                                    
                                    • Parameters:
                                      auction - the auction item that is being finished
                                      save_me

                                      void save_me()
                                      

                                      
                                      This method saves the auction house.
                                      set_allowed_add

                                      void set_allowed_add(int flag)
                                      

                                      
                                      This method sets the allowed add flag. If theis flag is set to 0 then it is not possible for players to add items for auctions.
                                      
                                      • Parameters:
                                        flag - the allowed add flag
                                        set_auction_time

                                        void set_auction_time(string index,
                                                              int i)
                                        

                                        
                                        This method sets the length of auctions in seconds.
                                        
                                        • Parameters:
                                          index - the name of the auction type to change
                                          i - the length of auctions.
                                          set_check_can_bid

                                          void set_check_can_bid(function f)
                                          

                                          
                                          This method sets a function to be called to check if someone can bid or not.
                                          
                                          • Parameters:
                                            func - the function to call
                                            set_max_auctions

                                            void set_max_auctions(int i)
                                            

                                            
                                            This method sets the maximum number of simultaneous auctions.
                                            
                                            • Parameters:
                                              i - the number of items.
                                              set_max_retries

                                              void set_max_retries(int i)
                                              

                                              
                                              This method sets the number of times an item will be retried before the auction is failed.
                                              
                                              • Parameters:
                                                i - the number of seconds the item will wait for someone to claim it.
                                                set_min_bid_increase

                                                void set_min_bid_increase(int i)
                                                

                                                
                                                This method sets the minimum bid increase (as a percentage of the current bid).
                                                
                                                • Parameters:
                                                  i - percentage
                                                  set_retrieval_time

                                                  void set_retrieval_time(int i)
                                                  

                                                  
                                                  This method sets the length of the retrieval time.
                                                  
                                                  • Parameters:
                                                    i - the number of seconds the item will wait for someone to claim it.
                                                    set_save_file

                                                    void set_save_file(string fname)
                                                    

                                                    
                                                    This method sets the save file name.
                                                    
                                                    • Parameters:
                                                      fname - the save file name

                                                      Classes

                                                      These are nice data types for dealing with... Data!
                                                      • auction

                                                        class auction {
                                                                        mixed save_stuff;
                                                                        int time_started;
                                                                        int auction_length;
                                                                        string name;
                                                                        string seller;
                                                                        string current_bidder;
                                                                        int bid;
                                                                        int reserve;
                                                                        int retries;
                                                                        string end_function;
                                                                        mixed extra;
                                                        }