File /std/shops/engrave_inherit.c

Written by Macchirton

Example

inherit "/std/room/basic_room";
inherit "/std/shops/engrave";

void init() {
   basic_room::init();
   engrave_init();
} /* init() */

Includes

Method index

• do_engrave(object *, string)
  This method does the actual engraving.
• engrave_init()
  This method should be called in the inheriting room's init function.
• engrave_living(object *)
  This method is called when a living object is attempted to be engraved.
• engrave_no_money(object *, int)
  This method is called if the player does not have enough money to complete the engraving.
• engrave_objects(object *, int)
  This method is called when the engrave is successful.
• engrave_wrong_items(object *)
  This method is called if the objects in question are unable to be engraved.
• set_engrave_language(string)
  This method sets which language (for example, "agatean", or "morporkian") to be used when engraving.

Public Functions

These are functions that everyone can access.

.

engrave_init

void engrave_init()


This method should be called in the inheriting room's init function. IUt will setup the commands to allow the object to be engraved.

• See also:
  do_engrave()

engrave_objects

int engrave_objects(object * obs,
                    int cost)


This method is called when the engrave is successful. This should be overridden in the inheritable to print out the message you wish to say. If this function returns 1 then the default failed message is not used.

• See also:
  do_engrave()
  set_engrave_language

  void set_engrave_language(string lang)
  

  
  This method sets which language (for example, "agatean", or "morporkian") to be used when engraving. It defaults to "general", which is not to be recommended.
  
  • See also:
    do_engrave()

    Protected Functions

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

    int do_engrave(object * things,
                   string message)
    

    
    This method does the actual engraving.
    
    • Parameters:
      things - the things to get engraved.
      message - the message to engarve on the objects
    • See also:
      engrave_init()
      engrave_living

      int engrave_living(object * obs)
      

      
      This method is called when a living object is attempted to be engraved. This should be overridden in the inheritable to print out the message you wish to say. If this function returns 1 then the default failed message is not used.
      
      • Parameters:
        liv - the living objects
      • Returns:
        0 use default fail mesasage, 1 override default fail message
      • See also:
        do_engrave()
        engrave_no_money

        int engrave_no_money(object * obs,
                             int cost)
        

        
        This method is called if the player does not have enough money to complete the engraving. This should be overridden in the inheritable to print out the message you wish to say. If this function returns 1 then the default failed message is not used.
        
        • Parameters:
          obs - the objects which were unable to be engraved
          cost - the cost of the objects to be engraved
        • Returns:
          0 use default fail mesasage, 1 override default fail message
        • See also:
          do_engrave()
          engrave_wrong_items

          int engrave_wrong_items(object * obs)
          

          
          This method is called if the objects in question are unable to be engraved. This should be overridden in the inheritable to print out the message you wish to say. If this function returns 1 then the default failed message is not used.
          
          • Parameters:
            obs - the objects which could not be engraved.
          • Returns:
            0 use default fail mesasage, 1 override default fail message
          • See also:
            do_engrave()