Module xLine
Represents a single line, including note/effect-columns and automation.
The class uses xLinePattern for notes and effect-columns, and xLineAutomation to represent the automation within that line.
See also: xLinePattern xLineAutomation
Functions
| __init (args) | [Constructor] accepts a single argument to use as class initializer |
| do_write (sequence, line, track_idx, phrase, ptrack_auto, patt_num_lines, tokens, include_hidden, expand_columns, clear_undefined) | [Class] Write to pattern/phrase/automation - all defined types of data |
| clear_pattern_line (sequence, line, track_idx, phrase) | [Class] clear the renoise.PatternLine TODO refactor to xLinePattern |
| get_column (line, col_idx, track, visible_only) | [Static] Resolve a column (note or effect), optionally a similar approach to that used by "selectioninpattern" - meaning that, if a given line contains two visible note columns and some effect columns then "col_idx=3" will indicate the first effect column |
| do_read (sequence, line, include_hidden, track_idx, phrase) | [Static] Read from song, return a descriptive table |
| resolve_pattern_line (sequence, line, track_idx) | [Static] Resolvepatternline: MUST be valid |
| resolve_phrase_line (line, phrase) | [Static] Resolvephraseline: MUST be valid |
| apply_descriptor (xline) | [Static] Convert descriptors into class instances (empty tables are left as-is) |
Tables
| EMPTY_NOTE_COLUMNS | table, containing 12 empty tables |
| EMPTY_EFFECT_COLUMNS | table, containing 8 empty tables |
| EMPTY_XLINE |
table, containing the following |
Fields
| self.automation | xLineAutomation |
Functions
- __init (args)
-
[Constructor] accepts a single argument to use as class initializer
Parameters:
- args (table or xLine)
- do_write (sequence, line, track_idx, phrase, ptrack_auto, patt_num_lines, tokens, include_hidden, expand_columns, clear_undefined)
-
[Class] Write to pattern/phrase/automation - all defined types of data
Parameters:
- sequence (int)
- line (int)
- track_idx (int)
- phrase (renoise.InstrumentPhrase)
- ptrack_auto (renoise.PatternTrackAutomation)
- patt_num_lines (int), length of the playpos pattern
- tokens
(table
) - include_hidden (bool)
- expand_columns (bool)
- clear_undefined (bool)
- clear_pattern_line (sequence, line, track_idx, phrase)
-
[Class] clear the renoise.PatternLine
TODO refactor to xLinePattern
Parameters:
- sequence (int)
- line (int)
- track_idx (int), when writing to pattern
- phrase (renoise.InstrumentPhrase)
- get_column (line, col_idx, track, visible_only)
-
[Static] Resolve a column (note or effect), optionally a similar approach to that
used by "selectioninpattern" - meaning that, if a given line contains
two visible note columns and some effect columns then "col_idx=3" will
indicate the first effect column
Parameters:
- line (renoise.PatternLine)
- col_idx (number)
- track (renoise.Track)
- visible_only (boolean), default is true
Returns:
-
renoise.NoteColumn/renoise.EffectColumn or nil
- do_read (sequence, line, include_hidden, track_idx, phrase)
-
[Static] Read from song, return a descriptive table
Parameters:
- sequence (int)
- line (int)
- include_hidden (bool),
- track_idx (int), when reading from pattern
- phrase (renoise.InstrumentPhrase) TODO @param deviceindex (int), include automation TODO @param paramindex (int), include automation
Returns:
-
table
- resolve_pattern_line (sequence, line, track_idx)
-
[Static] Resolvepatternline: MUST be valid
Parameters:
- sequence (int)
- line (int)
- track_idx (int)
Returns:
- rns_line (renoise.PatternLine)
- patt_idx (int),
- rns_patt (renoise.Pattern)
- rns_track (renoise.Track)
- rns_ptrack (renoise.PatternTrack)
- resolve_phrase_line (line, phrase)
-
[Static] Resolvephraseline: MUST be valid
Parameters:
- line (int)
- phrase (renoise.Phrase)
Returns:
-
rns_line (renoise.PatternLine)
- apply_descriptor (xline)
-
[Static] Convert descriptors into class instances (empty tables are left as-is)
Parameters:
- xline (xLine or table) will create xLine instance if table
Returns:
-
xLine
Tables
- EMPTY_NOTE_COLUMNS
-
table, containing 12 empty tables
Fields:
- {
- EMPTY_EFFECT_COLUMNS
-
table, containing 8 empty tables
Fields:
- {
- EMPTY_XLINE
-
table, containing the following
{ note_columns = xLine.EMPTY_NOTE_COLUMNS, effect_columns = xLine.EMPTY_EFFECT_COLUMNS, }Fields:
- note_columns
- effect_columns