| Envrioment: | Mission Scripting | ||
| Function: | setFogAnimation | Added with: 2.9.10 | |
| Member Of: | world.weather | ||
| Syntax: | world.weather.setFogAnimation(table fogAnimationKeys ) | ||
| Description: | Uses data from the passed table to change the fog visibility and thickness over a desired timeframe. This allows for a gradual increase/decrease of fog values rather than abruptly applying the values.
Animation Key Format: {time, visibility, thickness} Time: in seconds 0 to infinity Time is relative to when the function was called. Time value for each key must be larger than the previous key. If time is set to 0 then the fog will be applied to the corresponding visibility and thickness values at that key. Any time value greater than 0 will result in the current fog being inherited and changed to the first key. Visibility: in meters 100 to 100000 Thickness: in meters 100 to 5000 The speed at which the visibility and thickness changes is based on the time between keys and the values that visibility and thickness are being set to.
| ||
| Return Value: | |||
| Return Example: | |||
| Examples: | The following will set the fog in the mission to disappear in 1 minute.
world.weather.setFogAnimation({ {60, 0, 0} })
world.weather.setFogAnimation({
{3600, 10000, 3000}, -- one hour to get to that fog setting
{7200, 10000, 3000}, -- will maintain for 2 hours
{10800, 20000, 2000}, -- at 3 hours visibility will have been increased while thickness decreases slightly
{12600, 0, 0}, -- at 3:30 after the function was called the fog will be completely removed.
})
| ||
| Related Functions: | World Functions: addEventHandler, removeEventHandler, getPlayer, getAirbases, searchObjects, getMarkPanels, removeJunk
world.weather getFogThickness, setFogThickness, getFogVisibilityDistance, setFogVisibilityDistance, setFogAnimation | ||
| Notes: | |||
