====== FFXi Weather Library ======

The FFXi weather library is a small library that exposes a function to obtain the current in-game weather.

The following functions are exposed by this library:

//number// **Weather.GetCurrentWeather**();
  * **Parameters**
    * //Function has no arguments.//
  * **Returns**
    * The current weather id.

The following values are defined from the weather library.

<code lua>
WEATHER_CLEAR       = 0;
WEATHER_SUNNY       = 1;
WEATHER_CLOUDY      = 2;
WEATHER_FOG         = 3;
WEATHER_FIRE        = 4;
WEATHER_FIRE2       = 5;
WEATHER_WATER       = 6;
WEATHER_WATER2      = 7;
WEATHER_EARTH       = 8;
WEATHER_EARTH2      = 9;
WEATHER_WIND        = 10;
WEATHER_WIND2       = 11;
WEATHER_ICE         = 12;
WEATHER_ICE2        = 13;
WEATHER_LIGHTNING   = 14;
WEATHER_LIGHTNING2  = 15;
WEATHER_LIGHT       = 16;
WEATHER_LIGHT2      = 17;
WEATHER_DARK        = 18;
WEATHER_DARK2       = 19;
</code>