fadeMusic: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|eff= local |Multiplayer Effects=
|game3= arma1
|version3= 1.00


|gr1 = Sounds |GROUP1=
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Changes the current music volume to the given value smoothly within the given time. |DESCRIPTION=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| time '''fadeMusic''' volume |SYNTAX=
|game6= tkoh
|version6= 1.00


|p1= time: [[Number]]  - fade interval in seconds |PARAMETER1=
|game7= arma3
|version7= 0.50


|p2= volume: [[Number]] - music volume range 0 to 1. Maximum volume is 1. Default is 0.5. |PARAMETER2=
|eff= local


| [[Nothing]] |RETURNVALUE=
|gr1= Sounds
____________________________________________________________________________________________
 
|x1= <code>5 [[fadeMusic]] 0; // fade current music volume to 0 in 5 sec</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[fadeSound]], [[fadeRadio]], [[fadeSpeech]], [[musicVolume]], [[soundVolume]], [[radioVolume]] |SEEALSO=
|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}}.}}


}}
|s1= time [[fadeMusic]]  volume
 
|p1= time: [[Number]] - fade interval in seconds
 
|p2= volume: [[Number]] - music volume range from 0 to 5


<h3 style="display:none">Notes</h3>
|r1= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>5 fadeMusic 0; // fade current music volume to 0 in 5 sec</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[fadeSound]] [[fadeRadio]] [[fadeSpeech]] [[fadeEnvironment]] [[environmentVolume]] [[musicVolume]] [[soundVolume]] [[radioVolume]]
[[Category:Scripting Commands|FADEMUSIC]]
}}
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|FADEMUSIC]]
[[Category:Scripting Commands OFP 1.46|FADEMUSIC]]
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 2|FADEMUSIC]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 00:25, 2 February 2024

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