A scripting objects that wraps an existing Modulator. More...
Inheritance diagram for ScriptingObjects::ScriptingModulator:
Public Member Functions | |
| var | addGlobalModulator (var chainIndex, var globalMod, String modName) |
| Adds a and connects a receiver modulator for the given global modulator. More... | |
| var | addModulator (var chainIndex, var typeName, var modName) |
| Adds a modulator to the given chain and returns a reference. More... | |
| var | addStaticGlobalModulator (var chainIndex, var timeVariantMod, String modName) |
| Adds and connects a receiving static time variant modulator for the given global modulator. More... | |
| var | asTableProcessor () |
| Returns a reference as table processor to modify the table or undefined if no table modulator. More... | |
| bool | exists () |
| Checks if the Object exists and prints a error message on the console if not. More... | |
| String | exportScriptControls () |
| Export the control values (without the script). More... | |
| String | exportState () |
| Exports the state as base64 string. More... | |
| float | getAttribute (int index) |
| Returns the attribute with the given index. More... | |
| float | getCurrentLevel () |
| Returns the current peak value of the modulator. More... | |
| String | getId () const |
| Returns the ID of the modulator. More... | |
| float | getIntensity () const |
| Returns the intensity of the Modulator. More... | |
| var | getModulatorChain (var chainIndex) |
| Returns the Modulator chain with the given index. More... | |
| int | getNumAttributes () const |
| Returns the number of attributes. More... | |
| bool | isBypassed () const |
| Checks if the modulator is bypassed. More... | |
| void | restoreScriptControls (String base64Controls) |
| Restores the control values for scripts (without recompiling). More... | |
| void | restoreState (String base64State) |
| Restores the state from a base64 string. More... | |
| void | setAttribute (int index, float value) |
| Sets the attribute of the Modulator. More... | |
| void | setBypassed (bool shouldBeBypassed) |
| Bypasses the Modulator. More... | |
| void | setIntensity (float newIntensity) |
| Changes the Intensity of the Modulator. More... | |
Detailed Description
A scripting objects that wraps an existing Modulator.
Member Function Documentation
| var addGlobalModulator | ( | var | chainIndex, |
| var | globalMod, | ||
| String | modName | ||
| ) |
Adds a and connects a receiver modulator for the given global modulator.
| var addModulator | ( | var | chainIndex, |
| var | typeName, | ||
| var | modName | ||
| ) |
Adds a modulator to the given chain and returns a reference.
| var addStaticGlobalModulator | ( | var | chainIndex, |
| var | timeVariantMod, | ||
| String | modName | ||
| ) |
Adds and connects a receiving static time variant modulator for the given global modulator.
| var asTableProcessor | ( | ) |
Returns a reference as table processor to modify the table or undefined if no table modulator.
|
inline |
Checks if the Object exists and prints a error message on the console if not.
| String exportScriptControls | ( | ) |
Export the control values (without the script).
| String exportState | ( | ) |
Exports the state as base64 string.
| float getAttribute | ( | int | index | ) |
Returns the attribute with the given index.
| float getCurrentLevel | ( | ) |
Returns the current peak value of the modulator.
| String getId | ( | ) | const |
Returns the ID of the modulator.
| float getIntensity | ( | ) | const |
Returns the intensity of the Modulator.
Ranges: Gain: 0...1, Pitch: -12...12.
| var getModulatorChain | ( | var | chainIndex | ) |
Returns the Modulator chain with the given index.
| int getNumAttributes | ( | ) | const |
Returns the number of attributes.
| bool isBypassed | ( | ) | const |
Checks if the modulator is bypassed.
| void restoreScriptControls | ( | String | base64Controls | ) |
Restores the control values for scripts (without recompiling).
| void restoreState | ( | String | base64State | ) |
Restores the state from a base64 string.
| void setAttribute | ( | int | index, |
| float | value | ||
| ) |
Sets the attribute of the Modulator.
You can look up the specific parameter indexes in the manual.
| void setBypassed | ( | bool | shouldBeBypassed | ) |
Bypasses the Modulator.
| void setIntensity | ( | float | newIntensity | ) |
Changes the Intensity of the Modulator.
Ranges: Gain Mode 0 ... 1, PitchMode -12 ... 12.