diff --git a/WeatherMethods.h b/WeatherMethods.h index 60b3757..2a093f4 100644 --- a/WeatherMethods.h +++ b/WeatherMethods.h @@ -9,14 +9,35 @@ namespace LuaWeather { - /* GETTERS */ + /** + * Returns the Zone ID of the &Weather as an uint32. + * + * @return uint32 ZoneID + */ int GetZoneId(lua_State* L, Weather* weather) { Eluna::Push(L, weather->GetZone()); return 1; } - /* SETTERS */ + /** + * Sets the &Weather type based on &Weather type and grade supplied. + * + *
+ * enum WeatherType
+ * {
+ * WEATHER_TYPE_FINE = 0,
+ * WEATHER_TYPE_RAIN = 1,
+ * WEATHER_TYPE_SNOW = 2,
+ * WEATHER_TYPE_STORM = 3,
+ * WEATHER_TYPE_THUNDERS = 86,
+ * WEATHER_TYPE_BLACKRAIN = 90
+ * };
+ *
+ *
+ * @param uint32 type : the &Weather type, see above available weather types
+ * @param float grade : the intensity/grade of the &Weather, ranges from 0 to 1
+ */
int SetWeather(lua_State* L, Weather* weather)
{
uint32 weatherType = Eluna::CHECKVAL