Player::setVoiceFxFlanger: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
 
(One intermediate revision by one other user not shown)
Line 13: Line 13:
   
   
===Required Arguments===
===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).
*'''fDepth:''' Percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 25.
*'''fDepth:''' {{RageType|float}} Percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 25.
*'''fFeedback:''' Percentage of output signal to feed back into the effect's input, in the range from -99 to 99. The default value is 0.
*'''fFeedback:''' {{RageType|float}} Percentage of output signal to feed back into the effect's input, in the range from -99 to 99. The default value is 0.
*'''fFrequency:''' Frequency of the LFO, in the range from 0 to 10. The default value is 0.
*'''fFrequency:''' {{RageType|float}} Frequency of the LFO, in the range from 0 to 10. The default value is 0.
*'''lWaveform:''' Waveform of the LFO... 0 = triangle, 1 = sine. By default, the waveform is a sine.
*'''lWaveform:''' {{RageType|int}} Waveform of the LFO... 0 = triangle, 1 = sine. By default, the waveform is a sine.
*'''fDelay:''' Number of milliseconds the input is delayed before it is played back, in the range from 0 to 4. The default value is 0 ms.
*'''fDelay:''' {{RageType|float}} Number of milliseconds the input is delayed before it is played back, in the range from 0 to 4. The default value is 0 ms.
*'''lPhase:''' Phase differential between left and right LFOs, one of the BASSFXPhase values. Default (int)BASSFXPhase.BASS_FX_PHASE_ZERO.
*'''lPhase:''' {{RageType|int}} Phase differential between left and right LFOs, one of the BASSFXPhase values. Default (int)BASSFXPhase.BASS_FX_PHASE_ZERO.


==BASSFXPhase==
==BASSFXPhase==
Line 32: Line 32:
};
};
</pre>
</pre>
==See also==
{{VoiceFx_definition_c}}


[[Category:Clientside API]]
[[Category:Clientside API]]

Latest revision as of 08:32, 10 November 2024

Syntax

player.setVoiceFxFlanger(fxHandle, {
    fWetDryMix,
    fDepth,
    fFeedback,
    fFrequency,
    lWaveform,
    fDelay,
    lPhase
});

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).
  • fDepth: float Percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 25.
  • fFeedback: float Percentage of output signal to feed back into the effect's input, in the range from -99 to 99. The default value is 0.
  • fFrequency: float Frequency of the LFO, in the range from 0 to 10. The default value is 0.
  • lWaveform: int Waveform of the LFO... 0 = triangle, 1 = sine. By default, the waveform is a sine.
  • fDelay: float Number of milliseconds the input is delayed before it is played back, in the range from 0 to 4. The default value is 0 ms.
  • lPhase: int Phase differential between left and right LFOs, one of the BASSFXPhase values. Default (int)BASSFXPhase.BASS_FX_PHASE_ZERO.

BASSFXPhase

const BASSFXPhase = {
    BASS_FX_PHASE_NEG_180: 0, // Phase differential between left and right LFOs (-180)
    BASS_FX_PHASE_NEG_90: 1, // Phase differential between left and right LFOs (-90)
    BASS_FX_PHASE_ZERO: 2, // Phase differential between left and right LFOs (+/-0)
    BASS_FX_PHASE_90: 3, // Phase differential between left and right LFOs (+90)
    BASS_FX_PHASE_180: 4 // Phase differential between left and right LFOs (+180)
};

See also