Skip to content

Commit e9016f4

Browse files
committed
update definitions
1 parent bab6efa commit e9016f4

12 files changed

+73
-53
lines changed

docs/API/renoise/renoise.Application.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@
2424
### installed_tools : table<[`string`](../../API/builtins/string.md), [`string`](../../API/builtins/string.md)><a name="installed_tools"></a>
2525
> **READ-ONLY** Returns information about all currently installed tools.
2626
27+
### installed_tools_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md)<a name="installed_tools_observable"></a>
28+
> Fired when the list of installed tools changed.
29+
30+
### audio_plugin_effects_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md)<a name="audio_plugin_effects_observable"></a>
31+
> Fired when the list of available audio plugin effects changed, for example
32+
> when scanning for new plugins in the preferences.
33+
> Use the component's `available_plugins` or `available_devices` properties
34+
> to access currently available devices which are supported by the component
35+
> such as the track device chains.
36+
37+
### audio_plugin_instruments_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md)<a name="audio_plugin_instruments_observable"></a>
38+
> Fired when the list of available audio plugin instruments changed, for example
39+
> when scanning for new plugins in the preferences.
40+
2741
### key_modifier_states : table<[`string`](../../API/builtins/string.md), [`string`](../../API/builtins/string.md)><a name="key_modifier_states"></a>
2842
> **Deprecated.** **READ-ONLY** Use `key_modifier_flags` instead
2943
@@ -63,12 +77,12 @@
6377
### show_custom_prompt([*self*](../../API/builtins/self.md), title : [`string`](../../API/builtins/string.md), content_view : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), button_labels : [`string`](../../API/builtins/string.md)[], key_handler : [`KeyHandler`](#KeyHandler)[`?`](../../API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](#keyhandleroptions)[`?`](../../API/builtins/nil.md), focus_handler : [`FocusHandler`](#FocusHandler)[`?`](../../API/builtins/nil.md))<a name="show_custom_prompt"></a>
6478
`->`label : [`string`](../../API/builtins/string.md)
6579
66-
> Opens a modal dialog with a title, custom content and custom button labels.
80+
> Opens a modal dialog with a title, custom content and custom button labels.
6781
> See: `renoise.ViewBuilder` for more info about custom views.
6882
### show_custom_dialog([*self*](../../API/builtins/self.md), title : [`DialogTitle`](#DialogTitle), content_view : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), key_handler : [`KeyHandler`](#KeyHandler)[`?`](../../API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](#keyhandleroptions)[`?`](../../API/builtins/nil.md), focus_handler : [`FocusHandler`](#FocusHandler)[`?`](../../API/builtins/nil.md))<a name="show_custom_dialog"></a>
6983
`->`[`renoise.Dialog`](../../API/renoise/renoise.Dialog.md)
7084
71-
> Shows a non modal dialog (a floating tool window) with custom content.
85+
> Shows a non modal dialog (a floating tool window) with custom content.
7286
> When no key_handler is provided, the Escape key is used to close the dialog.
7387
> See: `renoise.ViewBuilder` for more info about custom views.
7488
### show_menu([*self*](../../API/builtins/self.md), dialog : [`renoise.Dialog`](../../API/renoise/renoise.Dialog.md), menu_entries : [`DialogMenuEntry`](#dialogmenuentry)[], below_view : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[`?`](../../API/builtins/nil.md))<a name="show_menu"></a>
@@ -315,10 +329,10 @@
315329
> * Windows : "shift", "alt", "control", "winkey"
316330
> * Linux : "shift", "alt", "control", "meta"
317331
> * Mac : "shift", "option", "control", "command".
318-
> If multiple modifiers are held down, the string will be formatted as
332+
> If multiple modifiers are held down, the string will be formatted as
319333
> "<key> + <key>"
320334
> Their order will correspond to the following precedence
321-
> `shift + alt/option + control + winkey/meta/command`
335+
> `shift + alt/option + control + winkey/meta/command`
322336
> If no modifier is pressed, this will be an empty string.
323337
324338
@@ -347,13 +361,13 @@
347361
348362
### FocusHandler<a name="FocusHandler"></a>
349363
(dialogs : [`renoise.Dialog`](../../API/renoise/renoise.Dialog.md), focused : [`boolean`](../../API/builtins/boolean.md)) `->` [`KeyEvent`](#keyevent)[`?`](../../API/builtins/nil.md)
350-
> Optional focus change notifier for a custom dialog.
351-
> Will be called when the dialog gains of loses key focus. You maybe want to initialize
364+
> Optional focus change notifier for a custom dialog.
365+
> Will be called when the dialog gains of loses key focus. You maybe want to initialize
352366
> your dloag's (modifier) keyboard states here.
353367
354368
### KeyHandler<a name="KeyHandler"></a>
355369
(dialog : [`renoise.Dialog`](../../API/renoise/renoise.Dialog.md), key_event : [`KeyEvent`](#keyevent)) `->` [`KeyEvent`](#keyevent)[`?`](../../API/builtins/nil.md)
356-
> Optional keyhandler to process key events on a custom dialog.
370+
> Optional keyhandler to process key events on a custom dialog.
357371
> When returning the passed key from the key-handler function, the
358372
> key will be passed back to Renoise's key event chain, in order to allow
359373
> processing global Renoise key-bindings from your dialog. This will not work
@@ -376,10 +390,10 @@
376390
> * Windows : "shift", "alt", "control", "winkey"
377391
> * Linux : "shift", "alt", "control", "meta"
378392
> * Mac : "shift", "option", "control", "command".
379-
> If multiple modifiers are held down, the string will be formatted as
393+
> If multiple modifiers are held down, the string will be formatted as
380394
> "<key> + <key>"
381395
> Their order will correspond to the following precedence
382-
> `shift + alt/option + control + winkey/meta/command`
396+
> `shift + alt/option + control + winkey/meta/command`
383397
> If no modifier is pressed, this will be an empty string.
384398
385399

docs/API/renoise/renoise.ApplicationTheme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# renoise.ApplicationTheme<a name="renoise.ApplicationTheme"></a>
22
> Application's theme colors and other general color theme properties.
33
>
4-
> Note: All properties and functions of the app theme are **read-only**, so the
4+
> Note: All properties and functions of the app theme are **read-only**, so the
55
> theme can't be modified here. Use the app's `renoise.Application:load_theme`
66
> function to load and apply new themes instead.
77
>
@@ -14,11 +14,11 @@
1414
---
1515
## Properties
1616
### colors : { [ThemeColor]: RGBColor }<a name="colors"></a>
17-
> **READ-ONLY** Get all theme colors in a flat list of RGBColors.
17+
> **READ-ONLY** Get all theme colors in a flat list of RGBColors.
1818
> Color table keys are string identifiers as used in the theme XML file,
1919
> but in lower case.
2020
>
21-
> Note that if you only need to access a single color from the theme,
21+
> Note that if you only need to access a single color from the theme,
2222
> use `renoise.app().theme.color(color_name)` instead.
2323
>
2424
> To get notified of color changes, use `renoise.app().theme_observable`
@@ -58,11 +58,11 @@
5858
### color([*self*](../../API/builtins/self.md), color_name : [`ThemeColor`](#ThemeColor))<a name="color"></a>
5959
`->`[`RGBColor`](#RGBColor)
6060

61-
> Get a single color from the theme using a color identifier as used
61+
> Get a single color from the theme using a color identifier as used
6262
> in the theme XML file - but in lower case.
6363
>
64-
> e.g. to access the button background color from the theme, use
65-
> `renoise.app().theme.color("button_back")`
64+
> e.g. to access the button background color from the theme, use
65+
> `renoise.app().theme.color("button_back")`
6666
>
6767
> To get notified of color changes, use `renoise.app().theme_observable`
6868
>

docs/API/renoise/renoise.InstrumentPhrase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
> functions to it.
5454
5555
### script : [`renoise.InstrumentPhraseScript`](../../API/renoise/renoise.InstrumentPhraseScript.md)<a name="script"></a>
56-
> **READ-ONLY** Phrase script properties. Only used when `playback_mode` is
56+
> **READ-ONLY** Phrase script properties. Only used when `playback_mode` is
5757
> set to `renoise.InstrumentPhrase.PLAY_SCRIPT`
5858
5959
### is_empty : [`boolean`](../../API/builtins/boolean.md)<a name="is_empty"></a>

docs/API/renoise/renoise.InstrumentPhraseScript.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55

66
---
77
## Properties
8+
### editor_visible : [`boolean`](../../API/builtins/boolean.md)<a name="editor_visible"></a>
9+
> When false, a preview of the script is shown instead of a text editor.
10+
11+
### editor_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md)<a name="editor_visible_observable"></a>
12+
> fired, when the editor visibility changed.
13+
814
### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[]<a name="parameters"></a>
915
> **READ-ONLY** List of script input parameters, if any.
1016
@@ -40,7 +46,7 @@
4046
> functions to it.
4147
4248
### pending_changes : [`integer`](../../API/builtins/integer.md)<a name="pending_changes"></a>
43-
> **READ-ONLY** Number of changes since the last commit() or auto-commit call,
49+
> **READ-ONLY** Number of changes since the last commit() or auto-commit call,
4450
> that have been applied to the parapgraphs.
4551
> Note: `auto-commit` only is applied for scripts which are currently edited.
4652

docs/API/renoise/renoise.InstrumentTriggerOptions.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@
4141
> functions to it.
4242
4343
### tuning : [`number`](../../API/builtins/number.md)[]<a name="tuning"></a>
44-
> Array of custom pitch values relative to 1/1, used as custom tuning values for
45-
> instrument sample playback. The root key is assumed to be middle C (48 in Renoise),
46-
> The scale will be repeated, so only one octave of values should be defined. An
47-
> octave may contain more or less than 12 notes.
48-
>
44+
> Array of custom pitch values relative to 1/1, used as custom tuning values for
45+
> instrument sample playback. The root key is assumed to be middle C (48 in Renoise),
46+
> The scale will be repeated, so only one octave of values should be defined. An
47+
> octave may contain more or less than 12 notes.
48+
>
4949
> When set mts_esp_tuning is disabled. Set an empty table to disable custom tuning
5050
> using default 12-TET tuning instead.
5151
>
@@ -54,12 +54,12 @@
5454
> #### examples:
5555
> ```lua
5656
> -- Andreas Werckmeister's temperament III (the most famous one, 1681)
57-
> local well_tempered_tuning = {
58-
> 256/243, 1.117403, 32/27, 1.252827, 4/3, 1024/729,
57+
> local well_tempered_tuning = {
58+
> 256/243, 1.117403, 32/27, 1.252827, 4/3, 1024/729,
5959
> 1.494927, 128/81, 1.670436, 16/9, 1.879241, 2/1
6060
> }
6161
> instrument.tuning = well_tempered_tuning
62-
> ```
62+
> ```
6363
6464
### tuning_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md)<a name="tuning_observable"></a>
6565
> Track changes to document properties or general states by attaching listener

docs/API/renoise/renoise.PatternSequencer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
> Pattern order list: Notifiers will only be fired when sequence positions are
2626
> added, removed or their order changed. To get notified of pattern assignment
2727
> changes use the property `pattern_assignments_observable`.
28-
> Use `set_pattern` to change a single pattern in the sequence.
28+
> Use `set_pattern` to change a single pattern in the sequence.
2929
3030
### pattern_sequence_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md)<a name="pattern_sequence_observable"></a>
3131
> Track changes to document lists by attaching listener functions to it.

docs/API/renoise/renoise.SQLite.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -96,15 +96,15 @@
9696
> **READ-ONLY** The most recent error message.
9797
9898
### changes : [`integer`](../../API/builtins/integer.md)<a name="changes"></a>
99-
> **READ-ONLY** Number of database rows that were changed, inserted, or deleted by
100-
> the most recent SQL statement.
99+
> **READ-ONLY** Number of database rows that were changed, inserted, or deleted by
100+
> the most recent SQL statement.
101101
> Only changes that are directly specified by INSERT, UPDATE, or DELETE statements
102102
> are counted.
103103
> Auxiliary changes caused by triggers are not counted. Use `db.total_changes`
104104
> to find the total number of changes.
105105
106106
### total_changes : [`integer`](../../API/builtins/integer.md)<a name="total_changes"></a>
107-
> **READ-ONLY** The number of database rows that have been modified by INSERT,
107+
> **READ-ONLY** The number of database rows that have been modified by INSERT,
108108
> UPDATE or DELETE statements since the database was opened.
109109
> This includes UPDATE, INSERT and DELETE statements executed as part of
110110
> trigger programs. All changes are counted as soon as the statement that
@@ -201,7 +201,7 @@
201201
### interrupt([*self*](../../API/builtins/self.md))<a name="interrupt"></a>
202202
> Causes any pending database operation to abort and return at the next opportunity.
203203
### busy_handler([*self*](../../API/builtins/self.md), fun : (udata : [`any`](../../API/builtins/any.md), retries : [`integer`](../../API/builtins/integer.md)) `->` [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md), data : [`any`](../../API/builtins/any.md))<a name="busy_handler"></a>
204-
> Sets or removes a busy handler for a SQLiteDatabase.
204+
> Sets or removes a busy handler for a SQLiteDatabase.
205205
> `fun` is either a Lua function that implements the busy handler or `nil`
206206
> to remove a previously set handler. This function returns nothing.
207207
> The handler function is called with two parameters: `data` and the number
@@ -278,7 +278,7 @@
278278
> or 0 if the statement does not return data (for example an UPDATE).
279279
280280
### last_insert_rowid : [`integer`](../../API/builtins/integer.md)<a name="last_insert_rowid"></a>
281-
> **READ-ONLY** rowid of the most recent INSERT into the database corresponding
281+
> **READ-ONLY** rowid of the most recent INSERT into the database corresponding
282282
> to this statement.
283283
284284
### named_types : table<[`string`](../../API/builtins/string.md), [`string`](../../API/builtins/string.md)><a name="named_types"></a>
@@ -349,23 +349,23 @@
349349
350350
> Evaluates the (next iteration of the) prepared statement.
351351
> It will return one of the following values:
352-
> - `renoise.SQLite.Status.BUSY`: the engine was unable to acquire the locks needed.
353-
> If the statement is a COMMIT or occurs outside of an explicit transaction,
352+
> - `renoise.SQLite.Status.BUSY`: the engine was unable to acquire the locks needed.
353+
> If the statement is a COMMIT or occurs outside of an explicit transaction,
354354
> then you can retry the statement. If the statement is not a COMMIT and
355355
> occurs within a explicit transaction then you should rollback the transaction
356356
> before continuing.
357-
> - `renoise.SQLite.Status.DONE`: the statement has finished executing successfully.
357+
> - `renoise.SQLite.Status.DONE`: the statement has finished executing successfully.
358358
> `stmt:step()` should not be called again on this statement without first
359359
> calling `stmt:reset()` to reset the virtual machine back to the initial state.
360360
> - `renoise.SQLite.Status.ROW`: this is returned each time a new row of data is ready.
361-
> The values may be accessed using the column access functions.
361+
> The values may be accessed using the column access functions.
362362
> `stmt:step()` can be called again to retrieve the next row of data.
363363
> - `renoise.SQLite.Status.ERROR`: a run-time error (e.g. a constraint violation) occurred.
364364
> `stmt:step()` should not be called again. More information may be found by
365-
> calling `db:error_message()`. A more specific error code can be obtained by calling
365+
> calling `db:error_message()`. A more specific error code can be obtained by calling
366366
> `stmt:reset()`.
367367
> - `renoise.SQLite.Status.MISUSE`: the function was called inappropriately.
368-
> Perhaps because the statement has already been finalized or a previous call to
368+
> Perhaps because the statement has already been finalized or a previous call to
369369
> `stmt:step()` has returned `sqlite.ERROR` or `sqlite.DONE`.
370370
### bind_parameter_count([*self*](../../API/builtins/self.md))<a name="bind_parameter_count"></a>
371371
`->`[`integer`](../../API/builtins/integer.md)

docs/API/renoise/renoise.SampleBuffer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@
120120
> data for your changes and update sample overview caches!
121121
### prepare_sample_data_changes([*self*](../../API/builtins/self.md), undo_redo_enabled : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md))<a name="prepare_sample_data_changes"></a>
122122
> To be called once **before** sample data gets manipulated via `set_sample_data`.
123-
> This will prepare undo/redo data for the whole sample and does other internal
123+
> This will prepare undo/redo data for the whole sample and does other internal
124124
> housekeeping. Every *prepare_sample_data_changes* call must be paired with a
125125
> *finalize_sample_data_changes* call.
126126
>
@@ -134,7 +134,7 @@
134134
> This will create undo/redo data for the whole samples, and also updates the
135135
> sample view caches for the sample.
136136
> The reason this isn't automatically invoked is to avoid performance overhead when
137-
> changing sample data 'sample by sample'.
137+
> changing sample data 'sample by sample'.
138138
>
139139
> Don't forget to call this after any data changes, or changes may not be visible
140140
> in the GUI and can not be un/redone!

docs/API/renoise/renoise.SampleModulationSet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@
5959
> **READ-ONLY** List of available filter types depending on the filter_version.
6060
6161
### filter_type : [`FilterTypes`](#FilterTypes)<a name="filter_type"></a>
62-
> The type of the filter selected for the modulation set.
63-
> Songs made with previous versions of Renoise may use old filter types.
62+
> The type of the filter selected for the modulation set.
63+
> Songs made with previous versions of Renoise may use old filter types.
6464
6565
### filter_type_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md)<a name="filter_type_observable"></a>
6666
> Track changes to document properties or general states by attaching listener

0 commit comments

Comments
 (0)