enableEnvironment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^ ]*)\{\{cc\|([^ ]*)\}\}([^ ]*)<\/code>" to "<code>$1// $2$3</code>")
m (Text replacement - "// since Arma 3" to "// since {{arma3}}")
 
(8 intermediate revisions by 2 users not shown)
Line 24: Line 24:
|descr= 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 {{ic|[[sleep]] 0.1;}} for it to take effect.}}
{{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:
Influenced sounds among others are:
{{Columns|2|
* bird sounds
* bird sounds
* insect sounds
* insect sounds
Line 32: Line 33:
* rain
* rain
* sounds produced by air conditioners and similar
* sounds produced by air conditioners and similar
* {{GVI|arma3|2.06|size=0.8}} thunder (an already started sound will not be cut but future ones will be prevented)
}}
* {{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
|s1= [[enableEnvironment]] enable
Line 40: Line 42:
|r1= [[Nothing]]
|r1= [[Nothing]]


|s2= [[enableEnvironment]] [ambientLife, ambientSound]
|s2= [[enableEnvironment]] [ambientLife, ambientSound, windyCoef]


|s2since= arma3 1.68
|s2since= arma3 1.68
Line 47: Line 49:


|p22= ambientSound: [[Boolean]] - enable/disable ambient sounds (cicadas, owls, etc)
|p22= ambientSound: [[Boolean]] - enable/disable ambient sounds (cicadas, owls, etc)
|p23= windyCoef: [[Number]] - (Optional, default 1) howling wind at heights, range 0..1
|p23since= arma3 2.12


|r2= [[Nothing]]
|r2= [[Nothing]]


|x1= <code>enableEnvironment false; // identical to enableEnvironment [<nowiki/>false, false]</code>
|x1= <sqf>enableEnvironment false; // identical to enableEnvironment [false, false]</sqf>


|x2= <code>enableEnvironment [<nowiki/>false, true];</code>
|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]]
|seealso= [[environmentEnabled]] [[fadeEnvironment]] [[environmentVolume]] [[initAmbientLife]] [[sideAmbientLife]] [[getAllEnvSoundControllers]] [[getEnvSoundController]] [[setSoundEffect]] [[Arma 3: Animals: Ambient System]]
}}
}}

Latest revision as of 18:02, 18 November 2023

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
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
  • Arma 3 logo black.png2.06 thunder (an already started sound will not be cut but future ones will be prevented)
Groups:
EnvironmentSounds

Syntax

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

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 Arma 3 logo black.png2.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
Retrieved from "https://community.bistudio.com/wiki?title=enableEnvironment&oldid=349663"