fadeSound: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(66 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'' fadeSound ''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 all sounds volume.
|descr= Changes the sound volume 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''', target volume by '''volume'''.
|s1= time [[fadeSound]]  volume


Default sounds volume is 1.0.
|p1= time: [[Number]] - fade interval in seconds


|p2= volume: [[Number]] - sound volume range 0 to 1


'''Example:'''
|r1= [[Nothing]]


5 '''fadeSound''' 0.1
|x1= <sqf>5 fadeSound 0;</sqf>
 
|seealso= [[fadeRadio]] [[fadeSpeech]] [[fadeMusic]] [[fadeEnvironment]] [[environmentVolume]] [[soundVolume]] [[musicVolume]] [[radioVolume]]
}}
 
{{Note
|user= Lou Montana
|timestamp= 20100119131600
|text= This command doesn't work, in '''Arma 2 1.05'''.
}}

Latest revision as of 00:26, 2 February 2024

Hover & click on the images for description

Description

Description:
Changes the sound volume 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 fadeSound volume
Parameters:
time: Number - fade interval in seconds
volume: Number - sound volume range 0 to 1
Return Value:
Nothing

Examples

Example 1:
5 fadeSound 0;

Additional Information

See also:
fadeRadio fadeSpeech fadeMusic fadeEnvironment environmentVolume soundVolume musicVolume 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
Lou Montana - c
Posted on Jan 19, 2010 - 13:16 (UTC)
This command doesn't work, in Arma 2 1.05.