setMusicEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(71 intermediate revisions by 13 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|SETMUSICEFFECT]]
{{RV|type=command
[[Category:Scripting Commands OFP Elite |SETMUSICEFFECT]]
[[Category:Scripting Commands ArmA|SETMUSICEFFECT]]


|game1= ofpe
|version1= 1.00


<h2 style="color:#000066">'''''trigger or waypoint'' setMusicEffect ''track'''''</h2>
|game2= arma1
|version2= 1.00


|game3= arma2
|version3= 1.00


'''Operand types:'''
|game4= arma2oa
|version4= 1.50


'''trigger or waypoint:''' [[Object]] or [[Array]]
|game5= tkoh
|version5= 1.00


'''track:''' [[String]]
|game6= arma3
|version6= 0.50


'''Type of returned value:'''
|gr1= Sounds


[[Nothing]]
|gr2= Triggers


'''Compatibility:'''
|gr3= Waypoints


Version 1.86 required.
|descr= Defines a music track played on activation. If another track is playing already, this will stop it and start the new track.


'''Description:'''
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.


Defines the music track played on activation.
|s1= trigger [[setMusicEffect]] track


'''Track''' is a subclass name of CfgMusic.
|p1= trigger: [[Object]]


"$NONE$" (no change) or "$STOP$" (stops the current music track).
|p2= track: [[String]]


|r1= [[Nothing]]


'''Example:'''
|s2= waypoint [[setMusicEffect]] track


trigger '''setMusicEffect''' "Track1"
|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]]
}}

Latest revision as of 21:38, 26 September 2024

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=369607"