update bundled API docs

renoise · Jul 31, 2024 · c2cfd4e · c2cfd4e
1 parent 570873e
commit c2cfd4e
Show file tree

Hide file tree

Showing 17 changed files with 1,989 additions and 341 deletions.
diff --git a/docs/API/modules/global.md b/docs/API/modules/global.md
@@ -2,9 +2,6 @@
 
 ---  
 ## Functions
-### `OnSetText`(uri : [`any`](/API/builtins/any.md), text : [`any`](/API/builtins/any.md)) {#OnSetText}
-`->`[`table`](/API/builtins/table.md) | [`nil`](/API/builtins/nil.md)  
-
 ### `class`(name : [`string`](/API/builtins/string.md)) {#class}
 `->`[`function`](/API/builtins/function.md)  
 

diff --git a/docs/API/renoise.md b/docs/API/renoise.md
diff --git a/docs/API/renoise/renoise.ApplicationWindow.md b/docs/API/renoise/renoise.ApplicationWindow.md
@@ -1,11 +1,18 @@
 # renoise.ApplicationWindow  
 Application window and general UI properties of the Renoise app.  
 ## Constants
-### LowerFrame {#LowerFrame}
+### MiddleFrame {#MiddleFrame}
 ```lua
 {
-    LOWER_FRAME_TRACK_DSPS: integer = 1,
-    LOWER_FRAME_TRACK_AUTOMATION: integer = 2,
+    MIDDLE_FRAME_PATTERN_EDITOR: integer = 1,
+    MIDDLE_FRAME_MIXER: integer = 2,
+    MIDDLE_FRAME_INSTRUMENT_PHRASE_EDITOR: integer = 3,
+    MIDDLE_FRAME_INSTRUMENT_SAMPLE_KEYZONES: integer = 4,
+    MIDDLE_FRAME_INSTRUMENT_SAMPLE_EDITOR: integer = 5,
+    MIDDLE_FRAME_INSTRUMENT_SAMPLE_MODULATION: integer = 6,
+    MIDDLE_FRAME_INSTRUMENT_SAMPLE_EFFECTS: integer = 7,
+    MIDDLE_FRAME_INSTRUMENT_PLUGIN_EDITOR: integer = 8,
+    MIDDLE_FRAME_INSTRUMENT_MIDI_EDITOR: integer = 9,
 }
 ```
 ### UpperFrame {#UpperFrame}
@@ -24,18 +31,11 @@ Application window and general UI properties of the Renoise app.
     MIXER_FADER_TYPE_LINEAR: integer = 4,
 }
 ```
-### MiddleFrame {#MiddleFrame}
+### LowerFrame {#LowerFrame}
 ```lua
 {
-    MIDDLE_FRAME_PATTERN_EDITOR: integer = 1,
-    MIDDLE_FRAME_MIXER: integer = 2,
-    MIDDLE_FRAME_INSTRUMENT_PHRASE_EDITOR: integer = 3,
-    MIDDLE_FRAME_INSTRUMENT_SAMPLE_KEYZONES: integer = 4,
-    MIDDLE_FRAME_INSTRUMENT_SAMPLE_EDITOR: integer = 5,
-    MIDDLE_FRAME_INSTRUMENT_SAMPLE_MODULATION: integer = 6,
-    MIDDLE_FRAME_INSTRUMENT_SAMPLE_EFFECTS: integer = 7,
-    MIDDLE_FRAME_INSTRUMENT_PLUGIN_EDITOR: integer = 8,
-    MIDDLE_FRAME_INSTRUMENT_MIDI_EDITOR: integer = 9,
+    LOWER_FRAME_TRACK_DSPS: integer = 1,
+    LOWER_FRAME_TRACK_AUTOMATION: integer = 2,
 }
 ```
 

diff --git a/docs/API/renoise/renoise.Document.DocumentList.md b/docs/API/renoise/renoise.Document.DocumentList.md
@@ -46,6 +46,22 @@ With a series of swaps you can move the item from/to any position.
 
 ---  
 ## Aliases  
+# alias ListElementAdded {#ListElementAdded}
+{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` }  
+
+
+# alias ListElementChange {#ListElementChange}
+[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped)  
+
+
+# alias ListElementRemoved {#ListElementRemoved}
+{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` }  
+
+
+# alias ListElementsSwapped {#ListElementsSwapped}
+{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` }  
+
+
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 

