Weather

{:links-list}

INSTALLATION

  1. Open the downloaded ZIP product file and drop the folder in it somewhere in your resources folder.
  2. Add your product key (get it here) to the settings.ini file
  3. Add start BigDaddy-Weather to your server.cfg.

DO NOT RENAME THE FOLDER.

If you change the name of the folder it will not function correctly so leave the name as it is.

{:is-danger}

VMENU USERS READ THIS

You MUST disable all dynamic weather functions within vmenu or they will conflict with this resource and you will get crazy flashing weather. If you are using the time sync in this script you must also disable all time sync functions in vmenu or it will not work properly.

CONFIGURATION

SETTING DEFAULT DESCRIPTION
[licensing]
key1 none This is where you put your product key
[settings]
weatherChangeTimer 20 How often does the weather change (in minutes)
transitionTime 30 How many seconds does it take to move from one weather type to the next
rainBias 5 The percentage chance of rain (this is to cut down on how much it rains)
useAcePermissions* true Restrict who can change the weather with commands
acePermission* command The permission to use for the previous option (default is the command permission)
startupWeather CLOUDS valid types: EXTRASUNNY, SMOG, FOGGY, OVERCAST, CLOUDS, CLEARING, RAIN, THUNDER, SNOW, BLIZZARD, SNOWLIGHT, XMAS, HALLOWEEN
syncTime true sync time between all clients so everyone is at the same time of day
serverStartHour 7 this is the hour of the day that is set when the server starts up (0-23.
noNight false set to true if you want to automatically skip a time range
latestHour 21 the hour at which the time jump will happen
latestMin 0 the minute at which the time jump will happen
jumpToHour 5 the hour the time will jump to
jumpToMin 0 the minute the time will jump to
suppressCloudsRendered true if you have users using QuantV, this supresses the clouds that totally jack up QuantV screens
canBeSnow false if set to true, the weather can change to snow within the random weather changes, and back out of snow again. The only drawback is the snow on the ground does not fade in and out, it pops in and out.
snowBias 70 the chance that snowy weather could be picked in the rotation of weather
[temperatureRanges] These are the high and low temperatures for when it is snowing and for each month. Change them to match the region your server is playing as
snow 15,32
01 30,58
02 30,58
03 62,80
04 62,80
05 62,80
06 62,80
07 82,98
08 82,98
09 45,70
10 45,70
11 33,60
12 30,58

NOTE

The new canBeSnow settings are a new BETA feature and are not fully tested. Use with caution.

{:links-list}

HOW TO PLAY

/weather Brings up the menu

/weather type - changes the weather manually. Valid types are EXTRASUNNY, CLEAR, NEUTRAL, SMOG, FOGGY, OVERCAST, CLOUDS, CLEARING, RAIN, THUNDER, SNOW, BLIZZARD, SNOWLIGHT, XMAS, HALLOWEEN

/settime Brings up the menu

/settime HH:MM - changes the time manually.

/snow - toggles snow off and on. Weather patterns will follow snow if it is toggled on and it will persist until toggled off

/pauseweather - toggles dynamic weather changes. If paused, it will just stay on whatever weather it is currently on

/forecast - shows the current weather and the next 5 iterations of weather. This is the only command exempt from the restricted setting so anyone can use it

MENU

Change Weather - Choose a weather type to change to

Change Clouds - Change clouds without affecting the weather

Pause Weather Changes - Pause automatic weather changes

Freeze Time - Freeze the current time so time doesn't move anymore (or unfreeze it if it is frozen)

Set Time - Force set time to a specific point in the day

NOTE

When you manually set the weather to XMAS or HALLOWEEN, it will stay on either of those until you manually change it again.

ALSO NOTE

If you manually set it to a snow type of weather, it will automatically toggle snow on. If you then manually set it to a rain type of weather, it will automatically toggle the snow back off.

FINAL NOTE

If you restart the script or the server, it will reset the weather so snow will be off and if you had XMAS or HALLOWEEN set, they will be off, as well.

EXPORTS

EXPORT ARGS RETURN
exports['BigDaddy-Weather']:ToggleNaturalDisaster(toggle) toggle [bool] null

KNOWN ISSUES

Only that it will conflict with other weather scripts so it cannot be run with any other script that modifies or controls the weather. If you do not disable vMenu weather functionality, the weather will flash and kind of freak out because both scripts are trying to control it.