File /std/shops/inherit/craft_shop_category.c

Written by Pinkfish

Started Thu Feb 5 15:39:57 CST 1998

Inherits

Includes

Method index

• add_shop_category(string)
  This method adds a category into the accept list immediately.
• choose_category(string, function, int, string, object *, string *)
  This method chooses which category to set the item in.
• do_change_category(object *, string)
• do_list_category(string)
  This method lists a specific category of items.
• query_default_category()
  This method returns the current default category for the shop.
• query_extra_sell_check()
  This method returns the extra sell check function.
• query_real_category_name(string)
  This correctly cases the name.
• remove_shop_category(string)
  This method forcibly removes a category from the accepted list.
• set_category_description(string, string)
  This method sets the description of the category.
• set_category_information(string, string)
  This method sets the description of the category.
• set_default_category(string)
  This method sets the default category for the item.
• set_extra_sell_check(function)
  This method sets the extra sell function for the shop.
• setup_category(function, int, string, object *)
  This method sets a category on the sellables.
• update_categories()
  You should run this when you change the system to the category based system.

Public Functions

These are functions that everyone can access.

.

add_shop_category

void add_shop_category(string category)


This method adds a category into the accept list immediately. This should really only be used for initialy setting up the shop.

• Parameters:
  category - the name of the category

do_change_category

int do_change_category(object * obs,
                       string new_category)

do_list_category

int do_list_category(string category)


This method lists a specific category of items.

• Parameters:
  category - the category to list
  query_default_category

  string query_default_category()
  

  
  This method returns the current default category for the shop.
  
  • Returns:
    the default category
    query_extra_sell_check

    function query_extra_sell_check()
    

    
    This method returns the extra sell check function.
    
    • Returns:
      the extra sell check function
    • See also:
      set_extra_sell_check()
      query_real_category_name

      string query_real_category_name(string in_cat)
      

      
      This correctly cases the name.
      
      • Returns:
        the correctly cases name, or 0 for failure
        remove_shop_category

        void remove_shop_category(string category)
        

        
        This method forcibly removes a category from the accepted list.
        
        • Parameters:
          category - the category to remove
          set_category_description

          void set_category_description(string category,
                                        string description)
          

          
          This method sets the description of the category.
          
          • Parameters:
            category - the name of the category
            description - the new description
            set_category_information

            void set_category_information(string category,
                                          string information)
            

            
            This method sets the description of the category.
            
            • Parameters:
              category - the name of the category
              info - the new information
              set_default_category

              void set_default_category(string category)
              

              
              This method sets the default category for the item. This must be setup for something useful to happen.
              
              • Parameters:
                category - the default category
                set_extra_sell_check

                void set_extra_sell_check(function func)
                

                
                This method sets the extra sell function for the shop. The extra sell function is called after the sell process is almost finished. It can check for extra things needed in the sell process, like which page of the book to browse.
                
                • Parameters:
                  func - the extra sell function
                • See also:
                  query_extra_sell_check() and complete_sell()
                  update_categories

                  void update_categories()
                  

                  
                  You should run this when you change the system to the category based system. It will go through and set anything without a category to have a category.

                  Protected Functions

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

                  void choose_category(string category,
                                       function func,
                                       int value,
                                       string name,
                                       object * sellables,
                                       string * categories)
                  

                  
                  This method chooses which category to set the item in.
                  
                  • Parameters:
                    category - the category to choose
                    func - the function to call on exit
                    value - the current value of the item
                    name - the name of object
                    sellables - the items for sale
                    setup_category

                    void setup_category(function func,
                                        int value,
                                        string name,
                                        object * sellables)
                    

                    
                    This method sets a category on the sellables. It is called from within the craft shop code itself.
                    
                    • Parameters:
                      func - the function to call on exit
                      value - the current value of the item
                      name - the name of object
                      sellables - the items for sale