Module xPatternPos
Static methods for manipulating the position within a renoise.Pattern .
Note: all xPatternPos methods operate on actual selected objects (pattern, line). This is different from xSongPos, where you can pass an imaginary position around.
Changelog
0.51 - renamed to xPatternPos - clarifies the purpose
Functions
| restrict_line_index (line_idx) | [Static] restrict to pattern (will only affect the line) |
| jump_to_line (line_idx) | [Static] 'Safely' move cursor to specific position in pattern |
| jump_to_previous_line () | [Static] Jump to previous line - see xPatternPos.getpreviousline() |
| jump_to_next_line () | [Static] Jump to previous line - see xPatternPos.getpreviousline() |
| jump_to_last_line () | [Static] Jump to last line |
| jump_to_next_page () | [Static] Jump to next page (page-down by 16 lines) |
| jump_to_previous_page () | [Static] Jump to previous page (page-up by 16 lines) |
| jump_to_first_quarter_row () | [Static] Move edit cursor to first quarter of the pattern (same as pressing F9 in the pattern editor) |
| jump_to_second_quarter_row () | [Static] Move edit cursor to second quarter of the pattern (same as pressing F10 in the pattern editor) |
| jump_to_third_quarter_row () | [Static] Move edit cursor to third quarter of the pattern (same as pressing F11 in the pattern editor) |
| jump_to_fourth_quarter_row () | [Static] Move edit cursor to fourth quarter of the pattern (same as pressing F12 in the pattern editor) |
| get_previous_line () | [Static] Return position of previous line, taking the Renoise 'wrap-around' property into consideration (essentially, same as pressing "arrow up" in the pattern editor) |
| get_next_line () | [Static] Return position of next line, taking the Renoise 'wrap-around' property into consideration (essentially, same as pressing "arrow down" in the pattern editor) |
Functions
- restrict_line_index (line_idx)
-
[Static] restrict to pattern (will only affect the line)
Parameters:
- line_idx , number
Returns:
-
int or nil, [string, error message]
- jump_to_line (line_idx)
-
[Static] 'Safely' move cursor to specific position in pattern
Parameters:
- line_idx
- jump_to_previous_line ()
- [Static] Jump to previous line - see xPatternPos.getpreviousline()
- jump_to_next_line ()
- [Static] Jump to previous line - see xPatternPos.getpreviousline()
- jump_to_last_line ()
- [Static] Jump to last line
- jump_to_next_page ()
- [Static] Jump to next page (page-down by 16 lines)
- jump_to_previous_page ()
- [Static] Jump to previous page (page-up by 16 lines)
- jump_to_first_quarter_row ()
- [Static] Move edit cursor to first quarter of the pattern (same as pressing F9 in the pattern editor)
- jump_to_second_quarter_row ()
- [Static] Move edit cursor to second quarter of the pattern (same as pressing F10 in the pattern editor)
- jump_to_third_quarter_row ()
- [Static] Move edit cursor to third quarter of the pattern (same as pressing F11 in the pattern editor)
- jump_to_fourth_quarter_row ()
- [Static] Move edit cursor to fourth quarter of the pattern (same as pressing F12 in the pattern editor)
- get_previous_line ()
-
[Static] Return position of previous line, taking the Renoise 'wrap-around' property
into consideration (essentially, same as pressing "arrow up" in the pattern editor)
Returns:
-
renoise.SongPos
- get_next_line ()
-
[Static] Return position of next line, taking the Renoise 'wrap-around' property
into consideration (essentially, same as pressing "arrow down" in the pattern editor)
Returns:
-
renoise.SongPos