playMusic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{uc:{{PAGENAME}}}} " to "")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|eff= local
|eff= local
Line 9: Line 26:
|gr1= Sounds
|gr1= Sounds


| 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: <tt>Music <''musicName''> not found</tt>.
|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: <tt>Music <''musicName''> not found</tt>.
* [[Arma 3 CfgMusic]]
* [[Arma 3 CfgMusic]]
* [[Arma 2: CfgMusic]]
* [[Arma 2: CfgMusic]]
Line 16: Line 33:
{{Feature | Informative | To stop the music, use {{ic|[[playMusic]] ""}}.}}
{{Feature | Informative | To stop the music, use {{ic|[[playMusic]] ""}}.}}


{{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.}}
|s1= [[playMusic]] musicName
 
| [[playMusic]] musicName


|p1= musicName: [[String]] - music classname
|p1= musicName: [[String]] - music classname


|[[Nothing]]
|r1= [[Nothing]]


|s2= [[playMusic]] [musicName, start]
|s2= [[playMusic]] [musicName, start]
Line 43: Line 58:
};</code>
};</code>


|seealso= [[getMusicPlayedTime]], [[playSound]], [[say]], [[createSoundSource]], [[addMusicEventHandler]], [[fadeMusic]]
|seealso= [[getMusicPlayedTime]], [[playSound]], [[say]], [[createSoundSource]], [[addMusicEventHandler]], [[fadeMusic]] [[Arma_3_Utilities#Jukebox|{{arma3}} Jukebox Utility]]
}}
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}

Revision as of 15:43, 9 June 2021

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:
getMusicPlayedTimeplaySoundsaycreateSoundSourceaddMusicEventHandlerfadeMusic 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=260193"