enableEnvironment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|PARAMETER1= |r2=" to "|PARAMETER21= |r2=")
Line 3: Line 3:


| arma |Game name=
| arma |Game name=
|eff= local|Multiplayer Effects=


|1.00|Game version=
|1.00|Game version=
|eff= local|Multiplayer Effects=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


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


|p21= [ambientLife, ambientSound]: [[Array]] |PARAMETER21=
|p21= ambientLife: [[Boolean]] |PARAMETER21=
|p22= ambientLife: [[Boolean]] |PARAMETER1=
 
|p23= ambientSound: [[Boolean]] |PARAMETER21=
|p22= ambientSound: [[Boolean]] |PARAMETER22=


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]] |RETURNVALUE2=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[enableEnvironment]] [[false]];</code> |EXAMPLE1=
|x1= <code>[[enableEnvironment]] [[false]];</code> |EXAMPLE1=
|x2= <code>[[enableEnvironment]] <nowiki>[</nowiki>[[false]], [[true]]];</code> |EXAMPLE1=
 
|x2= <code>[[enableEnvironment]] <nowiki>[</nowiki>[[false]], [[true]]];</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[environmentEnabled]], [[initAmbientLife]], [[sideAmbientLife]], [[getAllEnvSoundControllers]], [[getEnvSoundController]], [[setSoundEffect]]|SEEALSO=
| [[environmentEnabled]], [[initAmbientLife]], [[sideAmbientLife]], [[getAllEnvSoundControllers]], [[getEnvSoundController]], [[setSoundEffect]]|SEEALSO=
}}
}}


Line 37: Line 41:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on 28 October, 2013  
<dd class="notedate">Posted on 28 October, 2013  
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]
<dd class="note">
<dd class="note">
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:
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:
<code>//init.sqf
<code>{{cc|in e.g init.sqf}}
[[waitUntil]] {[[time]] > 0};
[[waitUntil]] { [[time]] > 0 };
[[enableEnvironment]] [[false]];</code>
[[enableEnvironment]] [[false]];</code>


<!-- Note Section END -->
<!-- Note Section END -->
Line 52: Line 55:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>


[[Category:Scripting Commands|ENABLEENVIRONMENT]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|ENABLEENVIRONMENT]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|ENABLEENVIRONMENT]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{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}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on October 23, 2017 - 16:54 (UTC)</dd>
<dt class="note">[[User:Demellion|Demellion]]</dt>
<dd class="note">
'''NOTE:''' Disabling ambient life will remove generation of anything that is coming from ''AmbientA3'' map class (see [[Arma_3_Animals:_Ambient_System|Ambient System]]). That means removing not only bees and cicadas around a player, but rabbits, snakes, seagulls and all the fish in the sea.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 17:11, 4 September 2019

-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.
Disabling ambient life will remove generation of anything that is coming from AmbientA3 map class (see Ambient System).
That means removing not only bees and cicadas around a player, but rabbits, snakes, seagulls and all the fish in the sea.
Groups:
Uncategorised

Syntax

Syntax:
enableEnvironment enabled
Parameters:
enabled: Boolean
Return Value:
Nothing

Alternative Syntax

Syntax:
enableEnvironment [ambientLife, ambientSound]        (Since Arma 3 v1.67)
Parameters:
ambientLife: Boolean
ambientSound: Boolean
Return Value:
Nothing

Examples

Example 1:
enableEnvironment false;
Example 2:
enableEnvironment [false, true];

Additional Information

See also:
environmentEnabledinitAmbientLifesideAmbientLifegetAllEnvSoundControllersgetEnvSoundControllersetSoundEffect

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