playMusic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Text replacement - "[] spawn" to "0 spawn")
 
(11 intermediate revisions by 2 users not shown)
Line 27: Line 27:


|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}}.
|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 3: CfgMusic]]
* [[Arma 2: CfgMusic]]
* [[Arma 2: CfgMusic]]
* [[ArmA: CfgMusic]]
* [[ArmA: Armed Assault: CfgMusic]]
* [[Operation Flashpoint: CfgMusic]]


{{Feature | Informative | To stop the music, use {{ic|[[playMusic]] ""}}.}}
{{Feature|informative|To stop the music, use <sqf inline>playMusic "";</sqf>.}}


|s1= [[playMusic]] musicName
|s1= [[playMusic]] musicName
Line 47: Line 48:
|r2= [[Nothing]]
|r2= [[Nothing]]


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


|x2= <code>[[playMusic]] ["RadioAmbient3", 3]; {{cc|start to play from 00:00:03}}</code>
|x2= <sqf>playMusic ["RadioAmbient3", 3]; // start to play from 00:00:03</sqf>


|x3= Play from 00:00:01 to 00:00:05:
|x3= Play from 00:00:01 to 00:00:05:
<code>[] [[spawn]] {
<sqf>
[[playMusic]] ["RadioAmbient5", 1];
0 spawn {
[[sleep]] 4;
playMusic ["RadioAmbient5", 1];
[[playMusic]] "";
sleep 4;
};</code>
playMusic "";
};
</sqf>


|seealso= [[getMusicPlayedTime]] [[playSound]] [[say]] [[createSoundSource]] [[addMusicEventHandler]], [[fadeMusic]] [[Arma_3_Utilities#Jukebox|{{arma3}} Jukebox Utility]]
|seealso= [[getMusicPlayedTime]] [[playSound]] [[say]] [[createSoundSource]] [[addMusicEventHandler]] [[fadeMusic]] [[Arma_3_Utilities#Jukebox|{{arma3}} Jukebox Utility]]
}}
}}

Latest revision as of 21:24, 2 September 2024

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