BIS fnc music: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (template:command argument fix)
(One intermediate revision by one other user not shown)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| Randomly play provided tracks defined in [[Description.ext#CfgMusic|CfgMusic]] and does a 3 seconds [[fadeMusic|fade out]]. This function takes [[accTime]] into account. See also [[BIS_fnc_jukebox]]. |DESCRIPTION=
/*
____________________________________________________________________________________________
File: fn_music.sqf


Description:
| [tracklist, delay] call [[BIS_fnc_music]] |SYNTAX=
Jukebox


Parameter(s):
|p1= tracklist: [[Array]] of [[String|Strings]] - (Optional, default all game musics) a list of [[Description.ext#CfgMusic|CfgMusic]] classes |PARAMETER1=
_this: ARRAY - list of used songs (Optional)
NUMBER - delay between tracks (Optional)


Returns:
|p2= delay: [[Number]] - (Optional, default 3) delay in seconds between tracks |PARAMETER2=
Nothing
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_music]]; --> |= Syntax
|x1= <code><nowiki>[</nowiki>["myMusic1", "myMusic2"], 1] [[call]] [[BIS_fnc_music]];</code> |EXAMPLE1=
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________


|x1= <code></code> |=  
|x2= <code>[] [[call]] [[BIS_fnc_music]]; {{codecomment|// will play all game tracks}}</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[playMusic]], [[BIS_fnc_jukebox]] |SEEALSO=


}}
}}

Revision as of 15:32, 7 April 2019


A2 OA Logo.png1.00
Hover & click on the images for description

Description

Description:
Randomly play provided tracks defined in CfgMusic and does a 3 seconds fade out. This function takes accTime into account. See also BIS_fnc_jukebox.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[tracklist, delay] call BIS_fnc_music
Parameters:
tracklist: Array of Strings - (Optional, default all game musics) a list of CfgMusic classes
delay: Number - (Optional, default 3) delay in seconds between tracks
Return Value:
Nothing

Examples

Example 1:
[["myMusic1", "myMusic2"], 1] call BIS_fnc_music;
Example 2:
[] call BIS_fnc_music; // will play all game tracks

Additional Information

See also:
playMusicBIS_fnc_jukebox

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_music&oldid=120689"