File /std/room/stable.c

Written by Pinkfish

Started Tue Nov 30 23:37:12 PST 1999

Inherits

Includes

Class Index

• stable

Method index

• add_stable_type(string)
  This method adds in a type of transport that can be stabled in this stable.
• add_to_stable(string, object *)
  This method adds the horses to the stable.
• adjust_balance(string, int)
  This method adjusts the balance of the players stable account.
• can_stable_type(string)
  This method checks to see if the specified type of transport can be stabled here.
• check_stable(string, int, object *, string)
  This method is used to confirm that they want to spend theirn money stabling the horse.
• do_deposit(string)
  This method adds money to the players stable account.
• do_list()
  This method shows you a list of all the horse you have in the stables.
• do_return(string)
  This method removes an animal from the stables and runs off with it.
• do_stable(object *)
  This method allows the person to stable their animal.
• load_me()
  This method loads the room.
• print_ok_message(object, object *)
  This message prints out something happy when you actually do the stabling.
• query_balance(string)
  This method returns the players current balance in their stable account.
• query_cost_per_week()
  This method returns the cost per week in the stables.
• query_player_money(object, string)
  This method returns the amount of money on the player and in their account.
• query_save_directory()
  This method queries the directory we will use to save the players transports in.
• query_stable(string)
  This method will find the stable associated with the specified player.
• query_stable_types()
  This method returns the types of transports that can be stabled here.
• query_stabling_cost(string, int)
  This method returns the cost of stabling the horse up to the current time.
• query_start_cost()
  This method returns the basic cost of stabling the animal.
• remove_player_money(object, int, string)
  This method removes money from the player, it will try and remove from their stable balance before taking money off them.
• save_me()
  This method saves the room.
• set_balance(string, int)
  This method sets the current balance of the player stable account.
• set_cost_per_week(int)
  This method sets the cost per week in the stables.
• set_save_directory(string)
  This method sets the directory we will use to save the players transports in.
• set_stable(string, class stable *)
  This method sets the stable to the new value.
• set_start_cost(int)
  This method sets the basic cost of stabling the animal.

Public Functions

These are functions that everyone can access.

.

add_stable_type

void add_stable_type(string type)


This method adds in a type of transport that can be stabled in this stable.

• Parameters:
  type - the type of transport to add

add_to_stable

int add_to_stable(string name,
                  object * horses)


This method adds the horses to the stable.

• Parameters:
  name - the player to whose stable we are adding the horse
  horses - the horses to add
• Returns:
  1 if they are successfuly added
  adjust_balance

  void adjust_balance(string name,
                      int amt)
  

  
  This method adjusts the balance of the players stable account.
  
  • Parameters:
    name - the name of the player
    amt - the amount to adjust the account by
    can_stable_type

    int can_stable_type(string type)
    

    
    This method checks to see if the specified type of transport can be stabled here.
    
    • Parameters:
      type - the type to check
    • Returns:
      1 if it can be stabled, 0 if not
      do_deposit

      int do_deposit(string mon)
      

      
      This method adds money to the players stable account.
      
      • Parameters:
        obs - the money to be deposited
      • Returns:
        1 on success, 0 on failure
        do_list

        int do_list()
        

        
        This method shows you a list of all the horse you have in the stables.
        
        • Returns:
          1 on success, 0 on failure
          do_return

          int do_return(string num)
          

          
          This method removes an animal from the stables and runs off with it.
          
          • Returns:
            1 on success, 0 on failure
            do_stable

            int do_stable(object * obs)
            

            
            This method allows the person to stable their animal. It will cost them (of course).
            load_me

            void load_me()
            

            
            This method loads the room.
            print_ok_message

            void print_ok_message(object me,
                                  object * horses)
            

            
            This message prints out something happy when you actually do the stabling.
            
            • Parameters:
              me - the person doing the stabling
              horses - the horses being stabled
              query_balance

              int query_balance(string name)
              

              
              This method returns the players current balance in their stable account.
              
              • Returns:
                the current stable balance
                query_cost_per_week

                int query_cost_per_week()
                

                
                This method returns the cost per week in the stables.
                
                • Returns:
                  the cost per week
                  query_player_money

                  int query_player_money(object player,
                                         string place)
                  

                  
                  This method returns the amount of money on the player and in their account.
                  
                  • Parameters:
                    player - the player to check the balance of
                    place - the place in which to check the money
                  • Returns:
                    the total money on the player and in their account
                    query_save_directory

                    string query_save_directory()
                    

                    
                    This method queries the directory we will use to save the players transports in.
                    
                    • Returns:
                      the save directory
                      query_stable_types

                      string * query_stable_types()
                      

                      
                      This method returns the types of transports that can be stabled here.
                      
                      • Returns:
                        the types of transport that can be stabled here
                        query_stabling_cost

                        int query_stabling_cost(string name,
                                                int pos)
                        

                        
                        This method returns the cost of stabling the horse up to the current time.
                        
                        • Parameters:
                          name - the name of the owner of the stable
                        • Returns:
                          the cost of stabling the horse
                          query_start_cost

                          int query_start_cost()
                          

                          
                          This method returns the basic cost of stabling the animal.
                          
                          • Returns:
                            the basic cost
                            remove_player_money

                            void remove_player_money(object player,
                                                     int amt,
                                                     string place)
                            

                            
                            This method removes money from the player, it will try and remove from their stable balance before taking money off them.
                            
                            • Parameters:
                              player - the player to remove the money off
                              amt - the amount to remove
                              place - the place the money is from
                              save_me

                              void save_me()
                              

                              
                              This method saves the room.
                              set_balance

                              void set_balance(string name,
                                               int amt)
                              

                              
                              This method sets the current balance of the player stable account.
                              
                              • Parameters:
                                name - the name of the player
                                amt - the amount to set the stable account as
                                set_cost_per_week

                                void set_cost_per_week(int cost_per_week)
                                

                                
                                This method sets the cost per week in the stables.
                                
                                • Parameters:
                                  cost_per_week - the cost per week
                                  set_save_directory

                                  void set_save_directory(string directory)
                                  

                                  
                                  This method sets the directory we will use to save the players transports in.
                                  
                                  • Parameters:
                                    save - the directory to save the transports in
                                    set_start_cost

                                    void set_start_cost(int start_cost)
                                    

                                    
                                    This method sets the basic cost of stabling the animal.
                                    
                                    • Parameters:
                                      start_cost - the basic cost

                                      Protected Functions

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

                                      void check_stable(string mess,
                                                        int cost,
                                                        object * ok,
                                                        string place)
                                      

                                      
                                      This method is used to confirm that they want to spend theirn money stabling the horse.
                                      
                                      • Parameters:
                                        mess - what the player types
                                        cost - the cost of the stabling
                                        ok - the horses being stabled
                                        query_stable

                                        class stable * query_stable(string name)
                                        

                                        
                                        This method will find the stable associated with the specified player.
                                        
                                        • Returns:
                                          the found stable, or 0 if not found
                                          set_stable

                                          void set_stable(string name,
                                                          class stable * value)
                                          

                                          
                                          This method sets the stable to the new value.
                                          
                                          • Parameters:
                                            name - the name of the stable
                                            value - the new value of the stable

                                            Classes

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

                                              class stable {
                                                             int date_in;
                                                             int last_paid;
                                                             string name;
                                                             mixed * save_info;
                                              }