DOCS.md

Table of Contents generated with DocToc

• Documentation
  • class WeatherClient()
    • Events
      • opened
      • weather
      • rawWeather
    • getWeather()
  • The Weather Object
    • time
      • time.hour
      • time.minute
    • date
      • date.day
      • date.dayofweek
      • date.week
      • date.month
      • date.dayofmonth
    • weather

Documentation

class WeatherClient()

This class inherits the Node.js EventEmitter

Events

opened

An event for when the client connects to the FWE.

weather

This event emits a slim version of the weather object you can find in the dev tools console on the FWE you can find this exact same object with the event:

rawWeather

The original version of the weather object on the FWE, it contains my extra arrays with names of months/weather/etc.

getWeather()

Returns the weather object if you want to get it whenever you need it. Although you can to that, it's recommended you use the weather event to get the object.

The Weather Object

time

time.hour

Everytime the clock ticks 60, the hour changes and the minutes reset itself.

time.minute

Moves by five fake minutes per five real seconds.

date

date.day

What should be a large number, mesuring the total amount of days that has been recorded.

date.dayofweek

Self Explanatory, it's the day of the week.

date.week

There are only four weeks in a fake month, so account for that.

date.month

date.dayofmonth

As self explanatory as date.dayofweek, it's the day of the month.

weather

The integer specifying the current weather state. The states are: 0-sunny 1-cloudy 2-rainy 3-stormy 4-snowy