Module xBlockLoop

Static methods for working with the renoise loop_block .

Functions

get () retrieve 'expanded' block loop info (resolving the end point)
get_block_lines (seq_idx) retrive number of lines in a block for a given pattern
get_start () return start line of the block loop
get_end () calculates end line of the block loop
within (seq_idx, line_idx, end_pos) determine if position is within block loop
exiting (seq_idx, line_idx, line_delta, end_pos) check if we are heading out of a blockloop

Fields

self.writeahead int
self.start_line int
self.end_line int
self.length int, read-only


Functions

get ()
retrieve 'expanded' block loop info (resolving the end point)

Returns:

    table or nil sequence startline endline [[
get_block_lines (seq_idx)
retrive number of lines in a block for a given pattern

Parameters:

  • seq_idx TRACE("xBlockLoop.getblocklines(seqidx)",seqidx)
get_start ()
return start line of the block loop

Returns:

    int, line index or nil
get_end ()
calculates end line of the block loop

Returns:

    int, line index or nil
within (seq_idx, line_idx, end_pos)
determine if position is within block loop

Parameters:

  • seq_idx (int)
  • line_idx (int) line to check
  • end_pos (int) optional, avoids having to calculate this

Returns:

    bool
exiting (seq_idx, line_idx, line_delta, end_pos)
check if we are heading out of a blockloop

Parameters:

  • seq_idx (int)
  • line_idx (int)
  • line_delta (int), #lines to add/subtract, negative when decreasing
  • end_pos (int) optional, avoids having to calculate this

Returns:

    line (int)

Fields

self.writeahead
int
self.start_line
int
self.end_line
int
self.length
int, read-only
generated by LDoc 1.4.2