Includes

Method index

• modify_item_by_index(int, mixed)
  This method non-destructively modifies the items values.
• modify_item_by_name(string, mixed)
  This method non-destructively modifies the items values.
• print_stuff()
• query_count()
• query_creator_room()
• query_cur_desc()
  This returns the currently matching indexes for the item object.
• query_gather()
  This method figures out what gatherables are available for the current description set.
• query_lng()
  This method returns all the long descriptions for the item object.
• query_plurals()
  This method returns the plurals mapping used in the item object.
• query_short_array()
  This method returns the base array of shorts to be processed in the other short methods.
• query_shrt()
  This method returns all the short descriptions for the item object.
• query_verbs()
  This method returns the verbs mapping used in the item object.
• remove_item_by_index(int)
  This method removes an item by the returned index number from the add_item method.
• remove_item_by_name(string)
  This method removes an item by the short description.
• setup_item(mixed, mixed, int)
  This method setups the item initially.

Public Functions

These are functions that everyone can access.

.

modify_item_by_index

int modify_item_by_index(int index,
                         mixed long)


This method non-destructively modifies the items values. It will not remove the value for this item, remember this! If you add again and again you will end up with multiple of the same object.

• Parameters:
  str - the name to reference the object by
  long - the long bits to change on the item
• Returns:
  1 on success, 0 on failure
• See also:
  /std/room->modify_item_by_name()

modify_item_by_name

int modify_item_by_name(string str,
                        mixed long)


This method non-destructively modifies the items values. It will not remove the value for this item, remember this! If you add again and again you will end up with multiple of the same object.

• Parameters:
  str - the name to reference the object by
  long - the long bits to change on the item
• Returns:
  1 on success, 0 on failure
• See also:
  /std/room->modify_item_by_name()
  print_stuff

  void print_stuff()
  

  query_count

  int query_count()
  

  query_creator_room

  string query_creator_room()
  

  query_cur_desc

  int * query_cur_desc()
  

  
  This returns the currently matching indexes for the item object.
  
  • Returns:
    the array of currently matchig indexes
    query_gather

    mixed * query_gather()
    

    
    This method figures out what gatherables are available for the current description set. The array contains the values passed into the add_item stuff with the "gather" index.
    
    • Returns:
      the current gatherables
      query_lng

      string * query_lng()
      

      
      This method returns all the long descriptions for the item object. The positions in the array correspond to the index used to reference the items.
      
      • Returns:
        the array of long descriptions
        query_plurals

        mapping query_plurals()
        

        
        This method returns the plurals mapping used in the item object.
        
        • Returns:
          the plurals in the item object
          query_short_array

          string * query_short_array()
          

          
          This method returns the base array of shorts to be processed in the other short methods. This is the short without the leading 'the', 'a' whatever...
          
          • Returns:
            the array of shorts
            query_shrt

            string * query_shrt()
            

            
            This method returns all the short descriptions for the item object. The positions in the array correspond to the index used to reference the items.
            
            • Returns:
              the array of long descriptions
              query_verbs

              mapping query_verbs()
              

              
              This method returns the verbs mapping used in the item object.
              
              • Returns:
                the verbs in the item object
                remove_item_by_index

                int remove_item_by_index(int index)
                

                
                This method removes an item by the returned index number from the add_item method.
                
                • Parameters:
                  index - the index number to remove
                • Returns:
                  1 on success, 0 on failure
                • Example:
                  

                  int _item_number;
                  
                  void bing {
                     _item_numer = add_item("frog", "It wombles!");
                  } /* bing() */
                  
                  void remove_bing() {
                     remove_item(_item_number);
                  } /* remove_bing() */
                  

                  remove_item_by_name

                  int remove_item_by_name(string str)
                  

                  
                  This method removes an item by the short description.
                  
                  • Parameters:
                    index - the index number to remove
                  • Returns:
                    1 on success, 0 on failure
                    setup_item

                    int setup_item(mixed nam,
                                   mixed long,
                                   int no_plural)
                    

                    
                    This method setups the item initially. This is called by the add_item method in the room itself.
                    
                    • Parameters:
                      nam - the name(s) to add the item for
                      long - the long description of the item
                      no_plural - do not add a plural flag
                    • Returns:
                      the index associated with the item