FAudioGMS-Docs/docs/latest/Functions-(Effect-Chains).md

96 lines
4.1 KiB
Markdown

## `~_EffectChain_Create()`
**Returns:** Number, an **effect chain ID**
|Argument|Datatype|Description |
|--------|--------|------------------------------------------------------|
|None | | |
 
## `~_EffectChain_Destroy(effectChainID)`
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------|
|`effectChainID`|number | |
 
## `~_EffectChain_AddDefaultReverb(effectChainID)`
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------|
|`effectChainID`| | |
 
## `~_EffectChain_AddReverb(...)`
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|------------------|--------|------------------------------------------------------|
|`effectChainID` |number | |
|`wetDryMix` |number | |
|`reflectionsDelay`|number | |
|`reverbDelay` |number | |
|`earlyDiffusion` |number | |
|`lateDiffusion` |number | |
|`lowEQGain` |number | |
|`lowEQCutoff` |number | |
|`highEQGain` |number | |
|`highEQCutoff` |number | |
|`reflectionsGain` |number | |
|`reverbGain` |number | |
|`decayTime` |number | |
|`density` |number | |
|`roomSize` |number | |
 
## `~_SoundInstance_SetEffectChain(soundInstanceID, effectChainID, effectGain)`
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|-----------------|--------|------------------------------------------------------|
|`soundInstanceID`|number | |
|`effectChainID` |number | |
|`effectGain` |number | |
 
## `~_SoundInstance_SetEffectGain(soundInstanceID, effectGain)`
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|-----------------|--------|------------------------------------------------------|
|`soundInstanceID`|number | |
|`effectGain` |number | |
 
## `~_SetMasteringEffectChain(effectChainID, effectGain)`
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------|
|`effectChainID`|number | |
|`effectGain` |number | |
 
## `~_SetMasteringEffectGain(effectGain)`
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|------------|--------|------------------------------------------------------|
|`effectGain`|number | |