File /std/basic/wearable.c

See also:
/obj/armour.c and /obj/clothing.c

Written by Pinkfish

Inherits

Includes

Method index

• add_immune_to(mixed)
  This adds a new type of damage that the object is immune to.
• add_wear_effect(string)
  This method adds a new wear effect to the current wear effect array.
• query_immune_to()
  This returns the list of types of damage that the object is immune to.
• query_race()
  This method queries the race type.
• query_type()
  This method returns the current type(s) associated with the object.
• query_wear_effects()
  This method returns the list of effects to be added to the wearer when it is worn.
• query_wear_remove_func()
  This method returns the current function associated with wearing and removing the item.
• query_wearable()
  This method tells us if the object is wearable.
• query_worn_by()
  This method returns the person who is currently wearing the object.
• remove_immune_to(mixed)
  This method removes a type of damage that the weapon is immune to.
• remove_wear_remove_func()
  Unset the wear_remove func.
• set_race(string)
  This method sets the race type that can wear this item.
• set_type(mixed)
  This method sets the type(s) which are associated with the item.
• set_wear_effects(string *)
  This method sets the list of effects to be added to the wearer when it is worn.
• set_wear_remove_func(mixed, string)
  This method sets the current function associated with wearing and removing the item.
• set_worn_by(object)
  This method sets the object as being worn by the passed in object.

Public Functions

These are functions that everyone can access.

.

add_immune_to

void add_immune_to(mixed args)


This adds a new type of damage that the object is immune to. The parameter can either be a string or an array of strings being the types of damage to be immune to.

• Parameters:
  args - the type of damage to be immune to
• See also:
  remove_immune_to() and query_immune_to()
• Example:
  

  inherit "/std/basic/wearable";
  
  void setup() {
     ...
     add_immune_to("sharp");
     ...
  } /* setup() */

  
  

  inherit "/std/basic/wearable";
  
  void setup() {
     ...
     add_immune_to("sharp");
     ...
  } /* setup() */

add_wear_effect

void add_wear_effect(string effect)


This method adds a new wear effect to the current wear effect array. These effects will automaticly be added when worn and removed when taken off.

• Parameters:
  effect - the effect to add
• See also:
  query_wear_effects() and set_wear_effects()
  query_immune_to

  string * query_immune_to()
  

  
  This returns the list of types of damage that the object is immune to.
  
  • Returns:
    the list of damage we are immune to
  • See also:
    /std/basic/condition.c, add_immune_to() and remove_immune_to()
    query_race

    string query_race()
    

    
    This method queries the race type.
    
    • Returns:
      race
    • See also:
      set_race .c
      query_type

      string query_type()
      

      
      This method returns the current type(s) associated with the object. If this method returns a string then there is only one type for this object. If it returns a string then there is more than one type associated with an object. An example of something with more than one type is a skirt, which is a dress and a shirt at the same time.
      
      • Returns:
        the current type of the item
      • See also:
        set_type()
        query_wear_effects

        string * query_wear_effects()
        

        
        This method returns the list of effects to be added to the wearer when it is worn. These effects will automaticly be added when worn and removed when taken off.
        
        • Returns:
          the list of effects to be added to the wearer when worn
        • See also:
          set_wear_effects() and add_wear_effect()
          query_wear_remove_func

          mixed * query_wear_remove_func()
          

          
          This method returns the current function associated with wearing and removing the item.
          
          • Returns:
            the current function for wearing and removing the clothing
          • See also:
            set_wear_remove_func()
            query_wearable

            int query_wearable()
            

            
            This method tells us if the object is wearable. In the case of a wearable object it will always return 1.
            
            • Returns:
              always returns 1
              query_worn_by

              object query_worn_by()
              

              
              This method returns the person who is currently wearing the object.
              
              • Returns:
                the current wearer of the object
              • See also:
                set_worn_by()
                remove_immune_to

                void remove_immune_to(mixed args)
                

                
                This method removes a type of damage that the weapon is immune to.
                
                • Parameters:
                  args - the type(s) of damage to remove immunity too
                • See also:
                  add_immune_to() and query_immune_to()
                  remove_wear_remove_func

                  } void remove_wear_remove_func()
                  

                  
                  Unset the wear_remove func.
                  set_race

                  void set_race(string str)
                  

                  
                  This method sets the race type that can wear this item. Unless the item has specific race requirements just leave this empty.
                  
                  • Parameters:
                    race - the race name.
                    set_type

                    void set_type(mixed word)
                    

                    
                    This method sets the type(s) which are associated with the item. If the parameter is a string then a single type is associated with the item, if the parameter is an array then a list of types is associated with the object. If any of these types are not legal and error message will be produced.
                    
                    • Parameters:
                      word - the new type(s) to set for the object
                    • See also:
                      query_type()
                      set_wear_effects

                      void set_wear_effects(string * effects)
                      

                      
                      This method sets the list of effects to be added to the wearer when it is worn. These effects will automaticly be added when worn and removed when taken off.
                      
                      • Parameters:
                        effects - the array of effects to be added to the wearer when worn
                      • See also:
                        query_wear_effects() and add_wear_effect()
                        set_wear_remove_func

                        void set_wear_remove_func(mixed file,
                                                  string func)
                        

                        
                        This method sets the current function associated with wearing and removing the item. The value of this function should be choosen carefully, using an object reference for the name will work but it will not then be able to restored from the save file. The same goes for using function pointers. It is better to use a real file name and a string function name.

                        The function will be called with two arguments, the first argument will be 0 if the object is being removed or the object which it is being worn by if it is non-zero. The second argument will always be the person who was wearing the item, or is about to wear the item.
                        

                        • Parameters:
                          file - the file to call the function on
                          func - the function to call
                        • See also:
                          query_wear_remove_func()
                        • Example:
                          

                          inherit "/std/basic/wearable";
                          
                          void setup() {
                             ...
                             set_wear_remove_func(base_name(this_object()), "do_fluff");
                             ...
                          } /* setup() */
                          
                          void do_fluff(object ob, object player) {
                             if (!ob) {
                                write(capitalize(the_short()) + " is being removed.\n");
                             } else {
                                write(capitalize(the_short()) + " is being worn.\n");
                             }
                          } /* do_fluff() */

                          set_worn_by

                          int set_worn_by(object thing)
                          

                          
                          This method sets the object as being worn by the passed in object. It calls all the various worn functions and sets up or removes all the effects associated with the object.

                          If the object is alreadying being worn the wear_remove_function will be called with an argument of 0. The method taken_off will be called on the object wearing the object for all the effects associated with this object.

                          If the object is being set to be worn by someone the the wear_remove function will be called with an argument being the person who is to wear the object. All of the effects associated with the object will be added to the wearer.

                          This calls the method 'person_removing_item' on the effect when some one removes the item. This can be used to make sure the effects are taken off when the item is removed.
                          

                          • Parameters:
                            thing - the new person to wear the object (0 for worn by no one)
                          • Returns:
                            1 if successful, 0 on failure
                          • See also:
                            set_wear_remove_func() and add_wear_effect()