setMusicEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Some wiki formatting)
 
(3 intermediate revisions by the same user not shown)
Line 27: Line 27:
|descr= Defines a music track played on activation. If another track is playing already, this will stop it and start the new track.
|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 {{hl|[[playMusic]] ""}}.
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.
When used in a trigger, the track starts on activation but does not automatically stop on deactivation.


Line 41: Line 41:


|p21= waypoint: [[Array]] - format [[Waypoint]]
|p21= waypoint: [[Array]] - format [[Waypoint]]
|p22= track: [[String]]
|p22= track: [[String]]


|r2= [[Nothing]]
|r2= [[Nothing]]


|x1= <code>_trigger [[setMusicEffect]] "Track1";</code>
|x1= <sqf>_trigger setMusicEffect "Track1";</sqf>
|x2= <code>[_group1,1] [[setMusicEffect]] "$STOP$";</code>
 
|x2= <sqf>[_group1,1] setMusicEffect "$STOP$";</sqf>


|seealso= [[createTrigger]] [[setSoundEffect]], [[setTitleEffect]]
|seealso= [[createTrigger]] [[setSoundEffect]] [[setTitleEffect]]
}}
}}

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"