nik
/
FAudioGMS-Docs
forked from MoonsideGames/FAudioGMS-Docs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update Functions-(Effect-Chains).md

main
Juju Adams 2021-11-02 22:14:12 +00:00
parent a5a8e8015e
commit 3d0ecce45f
1 changed files with 32 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/latest/Functions-(Effect-Chains).md
View File

@ -6,6 +6,8 @@
|--------|--------|------------------------------------------------------| |--------|--------|------------------------------------------------------|
|None | | | |None | | |
Creates a new effect chain that can be modified and applied to sound instances (or the master buss).
   
## `~_EffectChain_Destroy(effectChainID)` ## `~_EffectChain_Destroy(effectChainID)`
@ -14,7 +16,9 @@
|Argument |Datatype|Description | |Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------| |---------------|--------|------------------------------------------------------|
|`effectChainID`|number | | |`effectChainID`|number |Effect chain to target |
Destroys an effect chain, freeing memory associated with it.
   
@ -24,7 +28,9 @@
|Argument |Datatype|Description | |Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------| |---------------|--------|------------------------------------------------------|
|`effectChainID`| | | |`effectChainID`|number |Effect chain to target |
Adds a pleasant-sounding default reverb to the effect chain.
   
@ -34,7 +40,7 @@
|Argument |Datatype|Description | |Argument |Datatype|Description |
|------------------|--------|------------------------------------------------------| |------------------|--------|------------------------------------------------------|
|`effectChainID` |number | | |`effectChainID` |number |Effect chain to target |
|`wetDryMix` |number | | |`wetDryMix` |number | |
|`reflectionsDelay`|number | | |`reflectionsDelay`|number | |
|`reverbDelay` |number | | |`reverbDelay` |number | |
@ -50,6 +56,7 @@
|`density` |number | | |`density` |number | |
|`roomSize` |number | | |`roomSize` |number | |
Adds a reverb effect with many (many...) parameters to the effect chain.
   
@ -59,9 +66,11 @@
|Argument |Datatype|Description | |Argument |Datatype|Description |
|-----------------|--------|------------------------------------------------------| |-----------------|--------|------------------------------------------------------|
|`soundInstanceID`|number | | |`soundInstanceID`|number |Sound instance to target |
|`effectChainID` |number | | |`effectChainID` |number |Effect chain to apply |
|`effectGain` |number | | |`effectGain` |number |Gain of the effect. `1` is 100% volume |
Applies an effect chain to the given sound instance.
   
@ -70,9 +79,11 @@
**Returns:** N/A (`undefined`) **Returns:** N/A (`undefined`)
|Argument |Datatype|Description | |Argument |Datatype|Description |
|-----------------|--------|------------------------------------------------------| |-----------------|--------|----------------------------------------------------------------------------|
|`soundInstanceID`|number | | |`soundInstanceID`|number |Sound instance to target |
|`effectGain` |number | | |`effectGain` |number |Gain of the effect already applied to the sound instance. `1` is 100% volume|
Modifies the effect chain gain for the given sound instance. This function will do nothing if no effect chain has been applied.
   
@ -81,9 +92,11 @@
**Returns:** N/A (`undefined`) **Returns:** N/A (`undefined`)
|Argument |Datatype|Description | |Argument |Datatype|Description |
|---------------|--------|------------------------------------------------------| |---------------|--------|--------------------------------------|
|`effectChainID`|number | | |`effectChainID`|number |Effect chain to apply |
|`effectGain` |number | | |`effectGain` |number |Gain of the effect. `1` is 100% volume|
Applies an effect chain to the master buss, changing how every piece of audio sounds. This function does **not** apply an effect to each individual sound instance, simply the whole output audio.
   
@ -92,5 +105,7 @@
**Returns:** N/A (`undefined`) **Returns:** N/A (`undefined`)
|Argument |Datatype|Description | |Argument |Datatype|Description |
|------------|--------|------------------------------------------------------| |------------|--------|-------------------------------------------------------------------------|
|`effectGain`|number | | |`effectGain`|number |Gain of the effect already applied to the master buss. `1` is 100% volume|
Modifies the effect chain gain for the master buss. This function will do nothing if no effect chain has been applied.