File /std/room/furniture/commercial.c

Written by Pinkfish

Started Sat Jun 2 16:27:27 PDT 2001

Inherits

Includes

Method index

• adjust_float(int)
  This method adjusts the float of the current room.
• adjust_royalty(string, int)
  This method adjusts the royalty for the specific person.
• can_trash_furniture()
  This method checks to see if the furniture can be trashed or not.
• is_allowed(string)
  This method checks to see if the specified person is allowed to use the room or not.
• is_open_for(string, string)
  This method checks to see if the place is open for the spefic type of activity.
• query_allowed()
  This method returns the list of people that are allowed.
• query_commercial_furniture()
  This method checks to see if the item is a commercial furniture item.
• query_commercial_id()
  This returns a unique id for the commercial item.
• query_commercial_information()
  This method returns the extra information about the shoip to be used in the browse.
• query_commercial_name()
  This method returns the name of the item for use in finding this specic type of item in a room.
• query_commercial_size()
  This method returns the size of the commericial property.
• query_commercial_type()
  This method returns the type of the commericial property.
• query_float()
  This method returns the float in the current room.
• query_help_file_directory()
• query_language()
  This method returns the owner of the establishment.
• query_money_place()
  This method returns the money place of the object.
• query_owner()
  This method returns the owner of the establishment.
• query_parcel_post()
  This method returns the parcel post room defined for the room.
• query_revenue()
  This method returns the revenue for this item.
• query_royalty(string)
  This method returns the royalties for the specific person.
• query_save_dir()
  This method returns the save directory of the outside room.
• query_shop_use_types()
  This method returns the types of thingies for the commercial property.
• query_weekly_status_string()
  This method returns the weekly status for this furniture object.
• query_weekly_upkeep_cost()
  This method sets the weekly upkeep cost for the furniture item.
• reset_weekly_status()
  This resets the weekly statistics for the object.
• set_commercial_id(int)
  This method sets the commercial id for the item.
• set_commercial_information(string)
  THis method sets any extra information about the shop to be told when someone does a browse.
• set_commercial_name(string)
  This method sets the name of the item for use in finding this specific type of item in a room.
• set_commercial_size(int)
  This method sets the size of the item in terms of commericial property.
• set_commercial_type(string)
  This method sets the type of the item in terms of commericial property.
• set_revenue(int)
  This method sets the current revenue of the item.
• set_shop_use_types(string *)
  This method sets the types which this item will use for checking.
• set_weekly_upkeep_cost(int)
  This method sets the weekly upkeep cost for the furniture item.
• setup_new_commercial_id()
  This method sets up a new commercial id for the place.

Public Functions

These are functions that everyone can access.

.

adjust_float

int adjust_float(int amt)


This method adjusts the float of the current room.

• Parameters:
  amt - the amount to adjust by

adjust_royalty

int adjust_royalty(string person,
                   int amount)


This method adjusts the royalty for the specific person.

