BIS_fnc_music

From Bohemia Interactive Community
Revision as of 13:34, 23 January 2024 by Lou Montana (talk | contribs) (Some wiki formatting)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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.
The function stores the script handle in the BIS_fnc_music_spawn variable that can be used to stop the function; see Example 3 for its usage example.
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; // play the two musics in a random order
Example 2:
[] call BIS_fnc_music; // play all game tracks randomly
Example 3:
[] call BIS_fnc_music; private _startingPos = getPosWorld player; private _timeLimit = time + 30; waitUntil { sleep 1; getPosWorld player distance _startingPos > 50 || time > _timeLimit }; if (!isNil "BIS_fnc_music_spawn") then { terminate BIS_fnc_music_spawn }; playMusic "";

Additional Information

See also:
playMusic BIS_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