Module xLinePattern

This class represents a 'virtual' renoise.PatternLine .

Create instances as needed, through the constructor method

Functions

__init (note_columns, effect_columns) constructor
apply_descriptor (note_columns, effect_columns) convert descriptors into class instances (empty tables are left as-is)
do_write (sequence, line, track_idx, phrase, tokens, include_hidden, expand_columns, clear_undefined) combined method for writing to pattern or phrase
process_columns (rns_columns, rns_track_or_phrase, xline_columns, include_hidden, expand_columns, visible_cols, tokens, clear_undefined, col_type) write to either note or effect column
do_read (rns_line, max_note_cols, max_fx_cols)

Fields

self.note_columns table
self.effect_columns table


Functions

__init (note_columns, effect_columns)
constructor

Parameters:

  • note_columns (table)
  • effect_columns (table)
apply_descriptor (note_columns, effect_columns)
convert descriptors into class instances (empty tables are left as-is)

Parameters:

  • note_columns (xNoteColumn or table)
  • effect_columns (xEffectColumn or table)
do_write (sequence, line, track_idx, phrase, tokens, include_hidden, expand_columns, clear_undefined)
combined method for writing to pattern or phrase

Parameters:

  • sequence (int)
  • line (int)
  • track_idx (int), when writing to pattern
  • phrase (renoise.InstrumentPhrase), when writing to phrase
  • tokens (table) process these tokens ("note_value", etc)
  • include_hidden (bool) apply to hidden columns as well
  • expand_columns (bool) reveal columns as they are written to
  • clear_undefined (bool) clear existing data when ours is nil
process_columns (rns_columns, rns_track_or_phrase, xline_columns, include_hidden, expand_columns, visible_cols, tokens, clear_undefined, col_type)
write to either note or effect column

Parameters:

  • rns_columns (array)
  • rns_track_or_phrase (renoise.Track or renoise.InstrumentPhrase)
  • xline_columns (table)
  • include_hidden (bool) apply to hidden columns as well
  • expand_columns (bool) reveal columns as they are written to
  • visible_cols (int) number of visible note/effect columns
  • tokens (table) process these tokens ("note_value", etc)
  • clear_undefined (bool) clear existing data when ours is nil
  • col_type (xLinePattern.COLUMN_TYPES)

Returns:

  1. table, note columns
  2. table, effect columns
do_read (rns_line, max_note_cols, max_fx_cols)

Parameters:

  • rns_line (renoise.PatternLine)
  • max_note_cols (int)
  • max_fx_cols (int)

Returns:

  1. table, note columns
  2. table, effect columns

Fields

self.note_columns
table
self.effect_columns
table
generated by LDoc 1.4.2