playMusic: Difference between revisions

Latest revision as of 21:24, 2 September 2024

1.00

Hover & click on the images for description

Description

Description:

Plays music defined in Description.ext's CfgMusic or config.cpp. If the musicName could not be found a message is logged into the .rpt file: Music <musicName> not found.

ⓘ

To stop the music, use playMusic "";.

Groups:

Sounds

Syntax

Syntax:: playMusic musicName
Parameters:: musicName: String - music classname
Return Value:: Nothing

Alternative Syntax

Syntax:: playMusic [musicName, start]
Parameters:: musicName: String - music classname
: start: Number - start, in seconds. Can be negative.
Return Value:: Nothing

Examples

Example 1:: playMusic "RadioAmbient1";
Example 2:: playMusic ["RadioAmbient3", 3]; // start to play from 00:00:03
Example 3:: Play from 00:00:01 to 00:00:05:
0 spawn { playMusic ["RadioAmbient5", 1]; sleep 4; playMusic ""; };

Additional Information

See also:: getMusicPlayedTime playSound say createSoundSource addMusicEventHandler fadeMusic Arma 3 Jukebox Utility

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| ofp |= Game name
+|game1= ofp
+|version1= 1.00
-|1.00|= Game version
+|game2= ofpe
-____________________________________________________________________________________________
+|version2= 1.00
-| Plays music defined in [[Description.ext#Music|CfgMusic]].  |= Description
+|game3= arma1
-____________________________________________________________________________________________
+|version3= 1.00
-| '''playMusic''' name |= Syntax
+|game4= arma2
-| p1 = name : [[String]]
+|version4= 1.00
-|[[Nothing]]  |= Return value
-____________________________________________________________________________________________
-|s2= '''playMusic''' [name,position] |= Syntax 2
-|p21= [name,position]: [[Array]] |= Parameter 1
+|game5= arma2oa
-|p22 = name: [[String]] |= Parameter 2
+|version5= 1.50
-|p23= position: [[Number]] in seconds |= Parameter 3
-|r2= [[Nothing]] |= Return value 2
+|game6= tkoh
+|version6= 1.00
-____________________________________________________________________________________________
+|game7= arma3
-|x1 = <code>'''playMusic''' "musicname"</code> |= Example 1
+|version7= 0.50
-|x2 = <code>playMusic ["Track13", 30]</code> |= Example 2
-| [[playSound]], [[say]], [[say string]], [[createSoundSource]] |= See also
+|eff= local
-}}
+|gr1= Sounds
+|descr= Plays music defined in [[Description.ext#CfgMusic|Description.ext's CfgMusic]] or config.cpp. If the ''musicName'' could not be found a message is logged into the .rpt file: {{hl|Music <''musicName''> not found}}.
+* [[Arma 3: CfgMusic]]
+* [[Arma 2: CfgMusic]]
+* [[ArmA: Armed Assault: CfgMusic]]
+* [[Operation Flashpoint: CfgMusic]]
+{{Feature|informative|To stop the music, use <sqf inline>playMusic "";</sqf>.}}
+|s1= [[playMusic]] musicName
+|p1= musicName: [[String]] - music classname
+|r1= [[Nothing]]
+|s2= [[playMusic]] [musicName, start]
+|p21= musicName: [[String]] - music classname
-<h3 style="display:none">Notes</h3>
+|p22= start: [[Number]] - start, in seconds. Can be negative.
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<dd class="notedate"></dd>
+|r2= [[Nothing]]
-<dt class="note">'''[[User:Crowe|Crowe]]'''</dt>
-<dd class="note">
-You can get all Music Types from [[Arma:_cfgMusic]]</dd>
+|x1= <sqf>playMusic "RadioAmbient1";</sqf>
+|x2= <sqf>playMusic ["RadioAmbient3", 3]; // start to play from 00:00:03</sqf>
-<!-- Note Section END -->
+|x3= Play from 00:00:01 to 00:00:05:
-</dl>
+<sqf>
+spawn {
+	playMusic ["RadioAmbient5", 1];
+	sleep 4;
+	playMusic "";
+};
+</sqf>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[getMusicPlayedTime]] [[playSound]] [[say]] [[createSoundSource]] [[addMusicEventHandler]] [[fadeMusic]] [[Arma_3_Utilities#Jukebox|{{arma3}} Jukebox Utility]]
-[[Category:Scripting Commands|PLAYMUSICNAME]]
+}}
-[[Category:Scripting Commands OFP 1.96|PLAYMUSICNAME]]
-[[Category:Scripting Commands OFP 1.46|PLAYMUSICNAME]]
-[[Category:Scripting Commands ArmA|PLAYMUSICNAME]]
-[[Category:Scripting Commands ArmA2|PLAYMUSICNAME]]
-[[Category:Command_Group:_Sounds|{{uc:{{PAGENAME}}}}]]