Player::setVoiceFxVolume: Difference between revisions
(Created page with "==Syntax== <pre> player.setVoiceFxVolume(fxHandle, { fTarget, fCurrent, fTime, lCurve }); </pre> ===Required Arguments=== *'''fxHandle:''' The effect handle....") |
(types) |
||
| Line 10: | Line 10: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''fxHandle:''' The effect handle. | *'''fxHandle:''' {{RageType|int}} The effect handle. | ||
*'''fTarget:''' The new volume level... 0 = silent, 1.0 = normal, above 1.0 = amplification. The default value is 1. | *'''fTarget:''' {{RageType|float}} The new volume level... 0 = silent, 1.0 = normal, above 1.0 = amplification. The default value is 1. | ||
*'''fCurrent:''' The current volume level... -1 = leave existing current level when setting parameters. The default value is 1. | *'''fCurrent:''' {{RageType|float}} The current volume level... -1 = leave existing current level when setting parameters. The default value is 1. | ||
*'''fTime:''' The time to take to transition from the current level to the new level, in seconds. The default value is 0. | *'''fTime:''' {{RageType|float}} The time to take to transition from the current level to the new level, in seconds. The default value is 0. | ||
*'''lCurve:''' The curve to use in the transition... 0 = linear, 1 = logarithmic. The default value is 0. | *'''lCurve:''' {{RageType|int}} The curve to use in the transition... 0 = linear, 1 = logarithmic. The default value is 0. | ||
[[Category:Clientside API]] | [[Category:Clientside API]] | ||
Revision as of 18:39, 17 October 2022
Syntax
player.setVoiceFxVolume(fxHandle, {
fTarget,
fCurrent,
fTime,
lCurve
});
Required Arguments
- fxHandle: int The effect handle.
- fTarget: float The new volume level... 0 = silent, 1.0 = normal, above 1.0 = amplification. The default value is 1.
- fCurrent: float The current volume level... -1 = leave existing current level when setting parameters. The default value is 1.
- fTime: float The time to take to transition from the current level to the new level, in seconds. The default value is 0.
- lCurve: int The curve to use in the transition... 0 = linear, 1 = logarithmic. The default value is 0.