enableEnvironment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|1.00|Game version=
|1.00


|gr1= Environment |GROUP1=
|gr1= Environment


|eff= local|Multiplayer Effects=
|eff= local


| Enable/disable environmental effects: ambient life and/or ambient sound.
| Enable/disable environmental effects: ambient life and/or ambient sound.


{{Informative | This command has to be executed after mission start: be sure to use e.g {{Inline code|[[waitUntil]] { [[time]] > 0 }<nowiki/>}} or [[sleep]] for it to take effect.}} |DESCRIPTION=
{{Informative | This command has to be executed after mission start: be sure to use e.g {{Inline code|[[waitUntil]] { [[time]] > 0 }<nowiki/>}} or [[sleep]] for it to take effect.}}


| [[enableEnvironment]] enabled |SYNTAX=
| [[enableEnvironment]] enabled


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


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


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


|p21= ambientLife: [[Boolean]] - ambient life setting (bees, rabbits, birds, snakes, fish) |PARAMETER21=
|p21= ambientLife: [[Boolean]] - ambient life setting (bees, rabbits, birds, snakes, fish) |PARAMETER21=
Line 25: Line 25:
|p22= ambientSound: [[Boolean]] - ambient sounds setting (cicadas, owls, etc) |PARAMETER22=
|p22= ambientSound: [[Boolean]] - ambient sounds setting (cicadas, owls, etc) |PARAMETER22=


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]]
   
   
|x1= <code>[[enableEnvironment]] [[false]]; {{cc|identical to [[enableEnvironment]] [<nowiki/>[[false]], [[false]]]}}</code> |EXAMPLE1=
|x1= <code>[[enableEnvironment]] [[false]]; {{cc|identical to [[enableEnvironment]] [<nowiki/>[[false]], [[false]]]}}</code>


|x2= <code>[[enableEnvironment]] [<nowiki/>[[false]], [[true]]];</code> |EXAMPLE2=
|x2= <code>[[enableEnvironment]] [<nowiki/>[[false]], [[true]]];</code>


| [[Arma 3 Animals: Ambient System]], [[environmentEnabled]], [[initAmbientLife]], [[sideAmbientLife]], [[getAllEnvSoundControllers]], [[getEnvSoundController]], [[setSoundEffect]] |SEEALSO=
| [[Arma 3 Animals: Ambient System]], [[environmentEnabled]], [[initAmbientLife]], [[sideAmbientLife]], [[getAllEnvSoundControllers]], [[getEnvSoundController]], [[setSoundEffect]]
}}
}}



Revision as of 01:35, 18 January 2021

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 waitUntil { time > 0 } or sleep for it to take effect.
Groups:
Environment

Syntax

Syntax:
enableEnvironment enabled
Parameters:
enabled: 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:
Arma 3 Animals: Ambient SystemenvironmentEnabledinitAmbientLifesideAmbientLifegetAllEnvSoundControllersgetEnvSoundControllersetSoundEffect

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

Notes

Bottom Section