enableEnvironment: Difference between revisions

Latest revision as of 18:02, 18 November 2023

1.00

Hover & click on the images for description

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:

bird sounds
insect sounds
waves
wind
rain
sounds produced by air conditioners and similar

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

Groups:

Environment Sounds

Syntax

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

1.68

Alternative Syntax

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

Examples

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

Additional Information

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

Notes

: 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 1: / Line 1: @@
 {{RV|type=command
-| arma1
+|game1= arma1
+|version1= 1.00
-|1.00
+|game2= arma2
+|version2= 1.00
+|game3= arma2oa
+|version3= 1.50
+|game4= tkoh
+|version4= 1.00
+|game5= arma3
+|version5= 0.50
 |gr1= Environment
+|gr2= Sounds
 |eff= local
-| Enable/disable environmental effects: ambient life and/or ambient sound.
+|descr= Enable/disable environmental effects: ambient life and/or ambient sound.
+{{Feature|informative|This command has to be executed after mission start: be sure to use e.g <sqf inline>sleep 0.1;</sqf> for it to take effect.}}
+Influenced sounds among others are:
+{{Columns|2|
+* bird sounds
+* insect sounds
+* waves
+* wind
+* rain
+* sounds produced by air conditioners and similar
+}}
+* {{GVI|arma3|2.06|size= 0.75}} thunder (an already started sound will not be cut but future ones will be prevented)
+|s1= [[enableEnvironment]] enable
-{{Feature | Informative | This command has to be executed after mission start: be sure to use e.g {{Inline code|[[waitUntil]] { [[time]] > 0 }<nowiki/>}} or [[sleep]] for it to take effect.}}
+|p1= enable: [[Boolean]] - [[false]] to disable ambient life and ambient sounds, [[true]] to re-enable it
-| [[enableEnvironment]] enabled
+|r1= [[Nothing]]
-|p1= enabled: [[Boolean]] - ambient life and ambient sounds setting
+|s2= [[enableEnvironment]] [ambientLife, ambientSound, windyCoef]
-| [[Nothing]]
+|s2since= arma3 1.68
-|s2= [[enableEnvironment]] [ambientLife, ambientSound] {{Since|arma3|1.67|y}}
+|p21= ambientLife: [[Boolean]] - enable/disable ambient life (bees, rabbits, birds, snakes, fish)
-|p21= ambientLife: [[Boolean]] - ambient life setting (bees, rabbits, birds, snakes, fish)
+|p22= ambientSound: [[Boolean]] - enable/disable ambient sounds (cicadas, owls, etc)
-|p22= ambientSound: [[Boolean]] - ambient sounds setting (cicadas, owls, etc)
+|p23= windyCoef: [[Number]] - (Optional, default 1) howling wind at heights, range 0..1
+|p23since= arma3 2.12
 |r2= [[Nothing]]
-|x1= <code>[[enableEnvironment]] [[false]]; {{cc|identical to [[enableEnvironment]] [<nowiki/>[[false]], [[false]]]}}</code>
-|x2= <code>[[enableEnvironment]] [<nowiki/>[[false]], [[true]]];</code>
+|x1= <sqf>enableEnvironment false; // identical to enableEnvironment [false, false]</sqf>
-| [[environmentEnabled]], [[fadeEnvironment]], [[environmentVolume]], [[initAmbientLife]], [[sideAmbientLife]], [[getAllEnvSoundControllers]], [[getEnvSoundController]], [[setSoundEffect]], [[Arma 3 Animals: Ambient System]]
+|x2= <sqf>
+enableEnvironment [false, true];
+enableEnvironment [false, true, 0.5]; // since {{arma3}} v2.12
+</sqf>
+|seealso= [[environmentEnabled]] [[fadeEnvironment]] [[environmentVolume]] [[initAmbientLife]] [[sideAmbientLife]] [[getAllEnvSoundControllers]] [[getEnvSoundController]] [[setSoundEffect]] [[Arma 3: Animals: Ambient System]]
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}