setSoundEffect: Difference between revisions

From Bohemia Interactive Community
(Added a third example to show how you need a dummy sound when using soundDet for triggers, or you will get an error message that will throw most people off from using it.)
mNo edit summary
 
(88 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


|arma|= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Defines the different sound effects.
|game3= arma2oa
|version3= 1.50


Sound / voice plays a 2D / 3D sound from CfgSounds.
|game4= tkoh
|version4= 1.00


SoundEnv plays an enviromental sound from CfgEnvSounds.
|game5= arma3
|version5= 0.50


SoundDet (only for triggers) creates a dynamic sound object attached to a trigger defined in CfgSFX. |= Description
|gr1= Sounds
____________________________________________________________________________________________


| trigger '''setSoundEffect''' [sound, voice, soundEnv, soundDet] |= Syntax
|gr2= Triggers


|p1= trigger: [[Object]] |= Parameter 1
|gr3= Waypoints


|p2= [sound, voice, soundEnv, soundDet]: [[Array]] of strings |= Parameter 2
|descr= Defines the different sound effects for a trigger or a waypoint. To stop any sound, deactivate the trigger (might take up to 0.5 seconds to stop) or delete the trigger/waypoint (immediate).


| [[Nothing]] |= Return value
|s1= trigger [[setSoundEffect]] [sound, voice, soundEnv, soundDet]
____________________________________________________________________________________________


|s2= waypoint '''setSoundEffect''' [sound, voice, soundEnv, soundDet] |= Syntax
|p1= trigger: [[Object]]


|p21= waypoint: [[Array]] - format [[Waypoint]] |= Parameter 1
|p2= sound: [[String]] - plays a 2D sound as if [[playSound]] was used from CfgSounds (mission or main config). Use {{hl|"$NONE$"}} for an empty sound


|p22= [sound, voice, soundEnv, soundDet]: [[Array]] of strings |= Parameter 2
|p3= voice: [[String]] - attaches a 3D sound from CfgSounds (mission or main config) to the object that activated the trigger and plays it as if [[say3D]] was used


|r2= [[Nothing]] |= Return value
|p4= soundEnv: [[String]] - plays an environmental sound from CfgEnvSounds (mission or main config)
____________________________________________________________________________________________
 
|x1= <pre>_trigger setSoundEffect ["Alarm", "", "", ""]</pre> |= Example 1
|x2= <pre> [_group1,2] setSoundEffect ["Alarm", "", "", ""]</pre> |= Example 2
|x3= <pre>_trigger setSoundEffect ["NoSound", "", "", "MySound"]; //NoSound = cfgSound dummy (no sound file), MySound = cfgSFX sound effect.</pre> |= Example 3


____________________________________________________________________________________________
|p5= soundDet: [[String]] - creates a dynamic sound object attached to a trigger defined in [[CfgSFX]] (mission or main config)


| |= See also
|r1= [[Nothing]]


}}
|s2= waypoint [[setSoundEffect]] [sound, voice]
 
|p21= waypoint: [[Waypoint]]
 
|p22= sound: [[String]] - plays a 2D sound as if [[playSound]] was used from CfgSounds (mission or main config)
 
|p23= voice: [[String]] - attaches a 3D sound from CfgSounds (mission or main config) to the object that activated the trigger and plays it as if [[say3D]] was used
 
|r2= [[Nothing]]
 
|x1= <sqf>_trigger setSoundEffect ["Alarm", "", "", ""];</sqf>
 
|x2= <sqf>[_group1, 2] setSoundEffect ["Alarm", ""];</sqf>
 
|x3= <sqf>_trigger setSoundEffect ["$NONE$", "Alarm", "", ""];</sqf>


<h3 style="display:none">Notes</h3>
|x4= <sqf>_trigger setSoundEffect ["$NONE$", "", "BattlefieldExplosions3", ""];</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x5= <sqf>_trigger setSoundEffect ["$NONE$", "", "", "Owl"];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[createTrigger]] [[setMusicEffect]] [[setTitleEffect]]
[[Category:Scripting Commands|SETSOUNDEFFECT]]
}}
[[Category:Scripting Commands OFP Elite |SETSOUNDEFFECT]]
[[Category:Scripting Commands ArmA|SETSOUNDEFFECT]]
[[Category:Scripting Commands ArmA2|SETSOUNDEFFECT]]
[[Category:Command_Group:_Sounds|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands VBS2|{{uc:{{PAGENAME}}}}]]

Latest revision as of 01:57, 3 January 2026

Hover & click on the images for description

Description

Description:
Defines the different sound effects for a trigger or a waypoint. To stop any sound, deactivate the trigger (might take up to 0.5 seconds to stop) or delete the trigger/waypoint (immediate).
Groups:
SoundsTriggersWaypoints

Syntax

Syntax:
trigger setSoundEffect [sound, voice, soundEnv, soundDet]
Parameters:
trigger: Object
sound: String - plays a 2D sound as if playSound was used from CfgSounds (mission or main config). Use "$NONE$" for an empty sound
voice: String - attaches a 3D sound from CfgSounds (mission or main config) to the object that activated the trigger and plays it as if say3D was used
soundEnv: String - plays an environmental sound from CfgEnvSounds (mission or main config)
soundDet: String - creates a dynamic sound object attached to a trigger defined in CfgSFX (mission or main config)
Return Value:
Nothing

Alternative Syntax

Syntax:
waypoint setSoundEffect [sound, voice]
Parameters:
waypoint: Waypoint
sound: String - plays a 2D sound as if playSound was used from CfgSounds (mission or main config)
voice: String - attaches a 3D sound from CfgSounds (mission or main config) to the object that activated the trigger and plays it as if say3D was used
Return Value:
Nothing

Examples

Example 1:
_trigger setSoundEffect ["Alarm", "", "", ""];
Example 2:
[_group1, 2] setSoundEffect ["Alarm", ""];
Example 3:
_trigger setSoundEffect ["$NONE$", "Alarm", "", ""];
Example 4:
_trigger setSoundEffect ["$NONE$", "", "BattlefieldExplosions3", ""];
Example 5:
_trigger setSoundEffect ["$NONE$", "", "", "Owl"];

Additional Information

See also:
createTrigger setMusicEffect setTitleEffect

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note