enableAudioFeature: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *P([a-gi-z ])" to "$1 - p$2")
m (Fix)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command
|game1= arma3
|game1= arma3
|version1= 1.64
|version1= 1.64
|arg=
 
|arg= global
|eff= local
 
|gr1= Sounds
|gr1= Sounds


|descr= Enable or disable an audio feature. Available features are {{hl|"lowpass"}} and {{hl|"building_interior"}}.<br>
|descr= Get the state of '''or''' enable/disable an audio feature. Available features are {{hl|"lowpass"}} and {{hl|"building_interior"}}.
Since {{GVI|arma3|2.14}} it is possible to enable {{hl|"building_interior"}} on an object placed in a building.<br>
* {{GVI|arma3|2.14|size= 0.75}} it is possible to enable {{hl|"building_interior"}} on an object placed in a building.
Since {{GVI|arma3|2.14}} if 'enable' argument is omitted, the command returns the current state of the feature.
* {{GVI|arma3|2.14|size= 0.75}} 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:
|mp= To use this command on objects in multiplayer, [[remoteExec]] it globally with JIP queue enabled:
Line 15: Line 19:


|p1= feature: [[String]] - {{hl|"lowpass"}} or {{hl|"building_interior"}}
|p1= feature: [[String]] - {{hl|"lowpass"}} or {{hl|"building_interior"}}
|p2= enable: [[Boolean]] - (Optional) [[true]] enable, [[false]], disable
 
|p2= enable: [[Boolean]] - (Optional, getter if not provided) [[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]] - {{hl|"building_interior"}} or {{hl|"building_exterior"}} only (mutually exclusive)
|p22= feature: [[String]] - {{hl|"building_interior"}} or {{hl|"building_exterior"}} only (mutually exclusive)
|p23= enable: [[Boolean]] - (Optional) [[true]] enable, [[false]], disable
 
|p23= enable: [[Boolean]] - (Optional, getter if not provided) [[true]] enable, [[false]], disable
 
|r2= [[Boolean]] - previous state
|r2= [[Boolean]] - previous state


|x1= <sqf>private _prevState = enableAudioFeature ["lowpass", true];</sqf>
|x2= <sqf>private _prevState = pallet enableAudioFeature ["building_interior", true];</sqf>
|x3= <sqf>
private _currState = pallet enableAudioFeature ["building_interior"];
private _prevState = pallet enableAudioFeature ["building_interior", !_currState];
hint str (_currState == _prevState); // true


|x1= <sqf>_prevState = enableAudioFeature ["lowpass", true];</sqf>
private _currState = pallet enableAudioFeature ["building_interior"];
|x2= <sqf>_prevState = pallet enableAudioFeature ["building_interior", true];</sqf>
hint str (_currState == _prevState); // false
</sqf>


|seealso= [[insideBuilding]]
|seealso= [[insideBuilding]]
}}
}}

Latest revision as of 11:41, 1 April 2024

Hover & click on the images for description

Description

Description:
Get the state of or enable/disable an audio feature. Available features are "lowpass" and "building_interior".
  • Arma 3 logo black.png2.14 it is possible to enable "building_interior" on an object placed in a building.
  • 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: Boolean - (Optional, getter if not provided) 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: Boolean - (Optional, getter if not provided) true enable, false, disable
Return Value:
Boolean - previous state

Examples

Example 1:
private _prevState = enableAudioFeature ["lowpass", true];
Example 2:
private _prevState = pallet enableAudioFeature ["building_interior", true];
Example 3:
private _currState = pallet enableAudioFeature ["building_interior"]; private _prevState = pallet enableAudioFeature ["building_interior", !_currState]; hint str (_currState == _prevState); // true private _currState = pallet enableAudioFeature ["building_interior"]; hint str (_currState == _prevState); // false

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