• Parameters:
  person - the person to adjust the royalty of
  amount - the amount to adjust it by
  can_trash_furniture

  int can_trash_furniture()
  

  
  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.
  
  • Returns:
    1 if it can be trashed, 0 if not
    is_allowed

    int is_allowed(string person)
    

    
    This method checks to see if the specified person is allowed to use the room or not.
    
    • Parameters:
      person - the person to check
      is_open_for

      int is_open_for(string type,
                      string person)
      

      
      This method checks to see if the place is open for the spefic type of activity.
      
      • Parameters:
        type - the type of open to check rfor
        person - the person to check for
        query_allowed

        string query_allowed()
        

        
        This method returns the list of people that are allowed.
        
        • Returns:
          the people that are allowed
          query_commercial_furniture

          int query_commercial_furniture()
          

          
          This method checks to see if the item is a commercial furniture item.
          
          • Returns:
            1 if the item is commercial furniture
            query_commercial_id

            int query_commercial_id()
            

            
            This returns a unique id for the commercial item. This id will be unique within the room*
            
            • Returns:
              a unique id
              query_commercial_information

              string query_commercial_information()
              

              
              This method returns the extra information about the shoip to be used in the browse.
              
              • Returns:
                the extra inforation
                query_commercial_name

                string query_commercial_name()
                

                
                This method returns the name of the item for use in finding this specic type of item in a room.
                
                • Returns:
                  the extra inforation
                • See also:
                  /std/shops/inherit/commercial->find_commercial_items()
                  query_commercial_size

                  int query_commercial_size()
                  

                  
                  This method returns the size of the commericial property.
                  
                  • Returns:
                    the size of the commercial property
                    query_commercial_type

                    string query_commercial_type()
                    

                    
                    This method returns the type of the commericial property.
                    
                    • Returns:
                      the type of the commercial property
                      query_float

                      int query_float()
                      

                      
                      This method returns the float in the current room.
                      
                      • Returns:
                        the float
                        query_help_file_directory

                        string query_help_file_directory()
                        

                        query_language

                        string query_language()
                        

                        
                        This method returns the owner of the establishment.
                        
                        • Returns:
                          the owener of the establishment
                          query_money_place

                          string query_money_place()
                          

                          
                          This method returns the money place of the object.
                          
                          • Returns:
                            the money place
                            query_owner

                            string query_owner()
                            

                            
                            This method returns the owner of the establishment.
                            
                            • Returns:
                              the owener of the establishment
                              query_parcel_post

                              string query_parcel_post()
                              

                              
                              This method returns the parcel post room defined for the room.
                              
                              • Returns:
                                the parcel post room defined for the room
                                query_revenue

                                int query_revenue()
                                

                                
                                This method returns the revenue for this item.
                                query_royalty

                                int query_royalty(string person)
                                

                                
                                This method returns the royalties for the specific person.
                                
                                • Parameters:
                                  person - the person to get the royalty of
                                • Returns:
                                  the royalty
                                  query_save_dir

                                  string query_save_dir()
                                  

                                  
                                  This method returns the save directory of the outside room.
                                  
                                  • Returns:
                                    the save directory
                                    query_shop_use_types

                                    string * query_shop_use_types()
                                    

                                    
                                    This method returns the types of thingies for the commercial property.
                                    
                                    • Returns:
                                      the shop types
                                      query_weekly_status_string

                                      string query_weekly_status_string()
                                      

                                      
                                      This method returns the weekly status for this furniture object.
                                      
                                      • Returns:
                                        the weekly status for the this object
                                        query_weekly_upkeep_cost

                                        int query_weekly_upkeep_cost()
                                        

                                        
                                        This method sets the weekly upkeep cost for the furniture item.
                                        reset_weekly_status

                                        void reset_weekly_status()
                                        

                                        
                                        This resets the weekly statistics for the object.
                                        set_commercial_id

                                        void set_commercial_id(int id)
                                        

                                        
                                        This method sets the commercial id for the item.
                                        
                                        • Parameters:
                                          id - the unique id to use
                                          set_commercial_information

                                          void set_commercial_information(string info)
                                          

                                          
                                          THis method sets any extra information about the shop to be told when someone does a browse.
                                          
                                          • Parameters:
                                            info - the infomation
                                            set_commercial_name

                                            void set_commercial_name(string name)
                                            

                                            
                                            This method sets the name of the item for use in finding this specific type of item in a room.
                                            
                                            • Parameters:
                                              name - the name
                                            • See also:
                                              /std/shops/inherit/commercial->find_commercial_items()
                                              set_commercial_size

                                              void set_commercial_size(int size)
                                              

                                              
                                              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.
                                              
                                              • Parameters:
                                                size - the new size of the item
                                                set_commercial_type

                                                void set_commercial_type(string type)
                                                

                                                
                                                This method sets the type of the item in terms of commericial property.
                                                
                                                • Parameters:
                                                  type - the new type of the item
                                                  set_revenue

                                                  void set_revenue(int revenue)
                                                  

                                                  
                                                  This method sets the current revenue of the item.
                                                  
                                                  • Parameters:
                                                    revenue - the new revenue of the object
                                                    set_shop_use_types

                                                    void set_shop_use_types(string * types)
                                                    

                                                    
                                                    This method sets the types which this item will use for checking.
                                                    
                                                    • Parameters:
                                                      types - this sets the types for the shop
                                                      set_weekly_upkeep_cost

                                                      void set_weekly_upkeep_cost(int cost)
                                                      

                                                      
                                                      This method sets the weekly upkeep cost for the furniture item.
                                                      setup_new_commercial_id

                                                      void setup_new_commercial_id()
                                                      

                                                      
                                                      This method sets up a new commercial id for the place.