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: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |= Game name
+|game1= arma1
+|version1= 1.00
-|1.00|= Game version
+|game2= arma2
-____________________________________________________________________________________________
+|version2= 1.00
-| Enable/disable environmental effects (ambient life + sound). |= Description
+|game3= arma2oa
-____________________________________________________________________________________________
+|version3= 1.50
-| '''enableEnvironment''' enabled   |= Syntax
+|game4= tkoh
+|version4= 1.00
-|p1= enabled: [[Boolean]] |= Parameter 1
+|game5= arma3
+|version5= 0.50
-| [[Nothing]] |= Return value
+|gr1= Environment
-____________________________________________________________________________________________
-|x1= <code>[[enableEnvironment]] [[false]];</code>  |= Example 1
-____________________________________________________________________________________________
-|  |= See also
+|gr2= Sounds
+|eff= local
+|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)
-<h3 style="display:none">Notes</h3>
+|s1= [[enableEnvironment]] enable
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<dd class="notedate">Posted on 28 October, 2013
-<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]
-<dd class="note">
-This command has to be executed after mission start to have an effect. So if you add this command in ''init.sqf'' make sure you wait until mission is running:
-<code>[[waitUntil]] {[[time]] > 0};
-[[enableEnvironment]] [[false]];</code>
+|p1= enable: [[Boolean]] - [[false]] to disable ambient life and ambient sounds, [[true]] to re-enable it
+|r1= [[Nothing]]
-<!-- Note Section END -->
+|s2= [[enableEnvironment]] [ambientLife, ambientSound, windyCoef]
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|s2since= arma3 1.68
-[[Category:Scripting Commands|ENABLEENVIRONMENT]]
+|p21= ambientLife: [[Boolean]] - enable/disable ambient life (bees, rabbits, birds, snakes, fish)
-[[Category:Scripting Commands ArmA|ENABLEENVIRONMENT]]
-[[Category:Scripting Commands ArmA2|ENABLEENVIRONMENT]]
+|p22= ambientSound: [[Boolean]] - enable/disable ambient sounds (cicadas, owls, etc)
-[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+|p23= windyCoef: [[Number]] - (Optional, default 1) howling wind at heights, range 0..1
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+|p23since= arma3 2.12
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
+|r2= [[Nothing]]
+|x1= <sqf>enableEnvironment false; // identical to enableEnvironment [false, false]</sqf>
+|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]]
+}}