Environment
66 scripting commands. Also as Markdown for agents.
- ambientTemperatureReturns ambient temperature on the current terrain in Celsius in format: [airTemperature, blackSurfaceTemperature, whiteSurfaceTemperature]
- dateReturn the actual in-mission date and time.
- dateToNumberConvert a date to a float number, based on Jan 1st 00:00:00 = 0 and Dec 31st 23:59:59 = 1. The same day and time in leap year will be different after…
- dayTimeReturns the current in-game time in hours. For a formatted version of time, see BIS_fnc_timeToString.
- enableEnvironmentEnable/disable environmental effects: ambient life and/or ambient sound.
- enableTrafficEnable ambient traffic.
- environmentEnabledReturns status of enableEnvironment command
- fogA getter for setFog. Returns the current value of the fog in range 0..1.
- fogForecastReturns the forecast fog value. A value of 0 means no fog, 1 means maximum fog.
- fogParamsA getter for setFog (Alt Syntax). Returns extended params for the fog
- forceWeatherChangeForcibly applies previously set weather settings. Skips smooth transitions. This might cause lag.
- getObjectViewDistanceGets the values of rendering distances of objects and shadows.
- getShadowDistanceGets the shadows rendering distance.
- getTerrainGridA getter for setTerrainGrid, returns the current terrain grid.
- getTIParametersReturns all Thermal Imaging parameters.
- gustsReturn the current gusts value.
- humidityReturns the current humidity value. 0 is no humidity and 1 is 100% humidity. Humidity value quickly changes from 0 to 1 when rain starts, then slowly…
- initAmbientLifeInitialises the ambient life on local client from `CfgWorlds >> worldName >> AmbientA3`. Has no effect on dedicated server or headless client.
- lightningsReturn the current lightnings value.
- moonIntensityReturns the intensity of the moon's brightness in range 0..1.
- moonPhaseReturns the phase of the in-game Moon on the given date. According to this command, the fullest Moon in Arma 3 at midnight is on `setDate [4804, 7,…
- nextWeatherChangeReturn the remaining time (in seconds) over which the current weather change will occur.
- numberToDateConvert float number to a date.
- overcastReturn the current overcast level. Zero is clear skies, one is maximum cloud cover.
- overcastForecastReturn the overcast forecast.
- rainReturns the current value of rain density.
- rainbowReturns the current rainbow intensity.
- rainParamsReturns currently set RainParticles params, custom or default.
- setDateSets mission date and time. Players joining after mission start will get the current server date including the year.
- setFogSmoothly change the fog over given time (in seconds). See also fogParams.
- setGustsChanges the gusts value smoothly during the given time (in seconds). A time of zero means there will be an immediate change.
- setHumiditySets surface humidity. Affects how footsteps sound (dry / wet). humidity is increasing when raining and decreasing when not raining. Exception is if…
- setLightningsChanges the lightnings value smoothly during the given time (in seconds). A time of zero means there will be an immediate change.
- setLocalWindParamsSets parameters for helicopter rotor wash. It affects the visual effect of a rotor's downwash, such as blown particles, vegetation wind effect and…
- setObjectViewDistanceSets the rendering distance of objects and shadows.
- setOvercastSet overcast to given value smoothly during given time (in seconds). Zero time means immediate change. An overcast setting of zero means clear…
- setRainSets rain density smoothly over the given transition time. A transition time of zero means an immediate change. A rain density of zero is no rain,…
- setRainbowChanges the rainbow value smoothly during the given time (in seconds). A time of zero means there will be an immediate change.
- setShadowDistanceSets the shadows rendering distance.
- setSimulWeatherLayersSets number of simul weather layers, affects quality of simul weather clouds.
- setTerrainGridSets the desired terrain resolution in meters.
- setTimeMultiplierSets a time multiplier for in-game time. The command range is capped at 0.1 - 120 to avoid performance problems.
- setTIParameterSets the provided Thermal Imaging parameter's value.
- setTrafficDensitySet the density of ambient cars in a rectangle (in cars per kilometer).
- setTrafficDistanceSet maximum ambient traffic draw distance (in 2D).
- setTrafficGapSet the average gap between ambient cars in a rectangle (in meters).
- setTrafficSpeedSet ambient traffic speed in a rectangle (in kilometers per hour).
- setViewDistanceSet rendering distance. Setting view distance to <= 0 resets the value to the client's options (set in `Options → Video → General → Visibility →…
- setWavesChanges the waves value smoothly during the given time (in seconds). A time of zero means there will be an immediate change.
- setWindSet current or permanent wind vector.
- setWindDirChanges the wind direction smoothly.
- setWindForceSet max. wind overall wind changes in time. A time of zero means there will be an immediate change. A wind level of zero is minimal changes and a…
- setWindStrChanges the wind strength smoothly during the given time (in seconds). A time of zero means there will be an immediate change.
- simulCloudDensityReturns density of clouds at given position.
- simulCloudOcclusionReturns clouds occlusion between two given points.
- simulInCloudsReturns if given position is in clouds.
- simulSetHumiditySets simul cloud cover. This command does not affect overcast value.
- simulWeatherSyncSynchronizes Simul Weather with Arma weather, generates all keyframes.
- skipTimeJumps the specified number of hours forward or backward. The time of day and tides are adjusted, but no changes are made to any units.
- sunOrMoonReturns the moon to sun transition state in range 0..1.
- timeMultiplierReturns the value set with setTimeMultiplier.
- viewDistanceReturns the rendering distance.
- wavesReturn waves value.
- windReturns the current wind vector (in m/s).
- windDirReturns the current wind azimuth.
- windStrReturns the current wind strength.