setMusicEffect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite *(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma1 |Game name=
| arma1 |Game name=
Line 11: Line 10:


|gr3= Waypoints |GROUP3=
|gr3= Waypoints |GROUP3=
____________________________________________________________________________________________


| Defines the music track played on activation.
| Defines the music track played on activation.


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


| trigger '''setMusicEffect''' track |SYNTAX=
| trigger '''setMusicEffect''' track |SYNTAX=
Line 25: Line 22:


| [[Nothing]] |RETURNVALUE=
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________


|s2= waypoint '''setMusicEffect''' track |SYNTAX2=
|s2= waypoint '''setMusicEffect''' track |SYNTAX2=
Line 33: Line 29:


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]] |RETURNVALUE2=
____________________________________________________________________________________________
   
   
|x1= <pre>_trigger setMusicEffect "Track1"</pre> |EXAMPLE1=
|x1= <pre>_trigger setMusicEffect "Track1"</pre> |EXAMPLE1=
|x2= <pre>[_group1,1] setMusicEffect "$STOP$"</pre> |EXAMPLE2=
|x2= <pre>[_group1,1] setMusicEffect "$STOP$"</pre> |EXAMPLE2=
____________________________________________________________________________________________


| [[createTrigger]], [[setSoundEffect]] |SEEALSO=
| [[createTrigger]], [[setSoundEffect]] |SEEALSO=

Revision as of 02:35, 17 January 2021

Hover & click on the images for description

Description

Description:
Defines the music track played on activation. Track is a subclass name of CfgMusic. In addition, "$STOP$" (stops the current music track).
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:
createTriggersetSoundEffect

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

Notes

Bottom Section