setMusicEffect: Difference between revisions

Latest revision as of 18:11, 27 July 2023

Hover & click on the images for description

Description:: Defines a music track played on activation. If another track is playing already, this will stop it and start the new track. Track is a subclass name of CfgMusic. In addition, "$STOP$" (stops the current music track) or use playMusic "". When used in a trigger, the track starts on activation but does not automatically stop on deactivation.
Groups:: Sounds Triggers Waypoints

: 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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands|R]]
+{{RV|type=command
-[[Category:Scripting Commands ArmA|R]]
-<new command not populated>
+|game1= ofpe
+|version1= 1.00
+|game2= arma1
+|version2= 1.00
-<h2 style="color:#000066">''''' setMusicEffect '''''</h2>
+|game3= arma2
+|version3= 1.00
+|game4= arma2oa
+|version4= 1.50
-'''Operand types:'''
+|game5= tkoh
+|version5= 1.00
-'''Type of returned value:'''
+|game6= arma3
+|version6= 0.50
-'''Compatibility:'''
+|gr1= Sounds
-'''Description:'''
+|gr2= Triggers
+|gr3= Waypoints
-'''Example:'''
+|descr= Defines a music track played on activation. If another track is playing already, this will stop it and start the new track.
+Track is a subclass name of CfgMusic. In addition, "$STOP$" (stops the current music track) or use <sqf inline>playMusic ""</sqf>.
+When used in a trigger, the track starts on activation but does not automatically stop on deactivation.
+|s1= trigger [[setMusicEffect]] track
+|p1= trigger: [[Object]]
+|p2= track: [[String]]
+|r1= [[Nothing]]
+|s2= waypoint [[setMusicEffect]] track
+|p21= waypoint: [[Array]] - format [[Waypoint]]
+|p22= track: [[String]]
+|r2= [[Nothing]]
+|x1= <sqf>_trigger setMusicEffect "Track1";</sqf>
+|x2= <sqf>[_group1,1] setMusicEffect "$STOP$";</sqf>
+|seealso= [[createTrigger]] [[setSoundEffect]] [[setTitleEffect]]
+}}