BIS fnc playMusic: 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


| arma3 |Game name=
| arma3


| 1.00 |Game version=
| 1.00


|gr1= Sound |GROUP1=
|gr1= Sound


| Plays given song. |DESCRIPTION=
| Plays given song.


| [class,start,volume] call [[BIS_fnc_playMusic]] |SYNTAX=
| [class,start,volume] call [[BIS_fnc_playMusic]]


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


| [[Boolean]] - true |RETURNVALUE=
| [[Boolean]] - true


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


| [[playMusic]] [[musicVolume]] |SEEALSO=
| [[playMusic]] [[musicVolume]]


}}
}}

Revision as of 23:39, 17 January 2021

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

Bottom Section