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
-|eff= local |Multiplayer Effects=
+|game3= arma1
-____________________________________________________________________________________________
+|version3= 1.00
-| Plays music defined in [[Description.ext#CfgMusic|Description.ext's CfgMusic]] or config.cpp.
+|game4= arma2
-* [[Arma 3 CfgMusic]]
+|version4= 1.00
-* [[Arma 2: Music]]
-* [[Arma: cfgMusic]]
-{{Informative | To stop the music, use {{Inline code|[[playMusic]] ""}}.}}
+|game5= arma2oa
+|version5= 1.50
-{{Feature arma3 | See [[Arma 3 CfgMusic]] for possible vanilla values. Since {{arma3}} v1.67 one can use the [[Arma_3_Utilities#Jukebox|Jukebox Utility]] to preview in-game music.}} |DESCRIPTION=
+|game6= tkoh
-____________________________________________________________________________________________
+|version6= 1.00
-| [[playMusic]] musicName |SYNTAX=
+|game7= arma3
+|version7= 0.50
-|p1= musicName: [[String]] - music classname |Parameter1=
+|eff= local
-|[[Nothing]] |RETURNVALUE=
+|gr1= Sounds
-____________________________________________________________________________________________
-|s2= [[playMusic]] [musicName, start] |SYNTAX2=
+|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]]
-|p21= musicName: [[String]] - music classname |PARAMETER21=
+{{Feature|informative|To stop the music, use <sqf inline>playMusic "";</sqf>.}}
-|p22= start: [[Number]] - start, in seconds. Can be negative. |PARAMETER22=
+|s1= [[playMusic]] musicName
-|r2= [[Nothing]] |RETURNVALUE2=
+|p1= musicName: [[String]] - music classname
-____________________________________________________________________________________________
-|x1= <code>[[playMusic]] "RadioAmbient1";</code> |EXAMPLE1=
+|r1= [[Nothing]]
-|x2= <code>[[playMusic]] ["RadioAmbient3", 3]; {{cc|start to play from 00:00:03}}</code> |EXAMPLE2=
+|s2= [[playMusic]] [musicName, start]
-|x3= Play from 00:00:01 to 00:00:05:
+|p21= musicName: [[String]] - music classname
-<code>[] [[spawn]] {
-	[[playMusic]] ["RadioAmbient5", 1];
+|p22= start: [[Number]] - start, in seconds. Can be negative.
-	[[sleep]] 4;
-	[[playMusic]] "";
+|r2= [[Nothing]]
-};</code> |EXAMPLE3=
-| [[getMusicPlayedTime]], [[playSound]], [[say]], [[createSoundSource]], [[addMusicEventHandler]] |SEEALSO=
+|x1= <sqf>playMusic "RadioAmbient1";</sqf>
-}}
-<h3 style="display:none">Notes</h3>
+|x2= <sqf>playMusic ["RadioAmbient3", 3]; // start to play from 00:00:03</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- 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|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Sounds|{{uc:{{PAGENAME}}}}]]