Module xNoteColumn

This class is representing a single renoise.NoteColumn in xLib .

Unlike the renoise.NoteColumn, this one can be freely defined, without the need to have the line present somewhere in an actual song

You create an instance by feeding it a descriptive table in the constructor. All string-based values are automatically converted into their numeric counterparts.

Functions

__init (args) constructor
get_note_value () Get/set methods
note_string_to_value (str_val) Converter methods (static implementation)
instr_string_to_value (str)
delay_string_to_value (str)
delay_value_to_string (val)
column_string_to_value (str_val, empty) convert instr/vol/panning into a numeric value
column_value_to_string (val, empty) convert instr/vol/panning into a numeric value
convert_fx_to_value (str_val) convert two-character effect string into a numeric value
convert_fx_to_string (val) convert a numeric value into a two-character effect string
do_read (note_col) Read method (static implementation)
do_write (note_col, tokens, clear_undefined) Write methods

Fields

self.note_value note_value [number, 0-119, 120=Off, 121=Empty]
self.instrument_value instrument_value [number, 0-254, 255==Empty]
self.instrument_string instrument_string [string, '00'-'FE' or '..']
self.volume_value

volume_value [number, 0-127, 255==Empty when column value is <= 0x80 or is 0xFF,

i.e.
self.volume_string volume string [string, '00'-'ZF' or '..']
self.panning_value

panning_value [number, 0-127, 255==Empty when column value is <= 0x80 or is 0xFF,

i.e.
self.panning_string panning_string [string, '00'-'ZF' or '..']
self.delay_value delay_value [number, 0-255]
self.delay_string delay_string [string, '00'-'FF' or '..']


Functions

__init (args)
constructor

Parameters:

  • args (table), a xline descriptor - any of the properties below
get_note_value ()
Get/set methods
note_string_to_value (str_val)
Converter methods (static implementation) convert note_string into a numeric value

Parameters:

  • str_val (string), for example "C#4" or "---"

Returns:

  1. int (value, xNoteColumn.EMPTYNOTEVALUE when not matched)
  2. int (key) or nil
  3. int (octave) or nil
  4. int (0-255)
instr_string_to_value (str)

Parameters:

  • str (string), e.g. ".." or "1F"

Returns:

  1. int (0-255)
  2. int (0-255)
delay_string_to_value (str)

Parameters:

  • str (string), e.g. ".." or "1F"

Returns:

  1. int (0-255)
  2. string
delay_value_to_string (val)

Parameters:

  • val (int), between 0-255

Returns:

    string
column_string_to_value (str_val, empty)
convert instr/vol/panning into a numeric value

Parameters:

  • str_val (string), for example "40", "G5" or ".."
  • empty (int), the default empty value to return

Returns:

    int
column_value_to_string (val, empty)
convert instr/vol/panning into a numeric value

Parameters:

  • val (int), 0-127, 255==Empty or 0-65535 when value is > 0x80
  • empty (string), the default empty value to return

Returns:

    value
convert_fx_to_value (str_val)
convert two-character effect string into a numeric value

Parameters:

  • str_val (string), for example "G5"

Returns:

    value or nil
convert_fx_to_string (val)
convert a numeric value into a two-character effect string

Parameters:

  • val (int), for example 4615 ("I7") or 0x80

Returns:

    string
do_read (note_col)
Read method (static implementation)

Parameters:

  • note_col (renoise.NoteColumn)

Returns:

    table
do_write (note_col, tokens, clear_undefined)
Write methods

Parameters:

  • note_col (renoise.NoteColumn),
  • tokens (table)
  • clear_undefined (bool) clear existing data when ours is nil

Fields

self.note_value
note_value [number, 0-119, 120=Off, 121=Empty]
self.instrument_value
instrument_value [number, 0-254, 255==Empty]
self.instrument_string
instrument_string [string, '00'-'FE' or '..']
self.volume_value

volume_value [number, 0-127, 255==Empty when column value is <= 0x80 or is 0xFF,

i.e.  is used to specify volume]

[number, 0-65535 in the form 0x0000xxyy where

xx=effect char 1 and yy=effect char 2,
when column value is > 0x80, i.e. is used to specify an effect]
self.volume_string
volume string [string, '00'-'ZF' or '..']
self.panning_value

panning_value [number, 0-127, 255==Empty when column value is <= 0x80 or is 0xFF,

i.e.  is used to specify pan]

[number, 0-65535 in the form 0x0000xxyy where

xx=effect char 1 and yy=effect char 2,
when column value is > 0x80, i.e. is used to specify an effect]
self.panning_string
panning_string [string, '00'-'ZF' or '..']
self.delay_value
delay_value [number, 0-255]
self.delay_string
delay_string [string, '00'-'FF' or '..']
generated by LDoc 1.4.2