setMusicEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(51 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


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


| Defines the music track played on activation.
|game3= arma2
|version3= 1.00


Track is a subclass name of CfgMusic. In addition, "$STOP$" (stops the current music track). |DESCRIPTION=
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


| trigger '''setMusicEffect''' track |SYNTAX=
|game5= tkoh
|version5= 1.00


|p1= trigger: [[Object]] |PARAMETER1=
|game6= arma3
|version6= 0.50


|p2= track: [[String]] |PARAMETER2=
|gr1= Sounds


| [[Nothing]] |RETURNVALUE=
|gr2= Triggers
____________________________________________________________________________________________


|s2= waypoint '''setMusicEffect''' track |SYNTAX=
|gr3= Waypoints


|p21= waypoint: [[Array]] - format [[Waypoint]]|PARAMETER1=
|descr= Defines a music track played on activation. If another track is playing already, this will stop it and start the new track.
|p22= track: [[String]] |PARAMETER2=


|r2= [[Nothing]] |RETURNVALUE=
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.
 
|x1= <pre>_trigger setMusicEffect "Track1"</pre> |EXAMPLE1=
|x2= <pre>[_group1,1] setMusicEffect "$STOP$"</pre> |EXAMPLE2=
____________________________________________________________________________________________


| [[createTrigger]], [[setSoundEffect]] |SEEALSO=
|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]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>_trigger setMusicEffect "Track1";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>[_group1,1] setMusicEffect "$STOP$";</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[createTrigger]] [[setSoundEffect]] [[setTitleEffect]]
[[Category:Scripting Commands|SETMUSICEFFECT]]
}}
[[Category:Scripting Commands OFP Elite |SETMUSICEFFECT]]
[[Category:Scripting Commands ArmA|SETMUSICEFFECT]]
[[Category:Scripting Commands ArmA2|SETMUSICEFFECT]]
[[Category:Command_Group:_Sounds|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:11, 27 July 2023

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

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:
SoundsTriggersWaypoints

Syntax

Syntax:
trigger setMusicEffect track
Parameters:
trigger: Object
track: String
Return Value:
Nothing

Alternative Syntax

Syntax:
waypoint setMusicEffect track
Parameters:
waypoint: Array - format Waypoint
track: String
Return Value:
Nothing

Examples

Example 1:
_trigger setMusicEffect "Track1";
Example 2:
[_group1,1] setMusicEffect "$STOP$";

Additional Information

See also:
createTrigger setSoundEffect setTitleEffect

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
Retrieved from "https://community.bistudio.com/wiki?title=setMusicEffect&oldid=343876"