BIS fnc playMusic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[cC]ategory:\{\{Name\|arma3\}\}: [fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
|version1= 1.00


| 1.00
|gr1= Sound


|gr1= Sound
|descr= Plays given song.
 
|s1= [class,start,volume] call [[BIS_fnc_playMusic]]


| Plays given song.
|p1= class: [[String]] - classname of song


| [class,start,volume] call [[BIS_fnc_playMusic]]
|p2= start: [[Number]] - time of start in seconds - Default: 0


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


| [[Boolean]] - true
|r1= [[Boolean]] - true


|x1= <code>["LeadTrack04_F",10,0.5] call [[BIS_fnc_playMusic]]; {{codecomment|//Song starts at 10 seconds with 50% volume.}}</code>
|x1= <sqf>["LeadTrack04_F", 10, 0.5] call BIS_fnc_playMusic; // song starts at 10 seconds with 50% volume.</sqf>


| [[playMusic]] [[musicVolume]]
|seealso= [[playMusic]] [[musicVolume]]
}}
}}

Latest revision as of 15:50, 8 November 2023

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