Player::setVoiceFxEcho: Difference between revisions

Latest revision as of 08:31, 10 November 2024

Syntax

player.setVoiceFxEcho(fxHandle, {
    fWetDryMix,
    fFeedback,
    fLeftDelay,
    fRightDelay,
    lPanDelay
});

Required Arguments

fxHandle: int The effect handle.
fWetDryMix: float Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 (default) through 100 (all wet).
fFeedback: float Percentage of output fed back into input, in the range from 0 through 100. The default value is 0.
fLeftDelay: float Delay for left channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
fRightDelay: float Delay for right channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
lPanDelay: int Value that specifies whether to swap left and right delays with each successive echo. The default value is false, meaning no swap.

@@ Line 11: / Line 11: @@
 ===Required Arguments===
-*'''fxHandle:''' The effect handle.
+*'''fxHandle:''' {{RageType|int}} The effect handle.
-*'''fWetDryMix:''' Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 (default) through 100 (all wet).
+*'''fWetDryMix:''' {{RageType|float}} Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 (default) through 100 (all wet).
-*'''fFeedback:''' Percentage of output fed back into input, in the range from 0 through 100. The default value is 0.
+*'''fFeedback:''' {{RageType|float}} Percentage of output fed back into input, in the range from 0 through 100. The default value is 0.
-*'''fLeftDelay:''' Delay for left channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
+*'''fLeftDelay:''' {{RageType|float}} Delay for left channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
-*'''fRightDelay:''' Delay for right channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
+*'''fRightDelay:''' {{RageType|float}} Delay for right channel, in milliseconds, in the range from 1 through 2000. The default value is 333 ms.
-*'''lPanDelay:''' Value that specifies whether to swap left and right delays with each successive echo. The default value is false, meaning no swap.
+*'''lPanDelay:''' {{RageType|int}} Value that specifies whether to swap left and right delays with each successive echo. The default value is false, meaning no swap.
+==See also==
+{{VoiceFx_definition_c}}
 [[Category:Clientside API]]