Module xEffectColumn
A virtual representation of renoise.EffectColumn.
Unlike the renoise.EffectColumn, this one can be freely defined, without the need to have the line present somewhere in the actual song.
You can create an instance by feeding it a descriptive table in the constructor, or by letting
the class read a specific effect-column (via the method do_read())
Note that all string-based values are automatically converted into numbers, and vice versa.
Setting the note_string and then requesting the note_value will yield the same value,
represented as string or number, respectively.
Functions
| __init (args) | [Constructor] accepts a single argument for initializing the class |
| do_write (fx_col, tokens, clear_undefined) | [Class] Write output to the provided effect-column |
| do_write_number_value (fx_col, clear_undefined) | [Class] Define a function for each possible token (see above) |
| number_value_to_string (val) | [Static] Convert number value to string |
| amount_value_to_string (val) | [Static] Convert amount value to string |
| do_read (fx_col) | [Static] Read from pattern and turn into descriptor |
Tables
| tokens | List of effect-column properties |
| output_tokens | Properties to use when writing to pattern |
| SUPPORTED_EFFECTS | List of supported effect commands. |
| TYPE | The possible column types |
Fields
| self.number_string | string, '00'-'FF' or '..' |
| self.amount_value | number, 0-255 |
| self.amount_string | string, '00'-'FF' or '..' |
Functions
- __init (args)
-
[Constructor] accepts a single argument for initializing the class
Parameters:
- args (table), descriptor
- do_write (fx_col, tokens, clear_undefined)
-
[Class] Write output to the provided effect-column
Parameters:
- fx_col (renoise.EffectColumn)
- tokens
(table
) - clear_undefined (bool)
- do_write_number_value (fx_col, clear_undefined)
-
[Class] Define a function for each possible token (see above)
Parameters:
- fx_col TRACE("xEffectColumn
- clear_undefined dowritenumbervalue(fxcol,clearundefined)",fxcol,clear_undefined)
- number_value_to_string (val)
-
[Static] Convert number value to string
Parameters:
- val (number)
Returns:
-
string
- amount_value_to_string (val)
-
[Static] Convert amount value to string
Parameters:
- val (number)
Returns:
-
string
- do_read (fx_col)
-
[Static] Read from pattern and turn into descriptor
Parameters:
- fx_col (renoise.EffectColumn)
Returns:
-
table
Tables
- tokens
-
List of effect-column properties
Fields:
- number_value
- number_string
- amount_value
- amount_string
- output_tokens
-
Properties to use when writing to pattern
Fields:
- number_value
- amount_value
- SUPPORTED_EFFECTS
-
List of supported effect commands.
Values are represented in the accompanying table,xEffectColumn.SUPPORTEDEFFECTCHARSFields:
- Axy - Arpeggio
SUPPORTEDEFFECTCHARS= 10 - Bxx - Backwards
SUPPORTEDEFFECTCHARS= 11 - Cxy - Cut Volume
SUPPORTEDEFFECTCHARS= 12 - Dxx - Slide Pitch Down
SUPPORTEDEFFECTCHARS= 13 - Exx - Set Envelope Pos
SUPPORTEDEFFECTCHARS= 14 - Gxx - Glide Note
SUPPORTEDEFFECTCHARS= 16 - Ixx - Fade Volume In
SUPPORTEDEFFECTCHARS= 18 - Jxx - Track Routing
SUPPORTEDEFFECTCHARS= 19 - Lxx - Set Track Level
SUPPORTEDEFFECTCHARS= 21 - Mxx - Set Note Volume
SUPPORTEDEFFECTCHARS= 22 - Nxy - Set Auto Pan
SUPPORTEDEFFECTCHARS= 23 - Pxx - Set Track Pan
SUPPORTEDEFFECTCHARS= 25 - Qxx - Delay By Ticks
SUPPORTEDEFFECTCHARS= 26 - Rxy - Retrigger Line
SUPPORTEDEFFECTCHARS= 27 - Sxx - Trigger Offset/Slice
SUPPORTEDEFFECTCHARS= 28 - Txy - Set Tremolo
SUPPORTEDEFFECTCHARS= 29 - Uxy - Slide Pitch Up
SUPPORTEDEFFECTCHARS= 30 - Vxy - Set Vibrato
SUPPORTEDEFFECTCHARS= 31 - Wxx - Set Track Width
SUPPORTEDEFFECTCHARS= 32 - Xxx - Stop All Notes
SUPPORTEDEFFECTCHARS= 33 - Yxx - MaYbe Trigger Line
SUPPORTEDEFFECTCHARS= 34 - Zxy - Trigger Phrase
SUPPORTEDEFFECTCHARS= 35 (API5 ONLY)
- Axy - Arpeggio
- TYPE
-
The possible column types
Fields:
- EFFECT_COLUMN two-digit command in effect column
- EFFECT_SUBCOLUMN single-digit command in effect sub-column
- EFFECT_NOTECOLUMN two-digit command in note-effect column