File /d/cwc/inherit/well_inherit.c

Written by Taffyd

Started Wed Jan 12 21:59:36 2000

Method index

• create_well()
  This method creates a well.
• query_well()
  Bing!
• query_well_func()
  This method returns the well function.
• query_well_position()
  This method is used to determine the current well object's position.
• query_well_refill()
  This method is used to determine the current state of automatic well refilling.
• set_well_func(mixed)
  This method is used to set the well creation function.
• set_well_position(string)
  This method sets the well's position in the room.
• set_well_refill(int)
  This method is used to enable/disable automatic well filling.

Public Functions

These are functions that everyone can access.

.

query_well

object query_well()


Bing! What's our well object?

• Returns:
  the well object

query_well_func

mixed query_well_func()


This method returns the well function.

• Returns:
  the well function, either a function pointer or an array of two elements where the first element is an object, the second a string.
  query_well_position

  string query_well_position()
  

  
  This method is used to determine the current well object's position.
  
  • Returns:
    a string indicating the well's position
    query_well_refill

    int query_well_refill()
    

    
    This method is used to determine the current state of automatic well refilling.
    
    • Returns:
      1 if the well is automatically refilled with water, 0 if it is not.
      set_well_func

      int set_well_func(mixed args)
      

      
      This method is used to set the well creation function. If this function is not specified, then a standard well object is created.
      
      • Parameters:
        args - the well function. This can either be a function pointer, a function, or an array specifying the object in the first element of the array and the function name as a string in the second element.
      • Returns:
        1 if the well function was correctly set, 0 if it was not.
      • Example:
        

        set_well_func( (: create_my_well :) );

        
        

        set_well_func( "create_my_well" );
        set_well_func( ({ this_object(), "create_my_well" }) );

        
        

        set_well_func( ({ DISTRICT_HANDLER, "query_well" }) );

        set_well_position

        void set_well_position(string s)
        

        
        This method sets the well's position in the room. It is added as the well's "there" property.
        set_well_refill

        void set_well_refill(int i)
        

        
        This method is used to enable/disable automatic well filling. If this is not used, then your well will not refill and it will have to be done manually in either your well code or elsewhere. This is enabled by default!
        
        • Parameters:
          i - the status of auto refill. Set this to 1 to enable automatic refilling.

          Protected Functions

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

          object create_well()
          

          
          This method creates a well. It uses the well function to create a customised well, otherwise it creates a normal well with a volume of 50000.
          
          • Returns:
            a well object.