File /std/shops/inherit/clone_on_demand.c

Any object can inherit this, and methods should be put in place in the inheriting file that end up calling create_real_object() which will sort out duplicating the item and returning an object pointer to the one you can deal with.

See also:
add_object .c

Written by Pinkfish Aquilo

Example

inherit "clone_on_demand";
int do_buy( objects *obs );

void setup(){
  set_name("shop");
  set_short("widget shop");
  add_object( "sprocket" );
}

object create_object( string arg ){
  if( arg == "sprocket" )
    return clone_object( "/path/of/sprocket" );
}

void init(){
  add_command("buy", "");
}

int do_buy( object *obs ){
  object ob;
  foreach(ob in obs){
    widget = create_real_object(ob);
    widget->move( this_player() );
  }
  add_succeeded_mess( "$N buy$s $I.\n", obs );
  return 1;
}

Includes

Method index

• add_object(string, int, string)
  This method is used to add an item to the storage.
• create_real_object(object)
  The main point of entry.
• query_cont()
  This method returns the container which is used to keep one copy of each items in storage.
• query_items_left(string *)
  This function can be used to check the quantity left of an array of items.
• query_num_items_left(object)
  Returns how more times object ob can be duplicated
• query_number_left(string)
  This function returns the quantity of particular object available to be cloned on demand.
• query_object_domain()
  This method returns the domain the objects will be created from.
• set_object_domain(string)
  This method sets the domain the objects will be created from.

Public Functions

These are functions that everyone can access.

.

add_object

varargs int add_object(string name,
                       int max_per_reset,
                       string display_as)


This method is used to add an item to the storage. When this method is called, create_object() is called (with the object name as an arg) in the inheriting file. If no object is returned by that function, the name is cloned with clone_object(), and failing that request_item() is called in the armoury against the name. This method makes add_weapon() and add_armour() obsolete.

• Parameters:
  name - the name of the object to add.
  max_per_reset - the maximum number of items to be available at any one time
  display_as - the name that this item is displayed as in shops
• Returns:
  1 if the item was added successfully to the store, 0 if it was not.
• Example:
  

  add_object( "frog", 1 + random( 3 ) );
  // This will try and create an object called frog, in the order mentioned
  // above

  
  

  add_object( "/obj/food/apple.food", 0 );
  // Add unlimited numbers of apples.

query_cont

object query_cont()


This method returns the container which is used to keep one copy of each items in storage.

• Returns:
  the object container
  query_items_left

  int * query_items_left(string * names)
  

  
  This function can be used to check the quantity left of an array of items. It returns a parallel array of integers. In other words the array it returns contains the numbers of stock in array positions corresponding to the array positions of the objects it was passed.
  
  • Parameters:
    names - an array of the short names of the items you wish to query
  • Returns:
    an array of integers, each one returning like query_number_left would for the object in that position of the object array.
  • See also:
    query_number_left .c
  • Example:
    

    query_items_left( ({ "banana" , "melon" }) )
    would return ({ 12 , 6 }) if there were 12 bananas and 6 melons left.

    query_num_items_left

    int query_num_items_left(object ob)
    

    
    Returns how more times object ob can be duplicated
    
    • Parameters:
      ob - the object to test
    • Returns:
      how many more times
      query_number_left

      int query_number_left(string name)
      

      
      This function returns the quantity of particular object available to be cloned on demand. In matching which object is the one in question it uses the short name of the object, which is passed as an argument to the function.
      
      • Parameters:
        name - is the short name of the object you wish to query.
      • Returns:
        the number left, returns INFINITE_LEFT if the shop has an infinite number, returns -1 if the item isn't stocked.
        query_object_domain

        string query_object_domain()
        

        
        This method returns the domain the objects will be created from.
        
        • Returns:
          the domain the objects are created from
          set_object_domain

          void set_object_domain(string domain)
          

          
          This method sets the domain the objects will be created from. The default objects will always be matched as well. So setting this will allow objects from the default of the specified armoury domain.
          
          • Parameters:
            domain - the domain to try and create from
          • Example:
            

            set_object_domain("cwc");
            

            Protected Functions

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

            object create_real_object(object thing)
            

            
            The main point of entry. 'thing' should be an object already placed in the clone_on_demand store container via 'add_object'. This method then duplicates that object, replaces the original copy in the container with this new one, and returns the original which can be delt with as normal.
            
            • Parameters:
              thing - an object in the store
            • Returns:
              the original object
            • See also:
              add_object .c