diff --git a/docs/API/renoise/renoise.Document.DocumentNode.md b/docs/API/renoise/renoise.Document.DocumentNode.md
@@ -71,4 +71,8 @@ functions to it.
 table<[`string`](/API/builtins/string.md), [`ObservableTypes`](#ObservableTypes) | [`renoise.Document.DocumentList`](/API/renoise/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md)>  
 
 
+# alias ObservableTypes {#ObservableTypes}
+[`boolean`](/API/builtins/boolean.md) | [`string`](/API/builtins/string.md) | [`number`](/API/builtins/number.md) | [`boolean`](/API/builtins/boolean.md)`[]` | [`number`](/API/builtins/number.md)`[]` | [`string`](/API/builtins/string.md)`[]`  
+
+
 
diff --git a/docs/API/renoise/renoise.Document.ObservableBooleanList.md b/docs/API/renoise/renoise.Document.ObservableBooleanList.md
@@ -54,6 +54,22 @@ Serialize an object to a string.
 
 ---  
 ## Aliases  
+# alias ListElementAdded {#ListElementAdded}
+{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` }  
+
+
+# alias ListElementChange {#ListElementChange}
+[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped)  
+
+
+# alias ListElementRemoved {#ListElementRemoved}
+{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` }  
+
+
+# alias ListElementsSwapped {#ListElementsSwapped}
+{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` }  
+
+
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 

diff --git a/docs/API/renoise/renoise.Document.ObservableList.md b/docs/API/renoise/renoise.Document.ObservableList.md
@@ -26,6 +26,22 @@ Returns the number of entries of the list.
 
 ---  
 ## Aliases  
+# alias ListElementAdded {#ListElementAdded}
+{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` }  
+
+
+# alias ListElementChange {#ListElementChange}
+[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped)  
+
+
+# alias ListElementRemoved {#ListElementRemoved}
+{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` }  
+
+
+# alias ListElementsSwapped {#ListElementsSwapped}
+{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` }  
+
+
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 

diff --git a/docs/API/renoise/renoise.Document.ObservableNumberList.md b/docs/API/renoise/renoise.Document.ObservableNumberList.md
@@ -53,6 +53,22 @@ Serialize an object to a string.
 
 ---  
 ## Aliases  
+# alias ListElementAdded {#ListElementAdded}
+{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` }  
+
+
+# alias ListElementChange {#ListElementChange}
+[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped)  
+
+
+# alias ListElementRemoved {#ListElementRemoved}
+{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` }  
+
+
+# alias ListElementsSwapped {#ListElementsSwapped}
+{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` }  
+
+
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 

diff --git a/docs/API/renoise/renoise.Document.ObservableStringList.md b/docs/API/renoise/renoise.Document.ObservableStringList.md
@@ -53,6 +53,22 @@ Serialize an object to a string.
 
 ---  
 ## Aliases  
+# alias ListElementAdded {#ListElementAdded}
+{ index : [`integer`](/API/builtins/integer.md), type : `"insert"` }  
+
+
+# alias ListElementChange {#ListElementChange}
+[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped)  
+
+
+# alias ListElementRemoved {#ListElementRemoved}
+{ index : [`integer`](/API/builtins/integer.md), type : `"removed"` }  
+
+
+# alias ListElementsSwapped {#ListElementsSwapped}
+{ index1 : [`integer`](/API/builtins/integer.md), index2 : [`integer`](/API/builtins/integer.md), type : `"swapped"` }  
+
+
 # alias ListNotifierFunction {#ListNotifierFunction}
 (change : [`ListElementChange`](#ListElementChange))  
 

diff --git a/docs/API/renoise/renoise.Document.md b/docs/API/renoise/renoise.Document.md
@@ -66,55 +66,6 @@ my_document = MyDocument()
 -- do something with my_document, load/save, add/remove more properties
 ```  
 
----  
-## Properties
-### DocumentList : [`table`](/API/builtins/table.md) {#DocumentList}
-A document list is a document sub component which may contain other document
-nodes in an observable list.
-Construct a new document list.
-
-### DocumentNode : [`table`](/API/builtins/table.md) {#DocumentNode}
-A document node is a sub component in a document which contains other
-documents or observables.
-Construct a new document node.
-
-### Observable : [`table`](/API/builtins/table.md) {#Observable}
-Track changes to document properties or general states by attaching listener
-functions to it.
-
-### ObservableBang : [`table`](/API/builtins/table.md) {#ObservableBang}
-Observable without a value which sends out notifications when "banging" it.
-Construct a new observable bang.
-
-### ObservableBoolean : [`table`](/API/builtins/table.md) {#ObservableBoolean}
-Construct a new observable boolean.
-
-### ObservableBooleanList : [`table`](/API/builtins/table.md) {#ObservableBooleanList}
-A observable list of boolean values.
-Construct a new observable list of booleans.
-
-### ObservableList : [`table`](/API/builtins/table.md) {#ObservableList}
-Track changes to document lists by attaching listener functions to it.
-NB: Notifiers will not broadcast changes made to list items, but only changes
-to the lists **layout** (items got added, removed, swapped).
-
-### ObservableNumber : [`table`](/API/builtins/table.md) {#ObservableNumber}
-Construct a new observable boolean.
-
-### ObservableNumberList : [`table`](/API/builtins/table.md) {#ObservableNumberList}
-A observable list of number values.
-Construct a new observable list of numbers.
-
-### ObservableString : [`table`](/API/builtins/table.md) {#ObservableString}
-Construct a new observable string.
-
-### ObservableStringList : [`table`](/API/builtins/table.md) {#ObservableStringList}
-A observable list of number values.
-Construct a new observable list of strings.
-
-### Serializable : [`table`](/API/builtins/table.md) {#Serializable}
-
-
 ---  
 ## Functions
 ### `create`(model_name : [`string`](/API/builtins/string.md)) {#create}
@@ -171,4 +122,8 @@ have been registered with `renoise.Document.create` before.
 table<[`string`](/API/builtins/string.md), [`ObservableTypes`](#ObservableTypes) | [`renoise.Document.DocumentList`](/API/renoise/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md)>  
 
 
+# alias ObservableTypes {#ObservableTypes}
+[`boolean`](/API/builtins/boolean.md) | [`string`](/API/builtins/string.md) | [`number`](/API/builtins/number.md) | [`boolean`](/API/builtins/boolean.md)`[]` | [`number`](/API/builtins/number.md)`[]` | [`string`](/API/builtins/string.md)`[]`  
+
+
 
diff --git a/docs/API/renoise/renoise.Instrument.md b/docs/API/renoise/renoise.Instrument.md
@@ -1,13 +1,5 @@
 # renoise.Instrument  
 ## Constants
-### Layer {#Layer}
-```lua
-{
-    LAYER_NOTE_DISABLED: integer = 0,
-    LAYER_NOTE_ON: integer = 1,
-    LAYER_NOTE_OFF: integer = 2,
-}
-```
 ### Tab {#Tab}
 ```lua
 {
@@ -16,6 +8,14 @@
     TAB_EXT_MIDI: integer = 3,
 }
 ```
+### PhrasePlaybackMode {#PhrasePlaybackMode}
+```lua
+{
+    PHRASES_OFF: integer = 1,
+    PHRASES_PLAY_SELECTIVE: integer = 2,
+    PHRASES_PLAY_KEYMAP: integer = 3,
+}
+```
 ### OverlapMode {#OverlapMode}
 ```lua
 {
@@ -24,12 +24,12 @@
     OVERLAP_MODE_RANDOM: integer = 2,
 }
 ```
-### PhrasePlaybackMode {#PhrasePlaybackMode}
+### Layer {#Layer}
 ```lua
 {
-    PHRASES_OFF: integer = 1,
-    PHRASES_PLAY_SELECTIVE: integer = 2,
-    PHRASES_PLAY_KEYMAP: integer = 3,
+    LAYER_NOTE_DISABLED: integer = 0,
+    LAYER_NOTE_ON: integer = 1,
+    LAYER_NOTE_OFF: integer = 2,
 }
 ```
 

diff --git a/docs/API/renoise/renoise.Midi.md b/docs/API/renoise/renoise.Midi.md
@@ -58,6 +58,10 @@ The messages will simply go into the void...
 
 ---  
 ## Aliases  
+# alias MidiMessage {#MidiMessage}
+[`integer`](/API/builtins/integer.md)`[]`  
+
+
 # alias MidiMessageFunction {#MidiMessageFunction}
 (message : [`MidiMessage`](#MidiMessage))  
 

diff --git a/docs/API/renoise/renoise.Sample.md b/docs/API/renoise/renoise.Sample.md
@@ -1,20 +1,11 @@
 # renoise.Sample  
 ## Constants
-### NewNoteActionMode {#NewNoteActionMode}
-```lua
-{
-    NEW_NOTE_ACTION_NOTE_CUT: integer = 1,
-    NEW_NOTE_ACTION_NOTE_OFF: integer = 2,
-    NEW_NOTE_ACTION_SUSTAIN: integer = 3,
-}
-```
-### LoopMode {#LoopMode}
+### BeatSyncMode {#BeatSyncMode}
 ```lua
 {
-    LOOP_MODE_OFF: integer = 1,
-    LOOP_MODE_FORWARD: integer = 2,
-    LOOP_MODE_REVERSE: integer = 3,
-    LOOP_MODE_PING_PONG: integer = 4,
+    BEAT_SYNC_REPITCH: integer = 1,
+    BEAT_SYNC_PERCUSSION: integer = 2,
+    BEAT_SYNC_TEXTURE: integer = 3,
 }
 ```
 ### InterpolationMode {#InterpolationMode}
@@ -26,12 +17,21 @@
     INTERPOLATE_SINC: integer = 4,
 }
 ```
-### BeatSyncMode {#BeatSyncMode}
+### NewNoteActionMode {#NewNoteActionMode}
 ```lua
 {
-    BEAT_SYNC_REPITCH: integer = 1,
-    BEAT_SYNC_PERCUSSION: integer = 2,
-    BEAT_SYNC_TEXTURE: integer = 3,
+    NEW_NOTE_ACTION_NOTE_CUT: integer = 1,
+    NEW_NOTE_ACTION_NOTE_OFF: integer = 2,
+    NEW_NOTE_ACTION_SUSTAIN: integer = 3,
+}
+```
+### LoopMode {#LoopMode}
+```lua
+{
+    LOOP_MODE_OFF: integer = 1,
+    LOOP_MODE_FORWARD: integer = 2,
+    LOOP_MODE_REVERSE: integer = 3,
+    LOOP_MODE_PING_PONG: integer = 4,
 }
 ```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -71,4 +71,8 @@ functions to it.
		table<[`string`](/API/builtins/string.md), [`ObservableTypes`](#ObservableTypes) \| [`renoise.Document.DocumentList`](/API/renoise/renoise.Document.DocumentList.md) \| [`renoise.Document.DocumentNode`](/API/renoise/renoise.Document.DocumentNode.md)>


		# alias ObservableTypes {#ObservableTypes}
		[`boolean`](/API/builtins/boolean.md) \| [`string`](/API/builtins/string.md) \| [`number`](/API/builtins/number.md) \| [`boolean`](/API/builtins/boolean.md)`[]` \| [`number`](/API/builtins/number.md)`[]` \| [`string`](/API/builtins/string.md)`[]`