enableEnvironment: Difference between revisions

Latest revision as of 18:02, 18 November 2023

Hover & click on the images for description

Description:

Enable/disable environmental effects: ambient life and/or ambient sound.

ⓘ

This command has to be executed after mission start: be sure to use e.g sleep 0.1; for it to take effect.

Influenced sounds among others are:

2.06 thunder (an already started sound will not be cut but future ones will be prevented)

Groups:

Environment Sounds

Syntax:: enableEnvironment enable
Parameters:: enable: Boolean - false to disable ambient life and ambient sounds, true to re-enable it
Return Value:: Nothing

Syntax:: enableEnvironment [ambientLife, ambientSound, windyCoef]
Parameters:: ambientLife: Boolean - enable/disable ambient life (bees, rabbits, birds, snakes, fish)
: ambientSound: Boolean - enable/disable ambient sounds (cicadas, owls, etc)
since 2.12: windyCoef: Number - (Optional, default 1) howling wind at heights, range 0..1
Return Value:: Nothing

Example 1:: enableEnvironment false; // identical to enableEnvironment [false, false]
Example 2:: enableEnvironment [false, true]; enableEnvironment [false, true, 0.5]; // since Arma 3 v2.12

See also:: environmentEnabled fadeEnvironment environmentVolume initAmbientLife sideAmbientLife getAllEnvSoundControllers getEnvSoundController setSoundEffect Arma 3: Animals: Ambient System

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 50: / Line 50: @@
 |p22= ambientSound: [[Boolean]] - enable/disable ambient sounds (cicadas, owls, etc)
-|p23= windyCoef (Optional): [[Number]] - (default 1) howling wind at heights, range 0..1
+|p23= windyCoef: [[Number]] - (Optional, default 1) howling wind at heights, range 0..1
 |p23since= arma3 2.12
@@ Line 59: / Line 59: @@
 |x2= <sqf>
 enableEnvironment [false, true];
-enableEnvironment [false, true, 0.5]; // since Arma 3 v2.12
+enableEnvironment [false, true, 0.5]; // since {{arma3}} v2.12
 </sqf>
 |seealso= [[environmentEnabled]] [[fadeEnvironment]] [[environmentVolume]] [[initAmbientLife]] [[sideAmbientLife]] [[getAllEnvSoundControllers]] [[getEnvSoundController]] [[setSoundEffect]] [[Arma 3: Animals: Ambient System]]
 }}