enableEnvironment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|size=0.8" to "|size= 0.75")
(Add Example)
Line 48: Line 48:
|p22= ambientSound: [[Boolean]] - enable/disable ambient sounds (cicadas, owls, etc)
|p22= ambientSound: [[Boolean]] - enable/disable ambient sounds (cicadas, owls, etc)


|p23= windyCoef (Optional): [[Number]] - 0...1 (default 1) howling wind at heights
|p23since= arma3 2.12
|p23since= arma3 2.12
|p23= windyCoef (Optional): [[Number]] - 0...1 (default 1) howling wind at heights


|r2= [[Nothing]]
|r2= [[Nothing]]
Line 55: Line 55:
|x1= <sqf>enableEnvironment false; // identical to enableEnvironment [false, false]</sqf>
|x1= <sqf>enableEnvironment false; // identical to enableEnvironment [false, false]</sqf>


|x2= <sqf>enableEnvironment [false, true];</sqf>
|x2= <sqf>
enableEnvironment [false, true];
enableEnvironment [false, true, 0.5]; // since Arma 3 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]]
}}
}}

Revision as of 22:10, 20 May 2023

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 (Optional): Number - 0...1 (default 1) howling wind at heights
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