Inherits

Includes

Method index

• add_gatherables(string, string, mixed args)
  Add a gatherable item (or items) to an outside room.
• can_use_for_co_ords(string)
• cloud_look()
  Returns the cloud look for the cloud item.
• query_climate()
  This method returns the climate type for this room
• query_day_light()
  This method returns the current level of day light in the room.
• query_fast_clean_up()
  This function allows you to check whether or not fast clean-up is currently allowed.
• query_gatherables()
  List the gatherables registered in this room.
• query_light_change()
• query_weather_handler()
  This returns the path to the weather handler currently being used.
• rain_look()
  Returns the rain look for the rain item.
• remove_gatherable(string)
  Remove a registered gatherable.
• set_climate(string)
  This method sets the climate for this room from the standard climate types.
• set_fast_clean_up(int)
  This function allows you to disable the fast clean-up of outside rooms.
• set_light_change(string)
  Sets the function that is called when the light level in a room changes from day to night, and vice versa.
• set_weather_handler(string)
  This sets the weather handler that the room will use.
• sleet_look()
  Returns the sleet look for the sleet item.
• snow_look()
  Returns the snow look for the snow item.

Public Functions

These are functions that everyone can access.

.

add_gatherables

varargs int add_gatherables(string type,
                            string desc,
                            mixed args ...)


Add a gatherable item (or items) to an outside room. This function takes care of everything needed to enable players to gather stuff in outside rooms. It utilizes the gathering system and encapsulates the whole process into a single function. The only caveat is that in order to be gathered the item(s) must already be registered with the gather handler.

• Parameters:
  type - the type of item e.g. flower, plant, rock, leaf, fungus, berry
  desc - the items long description in the room
  args - a list of items and their scarcity (percentage probability of finding this item in a given room). e.g. blackberry, 50, raspberry, 10.
• Returns:
  1 or 0 for success or failure.
• See also:
  gathering .c
• Example:
  

  add_gatherables("flowers",
                  "Here and there spring flowers are clustered on the "
                  "forest floor.  It appears that there are bluebells and "
                  "primroses among them.",
                  "bluebells", 15, "primroses", 25, "snowdrops", 5);
  
  

can_use_for_co_ords

int can_use_for_co_ords(string other)

cloud_look

string cloud_look()


Returns the cloud look for the cloud item.
query_climate

string query_climate()


This method returns the climate type for this room

• Returns:
  climate string
• See also:
  /obj/handlers/weather .c
  query_day_light

  int query_day_light()
  

  
  This method returns the current level of day light in the room. The day light is the light level the room is set to if there was full sun and no darkness at all. Mostly a percentage of this is calculated in the query_light() method.
  
  • Returns:
    the current daylight level
    query_fast_clean_up

    int query_fast_clean_up()
    

    
    This function allows you to check whether or not fast clean-up is currently allowed.
    
    • Returns:
      0 if it is disabled, 1 if it is allowed
      query_gatherables

      string * query_gatherables()
      

      
      List the gatherables registered in this room.
      
      • Returns:
        an array of gatherables.
        query_light_change

        string query_light_change()
        

        query_weather_handler

        string query_weather_handler()
        

        
        This returns the path to the weather handler currently being used.
        rain_look

        string rain_look()
        

        
        Returns the rain look for the rain item.
        remove_gatherable

        int remove_gatherable(string item)
        

        
        Remove a registered gatherable.
        
        • Parameters:
          item - the item to be removed.
        • Returns:
          1 or 0 for success or failure.
          set_climate

          int set_climate(string climate)
          

          
          This method sets the climate for this room from the standard climate types.
          
          • Parameters:
            a - climate type string
          • See also:
            /obj/handlers/weather .c
            set_fast_clean_up

            void set_fast_clean_up(int number)
            

            
            This function allows you to disable the fast clean-up of outside rooms.
            
            • Parameters:
              number - 1 to allow fast clean-up, 0 to disable it
            • See also:
              clean_up_room.c
              set_light_change

              void set_light_change(string s)
              

              
              Sets the function that is called when the light level in a room changes from day to night, and vice versa. The light change function is called with an argument of 0 for sunset, and 1 for sunrise. Note that the light change function is called from reset(), so it is imperative to call ::reset() if you have masked reset() and want this method to work. This also means that the function will not trigger immediately the time changes from day to night, but during the next reset.
              set_weather_handler

              void set_weather_handler(string handler)
              

              
              This sets the weather handler that the room will use. NOTE: this call will eventually be removed, so don't use it.
              sleet_look

              string sleet_look()
              

              
              Returns the sleet look for the sleet item.
              snow_look

              string snow_look()
              

              
              Returns the snow look for the snow item.