enableEnvironment: Difference between revisions

Latest revision as of 19: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
-|eff= local|Multiplayer Effects=
+|game3= arma2oa
-____________________________________________________________________________________________
+|version3= 1.50
-| Enable/disable environmental effects: ambient life and/or ambient sound.
+|game4= tkoh
-{{Informative | Disabling ambient life will remove generation of anything that is coming from ''AmbientA3'' map class (see [[Arma_3_Animals:_Ambient_System|Ambient System]]).<br>
+|version4= 1.00
-That means removing not only bees and cicadas around a player, but rabbits, snakes, seagulls and all the fish in the sea.}} |DESCRIPTION=
-____________________________________________________________________________________________
-| [[enableEnvironment]] enabled |SYNTAX=
+|game5= arma3
+|version5= 0.50
-|p1= enabled: [[Boolean]] |PARAMETER1=
+|gr1= Environment
-| [[Nothing]] |RETURNVALUE=
+|gr2= Sounds
-____________________________________________________________________________________________
-|s2= [[enableEnvironment]] [ambientLife, ambientSound] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since {{arma3}} v1.67'') |SYNTAX2=
+|eff= local
-|p21= ambientLife: [[Boolean]] |PARAMETER21=
+|descr= Enable/disable environmental effects: ambient life and/or ambient sound.
-|p22= ambientSound: [[Boolean]] |PARAMETER22=
+{{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
+|p1= enable: [[Boolean]] - [[false]] to disable ambient life and ambient sounds, [[true]] to re-enable it
-|r2= [[Nothing]] |RETURNVALUE2=
+|r1= [[Nothing]]
-____________________________________________________________________________________________
-|x1= <code>[[enableEnvironment]] [[false]];</code> |EXAMPLE1=
-|x2= <code>[[enableEnvironment]] <nowiki>[</nowiki>[[false]], [[true]]];</code> |EXAMPLE2=
+|s2= [[enableEnvironment]] [ambientLife, ambientSound, windyCoef]
-____________________________________________________________________________________________
-| [[environmentEnabled]], [[initAmbientLife]], [[sideAmbientLife]], [[getAllEnvSoundControllers]], [[getEnvSoundController]], [[setSoundEffect]]|SEEALSO=
+|s2since= arma3 1.68
-}}
+|p21= ambientLife: [[Boolean]] - enable/disable ambient life (bees, rabbits, birds, snakes, fish)
+|p22= ambientSound: [[Boolean]] - enable/disable ambient sounds (cicadas, owls, etc)
-<h3 style="display:none">Notes</h3>
+|p23= windyCoef: [[Number]] - (Optional, default 1) howling wind at heights, range 0..1
-<dl class="command_description">
+|p23since= arma3 2.12
-<!-- Note Section BEGIN -->
-<dd class="notedate">Posted on 28 October, 2013
+|r2= [[Nothing]]
-<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>{{cc|in e.g init.sqf}}
-[[waitUntil]] { [[time]] > 0 };
-[[enableEnvironment]] [[false]];</code>
-<!-- Note Section END -->
+|x1= <sqf>enableEnvironment false; // identical to enableEnvironment [false, false]</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x2= <sqf>
+enableEnvironment [false, true];
+enableEnvironment [false, true, 0.5]; // since {{arma3}} v2.12
+</sqf>
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+|seealso= [[environmentEnabled]] [[fadeEnvironment]] [[environmentVolume]] [[initAmbientLife]] [[sideAmbientLife]] [[getAllEnvSoundControllers]] [[getEnvSoundController]] [[setSoundEffect]] [[Arma 3: Animals: Ambient System]]
-[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]