enableEnvironment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Fix typo)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


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


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]] |RETURNVALUE2=
Line 39: Line 41:


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


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

Revision as of 22:01, 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.
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