enableEnvironment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Inline code|" to "{{ic|")
(formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1


|1.00
|version1= 1.00
 
|game2= arma2
 
|version2= 1.00
 
|game3= arma2oa
 
|version3= 1.51
 
|game4= tkoh
 
|version4= 1.00
 
|game5= arma3
 
|version5= 0.50


|gr1= Environment
|gr1= Environment
Line 9: Line 25:
|eff= local
|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 {{ic|[[waitUntil]] { [[time]] > 0 }<nowiki/>}} or [[sleep]] for it to take effect.}}
{{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.}}


| [[enableEnvironment]] enabled
|s1= [[enableEnvironment]] enable


|p1= enabled: [[Boolean]] - ambient life and ambient sounds setting
|p1= enable: [[Boolean]] - Ambient life and ambient sounds setting


| [[Nothing]]
|r1= [[Nothing]]


|s2= [[enableEnvironment]] [ambientLife, ambientSound] {{Since|arma3|1.67|y}}
|s2= [[enableEnvironment]] [ambientLife, ambientSound] {{Since|arma3|1.68|y}}


|p21= ambientLife: [[Boolean]] - ambient life setting (bees, rabbits, birds, snakes, fish)
|p21= ambientLife: [[Boolean]] - Ambient life setting (bees, rabbits, birds, snakes, fish)


|p22= ambientSound: [[Boolean]] - ambient sounds setting (cicadas, owls, etc)
|p22= ambientSound: [[Boolean]] - Ambient sounds setting (cicadas, owls, etc)


|r2= [[Nothing]]
|r2= [[Nothing]]
Line 33: Line 49:
|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]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 13:48, 26 March 2021

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.51tkoh 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.
Groups:
Environment

Syntax

Syntax:
enableEnvironment enable
Parameters:
enable: Boolean - Ambient life and ambient sounds setting
Return Value:
Nothing

Alternative Syntax

Syntax:
enableEnvironment [ambientLife, ambientSound] Template:Since
Parameters:
ambientLife: Boolean - Ambient life setting (bees, rabbits, birds, snakes, fish)
ambientSound: Boolean - Ambient sounds setting (cicadas, owls, etc)
Return Value:
Nothing

Examples

Example 1:
enableEnvironment false; // identical to enableEnvironment [false, false]
Example 2:
enableEnvironment [false, true];

Additional Information

See also:
environmentEnabledfadeEnvironmentenvironmentVolumeinitAmbientLifesideAmbientLifegetAllEnvSoundControllersgetEnvSoundControllersetSoundEffectArma 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=251793"