playMusic: Difference between revisions

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


| ofp |Game name=
| ofp |Game name=
Line 9: Line 8:


|gr1= Sounds |GROUP1=
|gr1= Sounds |GROUP1=
____________________________________________________________________________________________


| 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>.
| 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>.
Line 19: Line 17:


{{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=
{{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=
____________________________________________________________________________________________


| [[playMusic]] musicName |SYNTAX=
| [[playMusic]] musicName |SYNTAX=
Line 26: Line 23:


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


|s2= [[playMusic]] [musicName, start] |SYNTAX2=
|s2= [[playMusic]] [musicName, start] |SYNTAX2=
Line 35: Line 31:


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]] |RETURNVALUE2=
____________________________________________________________________________________________


|x1= <code>[[playMusic]] "RadioAmbient1";</code> |EXAMPLE1=
|x1= <code>[[playMusic]] "RadioAmbient1";</code> |EXAMPLE1=

Revision as of 03:21, 17 January 2021

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 "".
Arma 3
See Arma 3 CfgMusic for possible vanilla values. Since Arma 3 v1.67 one can use the Jukebox Utility to preview in-game music.
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

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