renoise.PatternIterator

Lua pairs/ipairs alike iterator functions to walk through all lines or columns in the entire song, track or a single pattern.

General remarks: Iterators can only be use in "for" loops like you would use "pairs" in Lua.

examples:

for pos,line in renoise.song().pattern_iterator:lines_in_song() do [...] end

The returned pos is a table with "pattern", "track", "line" fields, and an additional "column" field for the note/effect columns.

The visible_only flag controls if all content should be traversed, or only the currently used patterns, columns, and so on. Patterns are traversed in the order they are referenced in the pattern sequence, but each pattern is accessed only once.

Functions

lines_in_song(self, visible_only : boolean?)

->(context : unknown) -> PatternLinePosition, renoise.PatternLine, line : renoise.PatternLine, pos : PatternLinePosition

Iterate over all pattern lines in the song.

note_columns_in_song(self, visible_only : boolean?)

->(context : unknown) -> PatternColumnPosition, renoise.NoteColumn, column : renoise.NoteColumn, pos : PatternColumnPosition

Iterate over all note columns in the song.

effect_columns_in_song(self, visible_only : boolean?)

->(context : unknown) -> PatternColumnPosition, renoise.EffectColumn, column : renoise.EffectColumn, pos : PatternColumnPosition

Iterate over all effect columns in the song.

lines_in_pattern(self, pattern_index : integer)

->(context : unknown) -> PatternLinePosition, renoise.PatternLine, line : renoise.PatternLine, pos : PatternLinePosition

Iterate over all lines in the given pattern only.

note_columns_in_pattern(self, pattern_index : integer, visible_only : boolean?)

->(context : unknown) -> PatternColumnPosition, renoise.NoteColumn, column : renoise.NoteColumn, pos : PatternColumnPosition

Iterate over all note columns in the specified pattern.

effect_columns_in_pattern(self, pattern_index : integer, visible_only : boolean?)

->(context : unknown) -> PatternColumnPosition, renoise.EffectColumn, column : renoise.EffectColumn, pos : PatternColumnPosition

Iterate over all note columns in the specified pattern.

lines_in_track(self, track_index : integer, visible_only : boolean?)

->(context : unknown) -> PatternLinePosition, renoise.PatternLine, line : renoise.PatternLine, pos : PatternLinePosition

Iterate over all lines in the given track only.

note_columns_in_track(self, track_index : integer, visible_only : boolean?)

->(context : unknown) -> PatternColumnPosition, renoise.NoteColumn, column : renoise.NoteColumn, pos : PatternColumnPosition

Iterate over all note/effect columns in the specified track.

effect_columns_in_track(self, track_index : integer, visible_only : boolean?)

->(context : unknown) -> PatternColumnPosition, renoise.EffectColumn, column : renoise.EffectColumn, pos : PatternColumnPosition

lines_in_pattern_track(self, pattern_index : integer, track_index : integer)

->(context : unknown) -> PatternLinePosition, renoise.PatternLine, line : renoise.PatternLine, pos : PatternLinePosition

Iterate over all lines in the given pattern, track only.

note_columns_in_pattern_track(self, pattern_index : integer, track_index : integer, visible_only : boolean?)

->(context : unknown) -> PatternColumnPosition, renoise.NoteColumn, column : renoise.NoteColumn, pos : PatternColumnPosition

Iterate over all note/effect columns in the specified pattern track.

effect_columns_in_pattern_track(self, pattern_index : integer, track_index : integer, visible_only : boolean?)

->(context : unknown) -> PatternColumnPosition, renoise.EffectColumn, column : renoise.EffectColumn, pos : PatternColumnPosition

Local Structs

PatternColumnPosition

Note/Effect column iterator position.

Properties

pattern : integer

track : integer

line : integer

column : integer

PatternLinePosition

Line iterator position.

Properties

pattern : integer

track : integer

line : integer