renoise.InstrumentPhraseScript InstrumentPhraseScript

• Properties
  • editor_visible : boolean
  • editor_visible_observable : renoise.Document.Observable
  • parameters : renoise.DeviceParameter[]
  • parameters_observable : renoise.Document.ObservableList
  • paragraphs : string[]
  • paragraphs_observable : renoise.Document.DocumentList
  • paragraphs_assignment_observable : renoise.Document.Observable
  • compile_error : string
  • compile_error_observable : renoise.Document.Observable
  • runtime_error : string
  • runtime_error_observable : renoise.Document.Observable
  • pending_changes : integer
  • pending_changes_observable : renoise.Document.Observable
  • committed_observable : renoise.Document.Observable
• Functions
  • parameter (self, integer) -> renoise.DeviceParameter
  • commit (self)
  • render_to_pattern (self, RenderScriptOptions, RenderingDoneCallback)
  • render_to_clipboard (self, RenderScriptOptions, RenderingDoneCallback)
• Structs
  • RenderScriptOptions
    • Properties
      • lpb : number?
      • max_events : number?
• Aliases
  • RenderingDoneCallback

Properties

editor_visible : boolean

When false, a preview of the script is shown instead of a text editor.

editor_visible_observable : renoise.Document.Observable

fired, when the editor visibility changed. READ-ONLY

parameters : renoise.DeviceParameter[]

List of script input parameters, if any. READ-ONLY

parameters_observable : renoise.Document.ObservableList

fired, when the input parameter set changed. READ-ONLY

paragraphs : string[]

Script content. When changing paragraphs, changes are visible in the script editor, but are not applied for playback until they get committed. See also @function commit and @field committed_observable.

paragraphs_observable : renoise.Document.DocumentList

Notifier which is called when a paragraph got added or removed.

paragraphs_assignment_observable : renoise.Document.Observable

Notifier which is called when existing paragraph content changed.

compile_error : string

When not empty, the script failed to compile. This error text is also visible to the user in the script preview. READ-ONLY

compile_error_observable : renoise.Document.Observable

READ-ONLY

runtime_error : string

When not empty, script compiled successfully, but caused an error while running. This error text is also visible to the user in the script editor. READ-ONLY

runtime_error_observable : renoise.Document.Observable

READ-ONLY

pending_changes : integer

Number of changes since the last commit() or auto-commit call, that have been applied to the parapgraphs. Note: auto-commit only is applied for scripts which are currently edited. READ-ONLY

pending_changes_observable : renoise.Document.Observable

READ-ONLY

committed_observable : renoise.Document.Observable

Fired when script paragraph changes got committed: Either by an explicit commit call or via auto-commit in the editor when the script currently is edited. Script compile errors will be set or cleared after the observable fires as the commit & compilation happens asynchroniously in the player engine. READ-ONLY

Functions

parameter(self, index : integer)

->renoise.DeviceParameter

Access to a single input parameter by index. Use properties ‘parameters’ to iterate over all parameters and to query the parameter count.

commit(self)

Commit paragraph changes for playback.

render_to_pattern(self, options : RenderScriptOptions, rendering_done_callback : RenderingDoneCallback)

Render script content with the given options to the phrase pattern. Only committed content will be rendered, so make sure to commit changes first. Parameter rendering_done_callback is called with the results:

• error: nil when the rendering succeeded, otherwise a string describing the error
• rendered_events: number of successfully rendered raw events (not pattern lines) or 0
• skipped_events: number of skipped raw events, in case the pattern couldn’t fit all events, or 0

render_to_clipboard(self, options : RenderScriptOptions, rendering_done_callback : RenderingDoneCallback)

Same as render_to_pattern, but rendering into a temporary phrase object in the clipboard, which can then be pasted by the user somewhere.

Structs

RenderScriptOptions

Options for the render functions. All undefined properties will fall back to the user preferences values from the script preview

Properties

lpb : number?

Lines per beat of the target phrase.

max_events : number?

Maximum events (not pattern lines) that will be rendered

Aliases

RenderingDoneCallback

(error : string?, rendered_events : integer, skipped_events : integer)