enableAudioFeature: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some formatting)
Line 5: Line 5:
|gr1= Sounds
|gr1= Sounds


|descr= Enable/disable an audio feature, features are: "lowpass", "building_interior". Since v2.14 it is possible to enable "building_interior" on an object placed in a building. When used on object in multiplayer, [[remoteExec]] the command globally with JIP queue enabled, for example <sqf>[_obj, ["building_interior", true]] remoteExec ["enableAudioFeature", 0, _obj];</sqf> Since Arma 2.14 if 'enable' argument is omitted, the command returns the current state of the feature.
|descr= Enable or disable an audio feature. Available features are {{hl|"lowpass"}} and {{hl|"building_interior"}}.<br>
Since {{GVI|arma3|2.14}} it is possible to enable {{hl|"building_interior"}} on an object placed in a building.<br>
Since {{GVI|arma3|2.14}} if 'enable' argument is omitted, the command returns the current state of the feature.
 
|mp= To use this command on objects in multiplayer, [[remoteExec]] it globally with JIP queue enabled:
<sqf>[_obj, ["building_interior", true]] remoteExec ["enableAudioFeature", 0, _obj];</sqf>
 
|s1= [[enableAudioFeature]] [feature, enable]
|s1= [[enableAudioFeature]] [feature, enable]


|p1= feature: [[String]] - "lowpass", "building_interior"
|p1= feature: [[String]] - {{hl|"lowpass"}} or {{hl|"building_interior"}}
|p2= enable (Optional): [[Boolean]] - [[true]] enable, [[false]], disabled
|p2= enable (Optional): [[Boolean]] - [[true]] enable, [[false]], disable
|r1= [[Boolean]] - Previous state
|r1= [[Boolean]] - Previous state


|s2= object [[enableAudioFeature]] [feature, enable]
|s2= object [[enableAudioFeature]] [feature, enable]
|s2since= Arma3 2.14
|s2since= arma3 2.14


|p21= object: [[Object]]  
|p21= object: [[Object]]  
|p22= feature: [[String]] - "building_interior" or "building_exterior" only (mutually exclusive).
|p22= feature: [[String]] - {{hl|"building_interior"}} or {{hl|"building_exterior"}} only (mutually exclusive)
|p23= enable (Optional): [[Boolean]] - [[true]] enable, [[false]], disabled
|p23= enable (Optional): [[Boolean]] - [[true]] enable, [[false]], disable
|r2= [[Boolean]] - Previous state
|r2= [[Boolean]] - Previous state



Revision as of 18:21, 5 September 2023

Hover & click on the images for description

Description

Description:
Enable or disable an audio feature. Available features are "lowpass" and "building_interior".
Since Arma 3 logo black.png2.14 it is possible to enable "building_interior" on an object placed in a building.
Since Arma 3 logo black.png2.14 if 'enable' argument is omitted, the command returns the current state of the feature.
Multiplayer:
To use this command on objects in multiplayer, remoteExec it globally with JIP queue enabled:
[_obj, ["building_interior", true]] remoteExec ["enableAudioFeature", 0, _obj];
Groups:
Sounds

Syntax

Syntax:
enableAudioFeature [feature, enable]
Parameters:
feature: String - "lowpass" or "building_interior"
enable (Optional): Boolean - true enable, false, disable
Return Value:
Boolean - Previous state

Alternative Syntax

Syntax:
object enableAudioFeature [feature, enable]
Parameters:
object: Object
feature: String - "building_interior" or "building_exterior" only (mutually exclusive)
enable (Optional): Boolean - true enable, false, disable
Return Value:
Boolean - Previous state

Examples

Example 1:
_prevState = enableAudioFeature ["lowpass", true];
Example 2:
_prevState = pallet enableAudioFeature ["building_interior", true];

Additional Information

See also:
insideBuilding

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