BIS fnc music: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2oa |Game name=
| arma2oa


|1.00|Game version=
|1.00


|gr1 = Sound|GROUP1=
|gr1 = Sound


| 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=
| 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]].


| [tracklist, delay] call [[BIS_fnc_music]] |SYNTAX=
| [tracklist, delay] call [[BIS_fnc_music]]


|p1= tracklist: [[Array]] of [[String|Strings]] - (Optional, default all game musics) a list of [[Description.ext#CfgMusic|CfgMusic]] classes |PARAMETER1=
|p1= tracklist: [[Array]] of [[String|Strings]] - (Optional, default all game musics) a list of [[Description.ext#CfgMusic|CfgMusic]] classes


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


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


|x1= <code><nowiki>[</nowiki>["myMusic1", "myMusic2"], 1] [[call]] [[BIS_fnc_music]];</code> |EXAMPLE1=
|x1= <code><nowiki>[</nowiki>["myMusic1", "myMusic2"], 1] [[call]] [[BIS_fnc_music]];</code>


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


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


}}
}}

Revision as of 00:39, 18 January 2021

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:
Sound

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

Bottom Section