ApplyWeatherCycles
Docslocal retval = ApplyWeatherCycles(numEntries, msPerCycle)Parameters
| Name | Type | Description |
|---|---|---|
numEntries | int | The number of cycle entries. Must be between 1 and 256 |
msPerCycle | int | The duration in milliseconds of each cycle. Must be between 1000 and 86400000 (24 hours) |
Returns
BOOLReturns TRUE (1) or FALSE (0).
Examples
Official
-- Cycle between XMAS weather for 30 seconds (3 * 10000 milliseconds), and SMOG weather for 20 seconds (2 * 10000 milliseconds)
local success = SetWeatherCycleEntry(0, "XMAS", 3) and
SetWeatherCycleEntry(1, "SMOG", 2) and
ApplyWeatherCycles(2, 10000)