Player::setVoiceFxI3DL2Reverb: Difference between revisions
(Created page with "==Syntax== <pre> player.setVoiceFxI3DL2Reverb(fxHandle, { lRoom, lRoomHF, flRoomRolloffFactor, flDecayTime, flDecayHFRatio, lReflections, flReflect...") |
(types) |
||
| Line 18: | Line 18: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''fxHandle:''' The effect handle. | *'''fxHandle:''' {{RageType|int}} The effect handle. | ||
*'''lRoom:''' Attenuation of the room effect, in millibels (mB), in the range from -10000 to 0. The default value is -1000 mB. | *'''lRoom:''' {{RageType|int}} Attenuation of the room effect, in millibels (mB), in the range from -10000 to 0. The default value is -1000 mB. | ||
*'''lRoomHF:''' Attenuation of the room high-frequency effect, in mB, in the range from -10000 to 0. The default value is 0 mB. | *'''lRoomHF:''' {{RageType|int}} Attenuation of the room high-frequency effect, in mB, in the range from -10000 to 0. The default value is 0 mB. | ||
*'''flRoomRolloffFactor:''' Rolloff factor for the reflected signals, in the range from 0 to 10. The default value is 0.0. | *'''flRoomRolloffFactor:''' {{RageType|float}} Rolloff factor for the reflected signals, in the range from 0 to 10. The default value is 0.0. | ||
*'''flDecayTime:''' Decay time, in seconds, in the range from 0.1 to 20. The default value is 1.49 second. | *'''flDecayTime:''' {{RageType|float}} Decay time, in seconds, in the range from 0.1 to 20. The default value is 1.49 second. | ||
*'''flDecayHFRatio:''' Ratio of the decay time at high frequencies to the decay time at low frequencies, in the range from 0.1 to 2. The default value is 0.83. | *'''flDecayHFRatio:''' {{RageType|float}} Ratio of the decay time at high frequencies to the decay time at low frequencies, in the range from 0.1 to 2. The default value is 0.83. | ||
*'''lReflections:''' Attenuation of early reflections relative to lRoom, in mB, in the range from -10000 to 1000. The default value is -2602 mB. | *'''lReflections:''' {{RageType|int}} Attenuation of early reflections relative to lRoom, in mB, in the range from -10000 to 1000. The default value is -2602 mB. | ||
*'''flReflectionsDelay:''' Delay time of the first reflection relative to the direct path, in seconds, in the range from 0 to 0.3. The default value is 0.007 seconds. | *'''flReflectionsDelay:''' {{RageType|float}} Delay time of the first reflection relative to the direct path, in seconds, in the range from 0 to 0.3. The default value is 0.007 seconds. | ||
*'''lReverb:''' Attenuation of late reverberation relative to lRoom, in mB, in the range from -10000 to 2000. The default value is 200 mB. | *'''lReverb:''' {{RageType|int}} Attenuation of late reverberation relative to lRoom, in mB, in the range from -10000 to 2000. The default value is 200 mB. | ||
*'''flReverbDelay:''' Time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds, in the range from 0 to 0.1. The default value is 0.011 seconds. | *'''flReverbDelay:''' {{RageType|float}} Time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds, in the range from 0 to 0.1. The default value is 0.011 seconds. | ||
*'''flDiffusion:''' Echo density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent. | *'''flDiffusion:''' {{RageType|float}} Echo density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent. | ||
*'''flDensity:''' Modal density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent. | *'''flDensity:''' {{RageType|float}} Modal density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent. | ||
*'''flHFReference:''' Reference high frequency, in hertz, in the range from 20 to 20000. The default value is 5000.0 Hz. | *'''flHFReference:''' {{RageType|float}} Reference high frequency, in hertz, in the range from 20 to 20000. The default value is 5000.0 Hz. | ||
[[Category:Clientside API]] | [[Category:Clientside API]] | ||
Revision as of 18:38, 17 October 2022
Syntax
player.setVoiceFxI3DL2Reverb(fxHandle, {
lRoom,
lRoomHF,
flRoomRolloffFactor,
flDecayTime,
flDecayHFRatio,
lReflections,
flReflectionsDelay,
lReverb,
flReverbDelay,
flDiffusion,
flDensity,
flHFReference
});
Required Arguments
- fxHandle: int The effect handle.
- lRoom: int Attenuation of the room effect, in millibels (mB), in the range from -10000 to 0. The default value is -1000 mB.
- lRoomHF: int Attenuation of the room high-frequency effect, in mB, in the range from -10000 to 0. The default value is 0 mB.
- flRoomRolloffFactor: float Rolloff factor for the reflected signals, in the range from 0 to 10. The default value is 0.0.
- flDecayTime: float Decay time, in seconds, in the range from 0.1 to 20. The default value is 1.49 second.
- flDecayHFRatio: float Ratio of the decay time at high frequencies to the decay time at low frequencies, in the range from 0.1 to 2. The default value is 0.83.
- lReflections: int Attenuation of early reflections relative to lRoom, in mB, in the range from -10000 to 1000. The default value is -2602 mB.
- flReflectionsDelay: float Delay time of the first reflection relative to the direct path, in seconds, in the range from 0 to 0.3. The default value is 0.007 seconds.
- lReverb: int Attenuation of late reverberation relative to lRoom, in mB, in the range from -10000 to 2000. The default value is 200 mB.
- flReverbDelay: float Time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds, in the range from 0 to 0.1. The default value is 0.011 seconds.
- flDiffusion: float Echo density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent.
- flDensity: float Modal density in the late reverberation decay, in percent, in the range from 0 to 100. The default value is 100.0 percent.
- flHFReference: float Reference high frequency, in hertz, in the range from 20 to 20000. The default value is 5000.0 Hz.