BIS fnc playMusic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Sound


| 1.00 |= Game version
|descr= Plays given song.
____________________________________________________________________________________________


| Plays given song. |DESCRIPTION=
|s1= [class,start,volume] call [[BIS_fnc_playMusic]]
____________________________________________________________________________________________


| [class,start,volume] call [[BIS_fnc_playMusic]] |SYNTAX=
|p1= class: [[String]] - classname of song


|p1= class: [[String]] - Classname of song |PARAMETER1=
|p2= start: [[Number]] - time of start in seconds - Default: 0
|p2= start: [[Number]] - Time of start in seconds - Default: 0 |PARAMETER2=
|p3= volume: [[Number]] - Music volume from 0 to 1 - Default: [[musicVolume]] |PARAMETER3=


| [[Boolean]] - true |RETURNVALUE=
|p3= volume: [[Number]] - music volume from 0 to 1 - Default: [[musicVolume]]
____________________________________________________________________________________________


|x1= <code>["LeadTrack04_F",10,0.5] call [[BIS_fnc_playMusic]]; {{codecomment|//Song starts at 10 seconds with 50% volume.}}</code> |EXAMPLE1=
|r1= [[Boolean]] - true
____________________________________________________________________________________________


| [[playMusic]] [[musicVolume]] |SEEALSO=
|x1= <sqf>["LeadTrack04_F", 10, 0.5] call BIS_fnc_playMusic; // song starts at 10 seconds with 50% volume.</sqf>


|seealso= [[playMusic]] [[musicVolume]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: MP|{{uc:playMusic}}]]
[[Category:Functions|{{uc:playMusic}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:playMusic}}]]

Latest revision as of 15:50, 8 November 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Plays given song.
Execution:
call
Groups:
Sound

Syntax

Syntax:
[class,start,volume] call BIS_fnc_playMusic
Parameters:
class: String - classname of song
start: Number - time of start in seconds - Default: 0
volume: Number - music volume from 0 to 1 - Default: musicVolume
Return Value:
Boolean - true

Examples

Example 1:
["LeadTrack04_F", 10, 0.5] call BIS_fnc_playMusic; // song starts at 10 seconds with 50% volume.

Additional Information

See also:
playMusic musicVolume

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_playMusic&oldid=349204"