fadeMusic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(65 intermediate revisions by 13 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97]]
[[Category:Scripting Commands OFP 1.46]]
[[Category:Scripting Commands ArmA]]


back to [[Scripting_Reference#F|COMREF]]
|game1= ofp
|version1= 1.00


<h2 style="color:#000066"> '''''time'' fadeMusic ''volume'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''time:''' [[Number]]
|game5= arma2oa
|version5= 1.50


'''volume:''' [[Number]]
|game6= tkoh
|version6= 1.00


'''Type of returned value:'''
|game7= arma3
|version7= 0.50


[[Nothing]]
|eff= local


'''Description:'''
|gr1= Sounds


Smooth change in music volume.
|descr= Changes the current music volume to the given value smoothly within the given time. {{Feature|informative|The player's in-game setting is not changed by this command: {{hl|Final Volume {{=}} Client Setting * Scripted Volume}}.}}


Change duration is given by '''time''' (in seconds), target volume by '''volume'''.
|s1= time [[fadeMusic]] volume


Volume range is 0 (no music) to 1 (full volume).
|p1= time: [[Number]] - fade interval in seconds


Default music volume is 0.5.
|p2= volume: [[Number]] - music volume range from 0 to 5


|r1= [[Nothing]]


'''Example:'''
|x1= <sqf>5 fadeMusic 0; // fade current music volume to 0 in 5 sec</sqf>


5 '''fadeMusic''' 0
|seealso= [[fadeSound]] [[fadeRadio]] [[fadeSpeech]] [[fadeEnvironment]] [[environmentVolume]] [[musicVolume]] [[soundVolume]] [[radioVolume]]
}}

Latest revision as of 00:25, 2 February 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
Changes the current music volume to the given value smoothly within the given time.
ⓘ
The player's in-game setting is not changed by this command: Final Volume = Client Setting * Scripted Volume.
Groups:
Sounds

Syntax

Syntax:
time fadeMusic volume
Parameters:
time: Number - fade interval in seconds
volume: Number - music volume range from 0 to 5
Return Value:
Nothing

Examples

Example 1:
5 fadeMusic 0; // fade current music volume to 0 in 5 sec

Additional Information

See also:
fadeSound fadeRadio fadeSpeech fadeEnvironment environmentVolume musicVolume soundVolume radioVolume

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=fadeMusic&oldid=352177"