BIS fnc music: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<code>([^<]*)\{\{cc\|([^{}]+)\}\} *<\/code>" to "<code>$1// $2</code>") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 13: | Line 13: | ||
|descr= 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]]. | |descr= 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]]. | ||
{{Feature|informative|The function stores the script handle in the {{hl|BIS_fnc_music_spawn}} variable that can be used to stop the function; see {{Link|#Example 3}} for its usage example.}} | |||
|s1=[tracklist, delay] call [[BIS_fnc_music]] | |s1= [tracklist, delay] call [[BIS_fnc_music]] | ||
|p1= tracklist: [[Array]] of [[String | |p1= tracklist: [[Array]] of [[String]]s - (Optional, default all game musics) a list of [[Description.ext#CfgMusic|CfgMusic]] classes | ||
|p2= delay: [[Number]] - (Optional, default 3) delay in seconds between tracks | |p2= delay: [[Number]] - (Optional, default 3) delay in seconds between tracks | ||
| Line 22: | Line 23: | ||
|r1= [[Nothing]] | |r1= [[Nothing]] | ||
|x1= < | |x1= <sqf>[["myMusic1", "myMusic2"], 1] call BIS_fnc_music; // play the two musics in a random order</sqf> | ||
|x2= < | |x2= <sqf>[] call BIS_fnc_music; // play all game tracks randomly</sqf> | ||
|x3= <sqf> | |||
[] 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 ""; | |||
</sqf> | |||
|seealso= [[playMusic]] [[BIS_fnc_jukebox]] | |seealso= [[playMusic]] [[BIS_fnc_jukebox]] | ||
}} | }} | ||
Latest revision as of 12:34, 23 January 2024
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:
- Example 2:
- Example 3:
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