File /std/basic/light.c

Written by Pinkfish

Method index

• add_inform_light_change(object)
  This method adds an object to be informed of light change events.
• adjust_light(int)
  This changes the current light level.
• inform_of_light_level_change(object)
  This method tells all our environments that the light level has changed.
• light_level_changed()
  This method tells us that the light levels have changed and should be recalculated when queried.
• new_recalc_light()
  This method forces a recalculation of the current light level in this object.
• query_light()
  This returns the total light level of the object.
• query_light_needs_inform()
• query_my_light()
  This method returns the light associated with this object.
• query_opaque()
  This method checks to see if the object is opaque or not.
• remove_inform_light_change(object)
  This method removes an object from the current list of things to be informed of a light change.
• reset_opaque()
  This method makes the object transparent (default).
• set_light(int)
  This sets the current light level.
• set_opaque()
  This method makes this object opaque.

Public Functions

These are functions that everyone can access.

.

add_inform_light_change

void add_inform_light_change(object ob)


This method adds an object to be informed of light change events.

• Parameters:
  ob - the object to be informed of light change events

adjust_light

int adjust_light(int number)


This changes the current light level.

• Parameters:
  number - the amount to chage it by
• See also:
  set_light(), query_my_light() and query_light()
  inform_of_light_level_change

  void inform_of_light_level_change(object ob)
  

  
  This method tells all our environments that the light level has changed.
  
  • Parameters:
    ob - the object whose environment we should tell about the change
  • See also:
    light_level_changed()
    light_level_changed

    void light_level_changed()
    

    
    This method tells us that the light levels have changed and should be recalculated when queried.
    
    • See also:
      inform_of_light_level_change()
      new_recalc_light

      varargs void new_recalc_light()
      

      
      This method forces a recalculation of the current light level in this object.
      query_light

      int query_light()
      

      
      This returns the total light level of the object. This includes the light levels of anything that happens to be inside us.
      
      • Returns:
        current light level
      • See also:
        query_my_light() and set_light()
        query_light_needs_inform

        int query_light_needs_inform()
        

        query_my_light

        int query_my_light()
        

        
        This method returns the light associated with this object. This does not count the light levels of anything inside us.
        query_opaque

        int query_opaque()
        

        
        This method checks to see if the object is opaque or not.
        
        • Returns:
          1 if it is opaque, 0 if not
          remove_inform_light_change

          void remove_inform_light_change(object ob)
          

          
          This method removes an object from the current list of things to be informed of a light change.
          
          • Parameters:
            ob - the object to remove from the inform list
            reset_opaque

            void reset_opaque()
            

            
            This method makes the object transparent (default). This means that the light from items inside does escape.
            
            • See also:
              set_opaque() and set_light()
              set_light

              int set_light(int number)
              

              
              This sets the current light level. This method calls adjust_light() with the correct value to set the light level.
              
              Light Levels:
              Magically Darkened Room 0-
              Absolutely Dark Room 0
              Standard Dark Room 5
              Dimly Lit Room 20
              Mine Shaft with Candles 30
              Partially Lit Room 50
              Well Lit Room 60
              Shaded Forest 60
              Brightly Lit Room 80
              Direct Sunlight 100
              Explosion or flash 200+
              
              
              • Parameters:
                number - The new light level.
              • See also:
                query_my_light() and query_light()
                set_opaque

                void set_opaque()
                

                
                This method makes this object opaque. This means that light does not escpae from it.
                
                • See also:
                  not_obscured_object() and set_light()