diff --git a/docs/latest/Functions-(Effect-Chains).md b/docs/latest/Functions-(Effect-Chains).md index 50ea51c..ac0895a 100644 --- a/docs/latest/Functions-(Effect-Chains).md +++ b/docs/latest/Functions-(Effect-Chains).md @@ -6,6 +6,8 @@ |--------|--------|------------------------------------------------------| |None | | | +Creates a new effect chain that can be modified and applied to sound instances (or the master buss). +   ## `~_EffectChain_Destroy(effectChainID)` @@ -14,7 +16,9 @@ |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 | |---------------|--------|------------------------------------------------------| -|`effectChainID`| | | +|`effectChainID`|number |Effect chain to target | + +Adds a pleasant-sounding default reverb to the effect chain.   @@ -34,7 +40,7 @@ |Argument |Datatype|Description | |------------------|--------|------------------------------------------------------| -|`effectChainID` |number | | +|`effectChainID` |number |Effect chain to target | |`wetDryMix` |number | | |`reflectionsDelay`|number | | |`reverbDelay` |number | | @@ -50,6 +56,7 @@ |`density` |number | | |`roomSize` |number | | +Adds a reverb effect with many (many...) parameters to the effect chain.   @@ -59,9 +66,11 @@ |Argument |Datatype|Description | |-----------------|--------|------------------------------------------------------| -|`soundInstanceID`|number | | -|`effectChainID` |number | | -|`effectGain` |number | | +|`soundInstanceID`|number |Sound instance to target | +|`effectChainID` |number |Effect chain to apply | +|`effectGain` |number |Gain of the effect. `1` is 100% volume | + +Applies an effect chain to the given sound instance.   @@ -69,10 +78,12 @@ **Returns:** N/A (`undefined`) -|Argument |Datatype|Description | -|-----------------|--------|------------------------------------------------------| -|`soundInstanceID`|number | | -|`effectGain` |number | | +|Argument |Datatype|Description | +|-----------------|--------|----------------------------------------------------------------------------| +|`soundInstanceID`|number |Sound instance to target | +|`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.   @@ -80,10 +91,12 @@ **Returns:** N/A (`undefined`) -|Argument |Datatype|Description | -|---------------|--------|------------------------------------------------------| -|`effectChainID`|number | | -|`effectGain` |number | | +|Argument |Datatype|Description | +|---------------|--------|--------------------------------------| +|`effectChainID`|number |Effect chain to apply | +|`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.   @@ -91,6 +104,8 @@ **Returns:** N/A (`undefined`) -|Argument |Datatype|Description | -|------------|--------|------------------------------------------------------| -|`effectGain`|number | | \ No newline at end of file +|Argument |Datatype|Description | +|------------|--------|-------------------------------------------------------------------------| +|`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. \ No newline at end of file