enableEnvironment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1= Environment |GROUP1= ")
m (Some wiki formatting)
Line 7: Line 7:


|gr1= Environment |GROUP1=
|gr1= Environment |GROUP1=


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


| Enable/disable environmental effects: ambient life and/or ambient sound.
| Enable/disable environmental effects: ambient life and/or ambient sound. |DESCRIPTION=
{{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>
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=
| [[enableEnvironment]] enabled |SYNTAX=


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


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


|s2= [[enableEnvironment]] [ambientLife, ambientSound] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since {{arma3}} v1.67'') |SYNTAX2=
|s2= [[enableEnvironment]] [ambientLife, ambientSound] {{since|arma3|1.67|y}} |SYNTAX2=


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


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


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


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


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


Line 59: Line 55:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{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 Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]

Revision as of 21:56, 23 December 2020

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Enable/disable environmental effects: ambient life and/or ambient sound.
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 (circadas, owls sounds, 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

Posted on 28 October, 2013
Killzone_Kid
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: // in e.g init.sqf waitUntil { time > 0 }; enableEnvironment false;

Bottom Section