playMusic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "Arma 3 CfgMusic" to "Arma 3: CfgMusic")
 
(47 intermediate revisions by 4 users not shown)
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 |= Effects in MP
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Plays music defined in [[Description.ext#CfgMusic]] or config.cpp. To stop the music execute [[playMusic]] "" or give the start time which is beyond the music duration [[playMusic]] ["SomeMusic", 1000]; <br><br>
|game4= arma2
For Arma 3 music, see [[Arma 3 CfgMusic]]. Since Arma 3 v1.67 one can use [[Arma_3_Utilities#Jukebox|Jukebox Utility]] to preview in-game music. |DESCRIPTION=
|version4= 1.00
____________________________________________________________________________________________


| '''playMusic''' name |SYNTAX=
|game5= arma2oa
| p1 = name : [[String]] - music class
|version5= 1.50
|[[Nothing]]  |RETURNVALUE=
____________________________________________________________________________________________
|s2= '''playMusic''' [name, start] |SYNTAX= 2


|p21= [name, start]: [[Array]] |PARAMETER1=
|game6= tkoh
|p22 = name: [[String]] - music class |PARAMETER2=
|version6= 1.00
|p23= start: [[Number]] - start from (seconds). Could be negative. |PARAMETER3=


|r2= [[Nothing]] |RETURNVALUE= 2
|game7= arma3
|version7= 0.50


____________________________________________________________________________________________
|eff= local
|x1 = <code>[[playMusic]] "RadioAmbient1";</code> |EXAMPLE1= 
|x2 = <code>[[playMusic]] ["RadioAmbient3", 3]; //start from 00:00:03</code> |EXAMPLE2=
|x3 = Play from 00:00:01 to 00:00:05<code>0 = [] [[spawn]] {
[[playMusic]] ["RadioAmbient5", 1];
[[sleep]] 4;
[[playMusic]] "";
};</code> |EXAMPLE3=


| [[getMusicPlayedTime]], [[playSound]], [[say]], [[createSoundSource]], [[addMusicEventHandler]] |SEEALSO=
|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
 
|p22= start: [[Number]] - start, in seconds. Can be negative.
 
|r2= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>playMusic "RadioAmbient1";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">
|x2= <sqf>playMusic ["RadioAmbient3", 3]; // start to play from 00:00:03</sqf>
<dt class="note">'''[[User:Crowe|Crowe]]'''
<dd class="note">
You can get all Music Types from [[Arma:_cfgMusic]]
http://community.bistudio.com/wiki/Arma_2:_Music#top


<!-- 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.99|{{uc:{{PAGENAME}}}}]]
[[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:Scripting Commands Arma 3|PLAYMUSICNAME]]
[[Category:Command_Group:_Sounds|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:34, 26 June 2023

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
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:
[] 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
Retrieved from "https://community.bistudio.com/wiki?title=playMusic&oldid=341810"