From 5dda685e26c5b45477406b280e032f7d1c07646f Mon Sep 17 00:00:00 2001 From: unlessgames Date: Tue, 15 Sep 2026 05:48:01 +0200 Subject: [PATCH 1/5] remove read-only flags from different indices in song --- library/renoise/application.lua | 2 +- library/renoise/song.lua | 20 +++++++++++--------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/library/renoise/application.lua b/library/renoise/application.lua index d49cacc..e21a02e 100644 --- a/library/renoise/application.lua +++ b/library/renoise/application.lua @@ -148,7 +148,7 @@ function renoise.Application:show_prompt(title, message, button_labels) end ---Optional focus change notifier for a custom dialog. ---Will be called when the dialog gains of loses key focus. You maybe want to initialize ----your dloag's (modifier) keyboard states here. +---your dialog's (modifier) keyboard states here. ---@alias FocusHandler fun(dialogs: renoise.Dialog, focused: boolean) : KeyEvent? ---@alias FocusHandlerMemberFunction fun(self: NotifierMemberContext, dialog: renoise.Dialog, focused: boolean): KeyEvent? ---@alias FocusHandlerMethod1 {[1]:NotifierMemberContext, [2]:FocusHandlerMemberFunction} diff --git a/library/renoise/song.lua b/library/renoise/song.lua index 6cd0c44..f54ed8f 100644 --- a/library/renoise/song.lua +++ b/library/renoise/song.lua @@ -137,53 +137,55 @@ renoise.Song = { ---**READ-ONLY** Selected in the instrument box. ---@field selected_instrument renoise.Instrument ---@field selected_instrument_observable renoise.Document.Observable ----**READ-ONLY** Selected instrument index in the instrument box. +---Selected instrument index in the instrument box. +---Note, Renoise displays zero-based indices here +---but this value starts from one. ---@field selected_instrument_index integer ---@field selected_instrument_index_observable renoise.Document.Observable --- ---**READ-ONLY** Selected phrase the instrument's phrase map piano view. ---@field selected_phrase renoise.InstrumentPhrase? ---@field selected_phrase_observable renoise.Document.Observable ----**READ-ONLY** Selected phrase index the instrument's phrase map piano view. +---Selected phrase index the instrument's phrase map piano view. ---@field selected_phrase_index integer --- ---**READ-ONLY** Selected in the instrument's sample list. ---Only nil when no samples are present in the selected instrument. ---@field selected_sample renoise.Sample? ---@field selected_sample_observable renoise.Document.Observable ----**READ-ONLY** Selected sample index in the instrument's sample list. +---Selected sample index in the instrument's sample list. ---Only 0 when no samples are present in the selected instrument. ---@field selected_sample_index integer --- ---**READ-ONLY** Selected in the instrument's modulation view. ---@field selected_sample_modulation_set renoise.SampleModulationSet? ---@field selected_sample_modulation_set_observable renoise.Document.Observable ----**READ-ONLY** Selected modulation set index in the instrument's modulation view. +---Selected modulation set index in the instrument's modulation view. ---@field selected_sample_modulation_set_index integer --- ---**READ-ONLY** Selected in the instrument's effects view. ---@field selected_sample_device_chain renoise.SampleDeviceChain? ---@field selected_sample_device_chain_observable renoise.Document.Observable ----**READ-ONLY** Selected chain index in the instrument's effects view. +---Selected chain index in the instrument's effects view. ---@field selected_sample_device_chain_index integer --- ---**READ-ONLY** Selected in the sample effect mixer. ---@field selected_sample_device renoise.AudioDevice? ---@field selected_sample_device_observable renoise.Document.Observable ----**READ-ONLY** Selected device index in the sample effect mixer. +---Selected device index in the sample effect mixer. ---@field selected_sample_device_index integer --- ---**READ-ONLY** Selected in the pattern editor or mixer. ---@field selected_track renoise.Track ---@field selected_track_observable renoise.Document.Observable ----**READ-ONLY** Selected track index in the pattern editor or mixer. +---Selected track index in the pattern editor or mixer. ---@field selected_track_index integer ---@field selected_track_index_observable renoise.Document.Observable --- ---**READ-ONLY** Selected in the track DSP chain editor. ---@field selected_track_device renoise.AudioDevice? ---@field selected_track_device_observable renoise.Document.Observable ----**READ-ONLY** Selected device index in the track DSP chain editor. +---Selected device index in the track DSP chain editor. ---@field selected_track_device_index integer --- ---**Deprecated.** **READ-ONLY** Use 'selected_track_device' instead. @@ -212,7 +214,7 @@ renoise.Song = { ---**READ-ONLY** The currently edited pattern. ---@field selected_pattern renoise.Pattern ---@field selected_pattern_observable renoise.Document.Observable ----**READ-ONLY** The currently edited pattern index. +---The currently edited pattern index. ---@field selected_pattern_index integer ---@field selected_pattern_index_observable renoise.Document.Observable --- From 6321acc591ed9e3a525b7165a17faa2116564962 Mon Sep 17 00:00:00 2001 From: unlessgames Date: Tue, 15 Sep 2026 06:52:07 +0200 Subject: [PATCH 2/5] unify read-only annotations as post-type --- library/renoise/application.lua | 56 ++--- library/renoise/application/theme.lua | 28 +-- library/renoise/application/window.lua | 8 +- library/renoise/osc.lua | 20 +- library/renoise/socket.lua | 24 +-- library/renoise/song.lua | 198 +++++++++--------- library/renoise/song/device.lua | 39 ++-- library/renoise/song/instrument.lua | 81 ++++--- library/renoise/song/instrument/macro.lua | 22 +- library/renoise/song/instrument/phrase.lua | 61 +++--- .../renoise/song/instrument/phrase_script.lua | 28 +-- library/renoise/song/instrument/plugin.lua | 77 +++---- library/renoise/song/instrument/sample.lua | 83 ++++---- .../song/instrument/sample_device_chain.lua | 20 +- .../song/instrument/sample_modulation.lua | 56 ++--- library/renoise/song/pattern.lua | 4 +- library/renoise/song/pattern/automation.lua | 4 +- library/renoise/song/pattern/line.lua | 16 +- library/renoise/song/pattern/track.lua | 4 +- library/renoise/song/track.lua | 53 +++-- library/renoise/sqlite.lua | 80 +++---- library/renoise/tool.lua | 4 +- library/renoise/views/canvas.lua | 9 +- library/renoise/views/multiline_text.lua | 4 +- library/renoise/views/view.lua | 4 +- 25 files changed, 490 insertions(+), 493 deletions(-) diff --git a/library/renoise/application.lua b/library/renoise/application.lua index e21a02e..6a1de63 100644 --- a/library/renoise/application.lua +++ b/library/renoise/application.lua @@ -17,49 +17,49 @@ renoise.Application = {} ---@class renoise.Application --- ----**READ-ONLY** Access to the application's full log filename and path. Will +---Access to the application's full log filename and path. Will ---already be opened for writing, but you nevertheless should be able to read ---from it. ----@field log_filename string +---@field log_filename string **READ-ONLY** --- ----**READ-ONLY** Get the apps main document, the song. +---Get the apps main document, the song. ---The global "renoise.song()" function is, in fact, a shortcut to this property. ----@field current_song renoise.Song? +---@field current_song renoise.Song? **READ-ONLY** --- ----**READ-ONLY** List of recently loaded song files. ----@field recently_loaded_song_files string[] ----**READ-ONLY** List of recently saved song files. ----@field recently_saved_song_files string[] +---List of recently loaded song files. +---@field recently_loaded_song_files string[] **READ-ONLY** +---List of recently saved song files. +---@field recently_saved_song_files string[] **READ-ONLY** --- ----**READ-ONLY** Returns information about all currently installed tools. ----@field installed_tools table +---Returns information about all currently installed tools. +---@field installed_tools table **READ-ONLY** ---Fired when the list of installed tools changed. ----@field installed_tools_observable renoise.Document.Observable +---@field installed_tools_observable renoise.Document.Observable **READ-ONLY** --- ---Fired when the list of available audio plugin effects changed, for example ---when scanning for new plugins in the preferences. ---Use the component's `available_plugins` or `available_devices` properties ---to access currently available devices which are supported by the component ---such as the track device chains. ----@field audio_plugin_effects_observable renoise.Document.Observable +---@field audio_plugin_effects_observable renoise.Document.Observable **READ-ONLY** ---Fired when the list of available audio plugin instruments changed, for example ---when scanning for new plugins in the preferences. ----@field audio_plugin_instruments_observable renoise.Document.Observable +---@field audio_plugin_instruments_observable renoise.Document.Observable **READ-ONLY** --- ---**Deprecated.** **READ-ONLY** Use `key_modifier_flags` instead ---@deprecated ---@field key_modifier_states table ----**READ-ONLY** Access keyboard modifier states. ----@field key_modifier_flags ModifierFlags +---Access keyboard modifier states. +---@field key_modifier_flags ModifierFlags **READ-ONLY** --- ----**READ-ONLY** Access to the application's window. ----@field window renoise.ApplicationWindow +---Access to the application's window. +---@field window renoise.ApplicationWindow **READ-ONLY** --- ----**READ-ONLY** Access to the application's color theme. ----@field theme renoise.ApplicationTheme +---Access to the application's color theme. +---@field theme renoise.ApplicationTheme **READ-ONLY** ---Fired, when *any* theme color changed. e.g. when a new theme got loaded ---or when theme colors got edited in the theme preferences. ----@field theme_observable renoise.Document.Observable +---@field theme_observable renoise.Document.Observable **READ-ONLY** --- ---Range: (1 - 4) Get or set globally used clipboard "slots" in the application. ---@field active_clipboard_index 1|2|3|4 @@ -116,11 +116,11 @@ function renoise.Application:show_prompt(title, message, button_labels) end ---@class KeyEvent ---@field name string name of the key, like 'esc' or 'a' ---**Deprecated.** Use `modifier_flags` instead ----**READ-ONLY** the held down modifiers as a string ----@deprecated +---the held down modifiers as a string +---@deprecated **READ-ONLY** ---@field modifiers ModifierStates ----**READ-ONLY** the held down modifiers as flags ----@field modifier_flags ModifierFlags +---the held down modifiers as flags +---@field modifier_flags ModifierFlags **READ-ONLY** ---possible character representation of the key ---@field character string? ---virtual keyboard piano key value (starting from 0) @@ -423,10 +423,10 @@ function renoise.Application:save_theme(filename) end ---create views for the dialog. ---@class renoise.Dialog --- ---- **READ-ONLY** Check if a dialog is alive and visible. ----@field visible boolean ---- **READ-ONLY** Check if a dialog is visible and is the key window. ----@field focused boolean +---Check if a dialog is alive and visible. +---@field visible boolean **READ-ONLY** +---Check if a dialog is visible and is the key window. +---@field focused boolean **READ-ONLY** renoise.Dialog = {} ---### functions diff --git a/library/renoise/application/theme.lua b/library/renoise/application/theme.lua index 4b1c98f..1695e1a 100644 --- a/library/renoise/application/theme.lua +++ b/library/renoise/application/theme.lua @@ -127,7 +127,7 @@ renoise.ApplicationTheme = {} ---@class renoise.ApplicationTheme --- ----**READ-ONLY** Get all theme colors in a flat list of RGBColors. +---Get all theme colors in a flat list of RGBColors. ---Color table keys are string identifiers as used in the theme XML file, ---but in lower case. --- @@ -135,23 +135,23 @@ renoise.ApplicationTheme = {} ---use `renoise.app().theme.color(color_name)` instead. --- ---To get notified of color changes, use `renoise.app().theme_observable` ----@field colors { [ThemeColor]: RGBColor } +---@field colors { [ThemeColor]: RGBColor } **READ-ONLY** --- ----**READ-ONLY** Get theme's knob shade setting. Range: (1 - 2) ----@field knob_shade number ----@field knob_shade_observable renoise.Document.Observable +---Get theme's knob shade setting. Range: (1 - 2) +---@field knob_shade number **READ-ONLY** +---@field knob_shade_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Get theme's body shade setting. Range: (1 - 2) ----@field body_shade number ----@field body_shade_observable renoise.Document.Observable +---Get theme's body shade setting. Range: (1 - 2) +---@field body_shade number **READ-ONLY** +---@field body_shade_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Get theme's contrast setting. Range: (-0.5 - 0.5) ----@field contrast number ----@field contrast_observable renoise.Document.Observable +---Get theme's contrast setting. Range: (-0.5 - 0.5) +---@field contrast number **READ-ONLY** +---@field contrast_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Get theme's texture set name ----@field texture_set string ----@field texture_set_observable renoise.Document.Observable +---Get theme's texture set name +---@field texture_set string **READ-ONLY** +---@field texture_set_observable renoise.Document.Observable **READ-ONLY** --- ---### functions diff --git a/library/renoise/application/window.lua b/library/renoise/application/window.lua index 2244a00..186fe5e 100644 --- a/library/renoise/application/window.lua +++ b/library/renoise/application/window.lua @@ -76,11 +76,11 @@ renoise.ApplicationWindow = { ---Get/set if the application is running fullscreen. ---@field fullscreen boolean --- ----**READ-ONLY**. Window status flag. ----@field is_maximized boolean +---Window status flag. +---@field is_maximized boolean **READ-ONLY** --- ----**READ-ONLY**. Window status flag. ----@field is_minimized boolean +---Window status flag. +---@field is_minimized boolean **READ-ONLY** --- ---When true, the middle frame views (like the pattern editor) will ---stay focused unless alt or middle mouse is clicked. diff --git a/library/renoise/osc.lua b/library/renoise/osc.lua index dbc8101..d0119bf 100644 --- a/library/renoise/osc.lua +++ b/library/renoise/osc.lua @@ -33,16 +33,16 @@ function renoise.Osc.from_binary_data(binary_data) end ---@class renoise.Osc.Message --- ----**READ-ONLY** The message pattern (e.g. "/renoise/transport/start") ----@field pattern string +---The message pattern (e.g. "/renoise/transport/start") +---@field pattern string **READ-ONLY** --- ----**READ-ONLY** Table of `{tag="X", value=SomeValue}` that represents the +---Table of `{tag="X", value=SomeValue}` that represents the ---message arguments. See `renoise.Osc.Message.create` for more info. ----@field arguments OscValue[] +---@field arguments OscValue[] **READ-ONLY** --- ----**READ-ONLY** Raw binary representation of the message, as needed when e.g. +---Raw binary representation of the message, as needed when e.g. ---sending the message over the network through sockets. ----@field binary_data string +---@field binary_data string **READ-ONLY** renoise.Osc.Message = {} ---### functions @@ -87,11 +87,11 @@ function renoise.Osc.Message(pattern, arguments) end ---@class renoise.Osc.Bundle --- ----**READ-ONLY** Time value of the bundle. ----@field timetag number +---Time value of the bundle. +---@field timetag number **READ-ONLY** --- ----**READ-ONLY** Access to the bundle elements (table of messages or bundles) ----@field elements (renoise.Osc.Message|renoise.Osc.Bundle)[] +---Access to the bundle elements (table of messages or bundles) +---@field elements (renoise.Osc.Message|renoise.Osc.Bundle)[] **READ-ONLY** --- -- **READ-ONLY** Raw binary representation of the bundle, as needed when e.g. ---sending the message over the network through sockets. diff --git a/library/renoise/socket.lua b/library/renoise/socket.lua index 27a73db..0d234b7 100644 --- a/library/renoise/socket.lua +++ b/library/renoise/socket.lua @@ -80,18 +80,18 @@ function renoise.Socket.create_client(server_address, server_port, protocol, tim ---SocketBase properties and functions are available for servers and clients. ---@class renoise.Socket.SocketBase --- ----**READ-ONLY** Returns true when the socket object is valid and connected. +---Returns true when the socket object is valid and connected. ---Sockets can manually be closed (see socket:close()). Client sockets can also ---actively be closed/refused by the server. In this case the client:receive() ---calls will fail and return an error. ----@field is_open boolean +---@field is_open boolean **READ-ONLY** --- ----**READ-ONLY** The socket's resolved local address (for example "127.0.0.1" +---The socket's resolved local address (for example "127.0.0.1" ---when a socket is bound to "localhost") ----@field local_address string +---@field local_address string **READ-ONLY** --- ----**READ-ONLY** The socket's local port number, as specified when instantiated. ----@field local_port integer +---The socket's local port number, as specified when instantiated. +---@field local_port integer **READ-ONLY** renoise.Socket.SocketBase = {} ---### functions @@ -120,13 +120,13 @@ function renoise.Socket.SocketBase:close() end ---messages it will not block or timeout. ---@class renoise.Socket.SocketClient : renoise.Socket.SocketBase --- ----**READ-ONLY** Address of the socket's peer, the socket address this client +---Address of the socket's peer, the socket address this client ---is connected to. ----@field peer_address string +---@field peer_address string **READ-ONLY** --- ----**READ-ONLY** Port of the socket's peer, the socket this client is +---Port of the socket's peer, the socket this client is ---connected to. ----@field peer_port integer +---@field peer_port integer **READ-ONLY** renoise.Socket.SocketClient = {} ---### functions @@ -192,8 +192,8 @@ function renoise.Socket.SocketClient:receive(mode, timeout_ms) end ---callbacks are invoked to respond to messages. ---@class renoise.Socket.SocketServer : renoise.Socket.SocketBase --- ----**READ-ONLY** true while the server is running, else false. ----@field is_running boolean +---true while the server is running, else false. +---@field is_running boolean **READ-ONLY** renoise.Socket.SocketServer = {} diff --git a/library/renoise/song.lua b/library/renoise/song.lua index f54ed8f..6e1595e 100644 --- a/library/renoise/song.lua +++ b/library/renoise/song.lua @@ -69,26 +69,26 @@ renoise.Song = { ---Renoise's main document - the song. ---@class renoise.Song --- ----**READ-ONLY** When the song is loaded from or saved to a file, the absolute +---When the song is loaded from or saved to a file, the absolute ---path and name to the XRNS file, otherwise an empty string. ----@field file_name string +---@field file_name string **READ-ONLY** --- ---Song Comments ---@field artist string ----@field artist_observable renoise.Document.Observable +---@field artist_observable renoise.Document.Observable **READ-ONLY** ---@field name string ----@field name_observable renoise.Document.Observable +---@field name_observable renoise.Document.Observable **READ-ONLY** ---Note: All property tables of basic types in the API are temporary copies. ---In other words `comments = { "Hello", "World" }` will work, ---`comments[1] = "Hello"; renoise.song().comments[2] = "World"` ---will *not* work. ---@field comments string[] ----@field comments_observable renoise.Document.ObservableList ----**READ-ONLY** Notifier is called as soon as any paragraph in the comments change. ----@field comments_assignment_observable renoise.Document.Observable +---@field comments_observable renoise.Document.ObservableList **READ-ONLY** +---Notifier is called as soon as any paragraph in the comments change. +---@field comments_assignment_observable renoise.Document.Observable **READ-ONLY** ---Set this to true to show the comments dialog after loading a song ---@field show_comments_after_loading boolean ----@field show_comments_after_loading_observable renoise.Document.Observable +---@field show_comments_after_loading_observable renoise.Document.Observable **READ-ONLY** --- ---Inject/fetch custom XRNX scripting tool data into the song. Can only be called ---from scripts that are running in Renoise scripting tool bundles; attempts to @@ -103,88 +103,88 @@ renoise.Song = { ---Alternatively, write your own serializers for your custom data. ---@field tool_data string? --- ----**READ-ONLY** True while rendering is in progress. +---True while rendering is in progress. ---@see renoise.Song.render ----@field rendering boolean ----**READ-ONLY** The current render progress amount +---@field rendering boolean **READ-ONLY** +---The current render progress amount ---@see renoise.Song.render ----@field rendering_progress number Range: (0.0 - 1.0) ---- ----**READ-ONLY** ----@field transport renoise.Transport ---- ----**READ-ONLY** ----@field sequencer renoise.PatternSequencer ---- ----**READ-ONLY** ----@field pattern_iterator renoise.PatternIterator ---- ----**READ-ONLY** number of normal playback tracks (non-master or sends) in song. ----@field sequencer_track_count integer -----**READ-ONLY** number of send tracks in song. ----@field send_track_count integer ---- ----**READ-ONLY** Instrument arrays ----@field instruments renoise.Instrument[] ----@field instruments_observable renoise.Document.ObservableList ----**READ-ONLY** Pattern arrays ----@field patterns renoise.Pattern[] ----@field patterns_observable renoise.Document.ObservableList ----**READ-ONLY** Track array ----@field tracks renoise.Track[] ----@field tracks_observable renoise.Document.ObservableList ---- ----**READ-ONLY** Selected in the instrument box. ----@field selected_instrument renoise.Instrument ----@field selected_instrument_observable renoise.Document.Observable +---@field rendering_progress number Range: (0.0 - 1.0) **READ-ONLY** +--- +--- +---@field transport renoise.Transport **READ-ONLY** +--- +--- +---@field sequencer renoise.PatternSequencer **READ-ONLY** +--- +--- +---@field pattern_iterator renoise.PatternIterator **READ-ONLY** +--- +---number of normal playback tracks (non-master or sends) in song. +---@field sequencer_track_count integer **READ-ONLY** +---number of send tracks in song. +---@field send_track_count integer **READ-ONLY** +--- +---Instrument arrays +---@field instruments renoise.Instrument[] **READ-ONLY** +---@field instruments_observable renoise.Document.ObservableList **READ-ONLY** +---Pattern arrays +---@field patterns renoise.Pattern[] **READ-ONLY** +---@field patterns_observable renoise.Document.ObservableList **READ-ONLY** +---Track array +---@field tracks renoise.Track[] **READ-ONLY** +---@field tracks_observable renoise.Document.ObservableList **READ-ONLY** +--- +---Selected in the instrument box. +---@field selected_instrument renoise.Instrument **READ-ONLY** +---@field selected_instrument_observable renoise.Document.Observable **READ-ONLY** ---Selected instrument index in the instrument box. ---Note, Renoise displays zero-based indices here ---but this value starts from one. ---@field selected_instrument_index integer ----@field selected_instrument_index_observable renoise.Document.Observable +---@field selected_instrument_index_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Selected phrase the instrument's phrase map piano view. ----@field selected_phrase renoise.InstrumentPhrase? ----@field selected_phrase_observable renoise.Document.Observable +---Selected phrase the instrument's phrase map piano view. +---@field selected_phrase renoise.InstrumentPhrase? **READ-ONLY** +---@field selected_phrase_observable renoise.Document.Observable **READ-ONLY** ---Selected phrase index the instrument's phrase map piano view. ---@field selected_phrase_index integer --- ----**READ-ONLY** Selected in the instrument's sample list. +---Selected in the instrument's sample list. ---Only nil when no samples are present in the selected instrument. ----@field selected_sample renoise.Sample? ----@field selected_sample_observable renoise.Document.Observable +---@field selected_sample renoise.Sample? **READ-ONLY** +---@field selected_sample_observable renoise.Document.Observable **READ-ONLY** ---Selected sample index in the instrument's sample list. ---Only 0 when no samples are present in the selected instrument. ---@field selected_sample_index integer --- ----**READ-ONLY** Selected in the instrument's modulation view. ----@field selected_sample_modulation_set renoise.SampleModulationSet? ----@field selected_sample_modulation_set_observable renoise.Document.Observable +---Selected in the instrument's modulation view. +---@field selected_sample_modulation_set renoise.SampleModulationSet? **READ-ONLY** +---@field selected_sample_modulation_set_observable renoise.Document.Observable **READ-ONLY** ---Selected modulation set index in the instrument's modulation view. ---@field selected_sample_modulation_set_index integer --- ----**READ-ONLY** Selected in the instrument's effects view. ----@field selected_sample_device_chain renoise.SampleDeviceChain? ----@field selected_sample_device_chain_observable renoise.Document.Observable +---Selected in the instrument's effects view. +---@field selected_sample_device_chain renoise.SampleDeviceChain? **READ-ONLY** +---@field selected_sample_device_chain_observable renoise.Document.Observable **READ-ONLY** ---Selected chain index in the instrument's effects view. ---@field selected_sample_device_chain_index integer --- ----**READ-ONLY** Selected in the sample effect mixer. ----@field selected_sample_device renoise.AudioDevice? ----@field selected_sample_device_observable renoise.Document.Observable +---Selected in the sample effect mixer. +---@field selected_sample_device renoise.AudioDevice? **READ-ONLY** +---@field selected_sample_device_observable renoise.Document.Observable **READ-ONLY** ---Selected device index in the sample effect mixer. ---@field selected_sample_device_index integer --- ----**READ-ONLY** Selected in the pattern editor or mixer. ----@field selected_track renoise.Track ----@field selected_track_observable renoise.Document.Observable +---Selected in the pattern editor or mixer. +---@field selected_track renoise.Track **READ-ONLY** +---@field selected_track_observable renoise.Document.Observable **READ-ONLY** ---Selected track index in the pattern editor or mixer. ---@field selected_track_index integer ----@field selected_track_index_observable renoise.Document.Observable +---@field selected_track_index_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Selected in the track DSP chain editor. ----@field selected_track_device renoise.AudioDevice? ----@field selected_track_device_observable renoise.Document.Observable +---Selected in the track DSP chain editor. +---@field selected_track_device renoise.AudioDevice? **READ-ONLY** +---@field selected_track_device_observable renoise.Document.Observable **READ-ONLY** ---Selected device index in the track DSP chain editor. ---@field selected_track_device_index integer --- @@ -205,49 +205,49 @@ renoise.Song = { ---Selected parameter in the automation editor. ---When setting a new parameter, parameter must be automateable and ---must be one of the currently selected track device chain. ----@field selected_automation_parameter renoise.DeviceParameter? ----@field selected_automation_parameter_observable renoise.Document.Observable ----**READ-ONLY** Parent device of 'selected_automation_parameter'. ----@field selected_automation_device renoise.AudioDevice? ----@field selected_automation_device_observable renoise.Document.Observable ---- ----**READ-ONLY** The currently edited pattern. ----@field selected_pattern renoise.Pattern ----@field selected_pattern_observable renoise.Document.Observable +---@field selected_automation_parameter renoise.DeviceParameter? **READ-ONLY** +---@field selected_automation_parameter_observable renoise.Document.Observable **READ-ONLY** +---Parent device of 'selected_automation_parameter'. +---@field selected_automation_device renoise.AudioDevice? **READ-ONLY** +---@field selected_automation_device_observable renoise.Document.Observable **READ-ONLY** +--- +---The currently edited pattern. +---@field selected_pattern renoise.Pattern **READ-ONLY** +---@field selected_pattern_observable renoise.Document.Observable **READ-ONLY** ---The currently edited pattern index. ---@field selected_pattern_index integer ----@field selected_pattern_index_observable renoise.Document.Observable +---@field selected_pattern_index_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** The currently edited pattern track object. +---The currently edited pattern track object. ---and selected_track_observable for notifications. ----@field selected_pattern_track renoise.PatternTrack ----@field selected_pattern_track_observable renoise.Document.Observable +---@field selected_pattern_track renoise.PatternTrack **READ-ONLY** +---@field selected_pattern_track_observable renoise.Document.Observable **READ-ONLY** --- ---The currently edited sequence position. ---@field selected_sequence_index integer ----@field selected_sequence_index_observable renoise.Document.Observable +---@field selected_sequence_index_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** The currently edited line in the edited pattern. ----@field selected_line renoise.PatternLine +---The currently edited line in the edited pattern. +---@field selected_line renoise.PatternLine **READ-ONLY** ---@field selected_line_index integer ----**READ-ONLY** The currently edited column in the selected line in the edited +---The currently edited column in the selected line in the edited ---sequence/pattern. Nil when an effect column is selected. ----@field selected_note_column renoise.NoteColumn? +---@field selected_note_column renoise.NoteColumn? **READ-ONLY** ---@field selected_note_column_index integer ----**READ-ONLY** The currently edited column in the selected line in the edited +---The currently edited column in the selected line in the edited ---sequence/pattern. Nil when a note column is selected. ----@field selected_effect_column renoise.EffectColumn? +---@field selected_effect_column renoise.EffectColumn? **READ-ONLY** ---@field selected_effect_column_index integer ----**READ-ONLY** The currently edited sub column type within the selected +---The currently edited sub column type within the selected ---note/effect column. ----@field selected_sub_column_type renoise.Song.SubColumnType +---@field selected_sub_column_type renoise.Song.SubColumnType **READ-ONLY** --- ---Read/write access to the selection in the pattern editor. --- ---Line indexes are valid from 1 to patterns[].number_of_lines ---Track indexes are valid from 1 to #tracks ---Column indexes are valid from 1 to ---- (tracks[].visible_note_columns + tracks[].visible_effect_columns) +--- (tracks[].visible_note_columns + tracks[].visible_effect_columns) --- ---When setting the selection, all members are optional. Combining them in ---various different ways will affect how specific the selection is. When @@ -256,36 +256,36 @@ renoise.Song = { ---### examples: ---```lua ---renoise.song().selection_in_pattern = {} ---- --> clear +--- --> clear ---renoise.song().selection_in_pattern = { start_line = 1, end_line = 4 } ---- --> select line 1 to 4, first to last track +--- --> select line 1 to 4, first to last track ---renoise.song().selection_in_pattern = ---- { start_line = 1, start_track = 1, end_line = 4, end_track = 1 } ---- --> select line 1 to 4, in the first track only +--- { start_line = 1, start_track = 1, end_line = 4, end_track = 1 } +--- --> select line 1 to 4, in the first track only ---``` ---@field selection_in_pattern PatternSelection? --- ----**READ-ONLY** The currently edited line in the currently edited phrase. +---The currently edited line in the currently edited phrase. ---Nil when no phrase is selected. ----@field selected_phrase_line renoise.PatternLine? +---@field selected_phrase_line renoise.PatternLine? **READ-ONLY** ---The currently edited line index in the currently edited phrase. ---0 when no phrase is selected. ---@field selected_phrase_line_index integer ----**READ-ONLY** The currently edited column in the selected line in the currently +---The currently edited column in the selected line in the currently ---edited phrase. Nil when no phrase is selected or when an effect column is selected. ----@field selected_phrase_note_column renoise.NoteColumn? +---@field selected_phrase_note_column renoise.NoteColumn? **READ-ONLY** ---The currently edited column index in the selected line in the currently edited ---phrase. 0 when no phrase is selected or when an effect column is selected. ---@field selected_phrase_note_column_index integer ----**READ-ONLY** The currently edited column in the selected line in the currently +---The currently edited column in the selected line in the currently ---edited phrase. Nil when no phrase is selected or when a note column is selected. ----@field selected_phrase_effect_column renoise.EffectColumn? +---@field selected_phrase_effect_column renoise.EffectColumn? **READ-ONLY** ---The currently edited effect column index in the selected line in the currently ---edited phrase. 0 when no phrase is selected or when a note column is selected. ---@field selected_phrase_effect_column_index integer ----**READ-ONLY** The currently edited sub column type within the selected +---The currently edited sub column type within the selected ---note/effect column in the current phrase. 0 when no phrase is selected. ----@field selected_phrase_sub_column_type renoise.Song.SubColumnType +---@field selected_phrase_sub_column_type renoise.Song.SubColumnType **READ-ONLY** --- ---Same as `selection_in_pattern` but for the currently selected phrase (if any). ---@field selection_in_phrase PhraseSelection? @@ -293,7 +293,7 @@ renoise.Song = { ---### functions ---True while an undo/redo action is invoked. This may be useful to check in notifiers, ---- to figure out if the document currently changes because of an undo/redo operation. +---to figure out if the document currently changes because of an undo/redo operation. function renoise.Song:is_undo_redoing() end ---Test if something in the song can be undone. diff --git a/library/renoise/song/device.lua b/library/renoise/song/device.lua index f583cc2..2e222f0 100644 --- a/library/renoise/song/device.lua +++ b/library/renoise/song/device.lua @@ -23,38 +23,39 @@ renoise.AudioDevice = {} --- ---Configurable device display name. When empty `name` is displayed. ---@field display_name string ----@field display_name_observable renoise.Document.Observable +---@field display_name_observable renoise.Document.Observable **READ-ONLY** --- ---Enable/bypass the device. ---@field is_active boolean !active = bypassed ----@field is_active_observable renoise.Document.Observable +---@field is_active_observable renoise.Document.Observable **READ-ONLY** --- ---Maximize state in DSP chain. ---@field is_maximized boolean ----@field is_maximized_observable renoise.Document.Observable +---@field is_maximized_observable renoise.Document.Observable **READ-ONLY** --- ---Preset handling. ---@field active_preset integer 0 when none is active or available ----@field active_preset_observable renoise.Document.Observable +---@field active_preset_observable renoise.Document.Observable **READ-ONLY** ---@field active_preset_data string raw serialized data in XML format of the active preset ----@field presets string[] **READ-ONLY** preset names +---The names of existing presets +---@field presets string[] **READ-ONLY** --- ---Parameters. ---@field is_active_parameter renoise.DeviceParameter **READ-ONLY** ---@field parameters renoise.DeviceParameter[] **READ-ONLY** --- ----**READ-ONLY** Returns whether or not the device provides its own custom GUI +---Returns whether or not the device provides its own custom GUI ---(only available for some plugin devices) ----@field external_editor_available boolean +---@field external_editor_available boolean **READ-ONLY** --- ---When the device has no custom GUI an error will be fired (see ---external_editor_available), otherwise the external editor is opened/closed. ---@field external_editor_visible boolean true to show the editor, false to close it --- ----**READ-ONLY** Returns a string that uniquely identifies the device, from +---Returns a string that uniquely identifies the device, from ---`available_devices`. The string can be passed into: ---`renoise.song().tracks[]:insert_device_at()` ----@field device_path string +---@field device_path string **READ-ONLY** ---### functions @@ -93,7 +94,7 @@ renoise.DeviceParameter = { --- ---Device parameters. ---@field name string **READ-ONLY** ----@field name_observable renoise.Document.ObservableString +---@field name_observable renoise.Document.ObservableString **READ-ONLY** -- ---@field polarity renoise.DeviceParameter.Polarity **READ-ONLY** --- @@ -112,24 +113,24 @@ renoise.DeviceParameter = { ---renoise.song().patterns[].tracks[]:create_automation) ---@field is_automatable boolean **READ-ONLY** --- ----**READ-ONLY** Is automated. Not valid for parameters of instrument devices. ----@field is_automated boolean ----@field is_automated_observable renoise.Document.Observable +---Is automated. Not valid for parameters of instrument devices. +---@field is_automated boolean **READ-ONLY** +---@field is_automated_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Parameter has a custom MIDI mapping in the current song. ----@field is_midi_mapped boolean ----@field is_midi_mapped_observable renoise.Document.Observable +---Parameter has a custom MIDI mapping in the current song. +---@field is_midi_mapped boolean **READ-ONLY** +---@field is_midi_mapped_observable renoise.Document.Observable **READ-ONLY** --- ---Show in mixer. Not valid for parameters of instrument devices. ---@field show_in_mixer boolean ----@field show_in_mixer_observable renoise.Document.Observable +---@field show_in_mixer_observable renoise.Document.Observable **READ-ONLY** --- ---Values. ---@field value number value in Range: (value_min - value_max) ----@field value_observable renoise.Document.Observable +---@field value_observable renoise.Document.Observable **READ-ONLY** --- ---@field value_string string ----@field value_string_observable renoise.Document.Observable +---@field value_string_observable renoise.Document.Observable **READ-ONLY** ---### functions diff --git a/library/renoise/song/instrument.lua b/library/renoise/song/instrument.lua index 352f258..c71d329 100644 --- a/library/renoise/song/instrument.lua +++ b/library/renoise/song/instrument.lua @@ -78,8 +78,8 @@ renoise.Instrument = { ---@field macros_visible boolean ---@field macros_visible_observable renoise.Document.Observable --- ----**READ-ONLY** Macro parameters. Array with size Instrument.NUMBER_OF_MACROS. ----@field macros renoise.InstrumentMacro[] +---Macro parameters. Array with size Instrument.NUMBER_OF_MACROS. +---@field macros renoise.InstrumentMacro[] **READ-ONLY** --- ---Access the MIDI pitch-bend macro ---@field pitchbend_macro renoise.InstrumentMacro @@ -93,67 +93,66 @@ renoise.Instrument = { ---Global linear volume of the instrument. Applied to all samples, MIDI and ---plugins in the instrument. ---@field volume number Range: (0 - math.db2lin(6)) ----@field volume_observable renoise.Document.Observable +---@field volume_observable renoise.Document.Observable **READ-ONLY** --- ---Range: (-120 - 120). Global relative pitch in semi tones. ---Applied to all samples, MIDI and plugins in the instrument. ---@field transpose integer ----@field transpose_observable renoise.Document.Observable +---@field transpose_observable renoise.Document.Observable **READ-ONLY** --- ---Global trigger options (quantization and scaling options). ---@field trigger_options renoise.InstrumentTriggerOptions --- ---Sample mapping's overlap trigger mode. ---@field sample_mapping_overlap_mode renoise.Instrument.OverlapMode ----@field sample_mapping_overlap_mode_observable renoise.Document.Observable +---@field sample_mapping_overlap_mode_observable renoise.Document.Observable **READ-ONLY** --- ---Phrase editor pane visibility in the GUI. ---@field phrase_editor_visible boolean ----@field phrase_editor_visible_observable renoise.Document.Observable +---@field phrase_editor_visible_observable renoise.Document.Observable **READ-ONLY** --- ---Phrase playback. ---@field phrase_playback_mode renoise.Instrument.PhrasePlaybackMode ----@field phrase_playback_mode_observable renoise.Document.Observable +---@field phrase_playback_mode_observable renoise.Document.Observable **READ-ONLY** --- ---Phrase playback program: 0 = Off, 1-126 = specific phrase, 127 = keymap. ---@field phrase_program integer ----@field phrase_program_observable renoise.Document.Observable +---@field phrase_program_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Phrases. ----@field phrases renoise.InstrumentPhrase[] ----@field phrases_observable renoise.Document.ObservableList +---Phrases. +---@field phrases renoise.InstrumentPhrase[] **READ-ONLY** +---@field phrases_observable renoise.Document.ObservableList **READ-ONLY** --- ----**READ-ONLY** Phrase mappings. ----@field phrase_mappings renoise.InstrumentPhraseMapping[] ----@field phrase_mappings_observable renoise.Document.ObservableList +---Phrase mappings. +---@field phrase_mappings renoise.InstrumentPhraseMapping[] **READ-ONLY** +---@field phrase_mappings_observable renoise.Document.ObservableList **READ-ONLY** --- ----**READ-ONLY** Samples slots. ----@field samples renoise.Sample[] ----@field samples_observable renoise.Document.ObservableList +---Samples slots. +---@field samples renoise.Sample[] **READ-ONLY** +---@field samples_observable renoise.Document.ObservableList **READ-ONLY** --- ----**READ-ONLY** ---Sample mappings (key/velocity to sample slot mappings). ---sample_mappings[LAYER_NOTE_ON/OFF][]. Sample mappings also can ---be accessed via ---@field samples[].sample_mapping ---@field sample_mappings renoise.SampleMapping[] ----@field sample_mappings_observable renoise.Document.ObservableList +---@field sample_mappings_observable renoise.Document.ObservableList **READ-ONLY** --- ----**READ-ONLY** Sample modulation sets. ----@field sample_modulation_sets renoise.SampleModulationSet[] ----@field sample_modulation_sets_observable renoise.Document.ObservableList +---Sample modulation sets. +---@field sample_modulation_sets renoise.SampleModulationSet[] **READ-ONLY** +---@field sample_modulation_sets_observable renoise.Document.ObservableList **READ-ONLY** --- ----**READ-ONLY** Sample device chains. ----@field sample_device_chains renoise.SampleDeviceChain[] ----@field sample_device_chains_observable renoise.Document.ObservableList +---Sample device chains. +---@field sample_device_chains renoise.SampleDeviceChain[] **READ-ONLY** +---@field sample_device_chains_observable renoise.Document.ObservableList **READ-ONLY** --- ----**READ-ONLY** MIDI input properties. ----@field midi_input_properties renoise.InstrumentMidiInputProperties +---MIDI input properties. +---@field midi_input_properties renoise.InstrumentMidiInputProperties **READ-ONLY** --- ----**READ-ONLY** MIDI output properties. ----@field midi_output_properties renoise.InstrumentMidiOutputProperties +---MIDI output properties. +---@field midi_output_properties renoise.InstrumentMidiOutputProperties **READ-ONLY** --- ----**READ-ONLY** Plugin properties. ----@field plugin_properties renoise.InstrumentPluginProperties +---Plugin properties. +---@field plugin_properties renoise.InstrumentPluginProperties **READ-ONLY** ---### functions @@ -305,20 +304,20 @@ renoise.InstrumentTriggerOptions = { ---@class renoise.InstrumentTriggerOptions --- ----**READ-ONLY** List of all available scale modes. ----@field available_scale_modes string[] +---List of all available scale modes. +---@field available_scale_modes string[] **READ-ONLY** --- ---Scale to use when transposing. One of 'available_scales'. ---@field scale_mode string, one of 'available_scales'] ----@field scale_mode_observable renoise.Document.Observable +---@field scale_mode_observable renoise.Document.Observable **READ-ONLY** --- ---Scale-key to use when transposing (1=C, 2=C#, 3=D, ...) ---@field scale_key integer ----@field scale_key_observable renoise.Document.Observable +---@field scale_key_observable renoise.Document.Observable **READ-ONLY** --- ---When true, act as MTS ESP client. Disables custom tunings. ---@field mts_esp_tuning boolean ----@field mts_esp_tuning_observable renoise.Document.Observable +---@field mts_esp_tuning_observable renoise.Document.Observable **READ-ONLY** --- ---Array of custom pitch values relative to 1/1, used as custom tuning values for ---instrument sample playback. The root key is assumed to be middle C (48 in Renoise), @@ -340,23 +339,23 @@ renoise.InstrumentTriggerOptions = { ---instrument.tuning = well_tempered_tuning ---``` ---@field tuning number[] ----@field tuning_observable renoise.Document.Observable +---@field tuning_observable renoise.Document.Observable **READ-ONLY** --- ---Name, as displayed in the UI for a custom tuning or a tuning loaded from a file. ---@field tuning_name string ----@field tuning_name_observable renoise.Document.Observable +---@field tuning_name_observable renoise.Document.Observable **READ-ONLY** --- ---Trigger quantization mode. ---@field quantize renoise.InstrumentTriggerOptions.QuantizeMode ----@field quantize_observable renoise.Document.Observable +---@field quantize_observable renoise.Document.Observable **READ-ONLY** --- ---Mono/Poly mode. ---@field monophonic boolean ----@field monophonic_observable renoise.Document.Observable +---@field monophonic_observable renoise.Document.Observable **READ-ONLY** --- ---Glide amount when monophonic. 0 == off, 255 = instant ---@field monophonic_glide integer ----@field monophonic_glide_observable renoise.Document.Observable +---@field monophonic_glide_observable renoise.Document.Observable **READ-ONLY** ---### functions diff --git a/library/renoise/song/instrument/macro.lua b/library/renoise/song/instrument/macro.lua index fd70be8..7705e8d 100644 --- a/library/renoise/song/instrument/macro.lua +++ b/library/renoise/song/instrument/macro.lua @@ -18,19 +18,19 @@ renoise.InstrumentMacro = {} --- ---Macro name as visible in the GUI when mappings are presents. ---@field name string ----@field name_observable renoise.Document.Observable +---@field name_observable renoise.Document.Observable **READ-ONLY** --- ---Macro value ---@field value number Range: (0 - 1) ----@field value_observable renoise.Document.Observable +---@field value_observable renoise.Document.Observable **READ-ONLY** --- ---Macro value string ---@field value_string string Range: (0 - 100) ----@field value_string_observable renoise.Document.Observable +---@field value_string_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Macro mappings, target parameters ----@field mappings renoise.InstrumentMacroMapping[] ----@field mappings_observable renoise.Document.ObservableList +---Macro mappings, target parameters +---@field mappings renoise.InstrumentMacroMapping[] **READ-ONLY** +---@field mappings_observable renoise.Document.ObservableList **READ-ONLY** ---### functions @@ -63,18 +63,18 @@ renoise.InstrumentMacroMapping = { ---@class renoise.InstrumentMacroMapping --- --- ----**READ-ONLY** Linked parameter. +---Linked parameter. ---Can be a sample FX- or modulation parameter. Never nil. ----@field parameter renoise.DeviceParameter +---@field parameter renoise.DeviceParameter **READ-ONLY** --- ---Min/max range in which the macro applies its value to the target parameter. ---Max can be < than Min. Mapping is then flipped. ---@field parameter_min number Range: (0 - 1) ----@field parameter_min_observable renoise.Document.Observable +---@field parameter_min_observable renoise.Document.Observable **READ-ONLY** --- ---@field parameter_max number Range: (0 - 1) ----@field parameter_max_observable renoise.Document.Observable +---@field parameter_max_observable renoise.Document.Observable **READ-ONLY** --- ---Scaling which gets applied within the min/max range to set the dest value. ---@field parameter_scaling renoise.InstrumentMacroMapping.Scaling ----@field parameter_scaling_observable renoise.Document.Observable +---@field parameter_scaling_observable renoise.Document.Observable **READ-ONLY** diff --git a/library/renoise/song/instrument/phrase.lua b/library/renoise/song/instrument/phrase.lua index 8e9ab1f..ebc680e 100644 --- a/library/renoise/song/instrument/phrase.lua +++ b/library/renoise/song/instrument/phrase.lua @@ -54,96 +54,95 @@ renoise.InstrumentPhrase = { --- ---Name of the phrase as visible in the phrase editor and piano mappings. ---@field name string ----@field name_observable renoise.Document.Observable +---@field name_observable renoise.Document.Observable **READ-ONLY** --- ---(Key)Mapping properties of the phrase or nil when no mapping is present. ---@field mapping renoise.InstrumentPhraseMapping? --- ---playback mode ---@field playback_mode renoise.InstrumentPhrase.PlaybackMode ----@field playback_mode_observable renoise.Document.Observable +---@field playback_mode_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Phrase script properties. Only used when `playback_mode` is +---Phrase script properties. Only used when `playback_mode` is ---set to `renoise.InstrumentPhrase.PLAY_SCRIPT` ----@field script renoise.InstrumentPhraseScript +---@field script renoise.InstrumentPhraseScript **READ-ONLY** --- ----**READ-ONLY** ---Quickly check if a phrase has some non empty pattern lines. ----@field is_empty boolean ----@field is_empty_observable renoise.Document.Observable +---@field is_empty boolean **READ-ONLY** +---@field is_empty_observable renoise.Document.Observable **READ-ONLY** --- ---Default: 16, Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_LINES) ---Number of lines the phrase currently has. ---@field number_of_lines integer ----@field number_of_lines_observable renoise.Document.Observable +---@field number_of_lines_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Get all lines in a range [1, number_of_lines_in_pattern] ----@field lines renoise.PatternLine[] +---Get all lines in a range [1, number_of_lines_in_pattern] +---@field lines renoise.PatternLine[] **READ-ONLY** --- ---Range: (MIN_NUMBER_OF_NOTE_COLUMNS - MAX_NUMBER_OF_NOTE_COLUMNS) ---How many note columns are visible in the phrase. ---@field visible_note_columns integer ----@field visible_note_columns_observable renoise.Document.Observable +---@field visible_note_columns_observable renoise.Document.Observable **READ-ONLY** --- ---Range: (MIN_NUMBER_OF_EFFECT_COLUMNS - MAX_NUMBER_OF_EFFECT_COLUMNS) ---How many effect columns are visible in the phrase. ---@field visible_effect_columns integer ----@field visible_effect_columns_observable renoise.Document.Observable +---@field visible_effect_columns_observable renoise.Document.Observable **READ-ONLY** --- ---Phrase's key-tracking mode. ---@field key_tracking renoise.InstrumentPhrase.KeyTrackingMode ----@field key_tracking_observable renoise.Document.Observable +---@field key_tracking_observable renoise.Document.Observable **READ-ONLY** --- ---Range: (0 - 119) where C-4 is 48 ---Phrase's base-note. Only relevant when key_tracking is set to transpose. ---@field base_note integer ----@field base_note_observable renoise.Document.Observable +---@field base_note_observable renoise.Document.Observable **READ-ONLY** --- ---Loop mode. The phrase plays as one-shot when disabled. ---@field looping boolean ----@field looping_observable renoise.Document.Observable +---@field looping_observable renoise.Document.Observable **READ-ONLY** --- ---Range: (1 - number_of_lines) ---Loop start. Playback will start from the beginning before entering loop ---@field loop_start integer ----@field loop_start_observable renoise.Document.Observable +---@field loop_start_observable renoise.Document.Observable **READ-ONLY** --- ---Range: (loop_start - number_of_lines) ---Loop end. Needs to be > loop_start and <= number_of_lines ---@field loop_end integer ----@field loop_end_observable renoise.Document.Observable +---@field loop_end_observable renoise.Document.Observable **READ-ONLY** --- ---Phrase autoseek settings ---@field autoseek boolean ----@field autoseek_observable renoise.Document.Observable +---@field autoseek_observable renoise.Document.Observable **READ-ONLY** --- ---Range: (1 - 256) ---Phrase local lines per beat setting. New phrases get initialized with ---the song's current LPB setting. TPL can not be configured in phrases. ---@field lpb integer ----@field lpb_observable renoise.Document.Observable +---@field lpb_observable renoise.Document.Observable **READ-ONLY** --- ---Range: (0 - 1) ---Shuffle groove amount for a phrase. ---0.0 = no shuffle (off), 1.0 = full shuffle ---@field shuffle number ----@field shuffle_observable renoise.Document.Observable +---@field shuffle_observable renoise.Document.Observable **READ-ONLY** --- ---Column visibility. ---@field instrument_column_visible boolean ----@field instrument_column_visible_observable renoise.Document.Observable +---@field instrument_column_visible_observable renoise.Document.Observable **READ-ONLY** --- ---@field volume_column_visible boolean ----@field volume_column_visible_observable renoise.Document.Observable +---@field volume_column_visible_observable renoise.Document.Observable **READ-ONLY** --- ---@field panning_column_visible boolean ----@field panning_column_visible_observable renoise.Document.Observable +---@field panning_column_visible_observable renoise.Document.Observable **READ-ONLY** --- ---@field delay_column_visible boolean ----@field delay_column_visible_observable renoise.Document.Observable +---@field delay_column_visible_observable renoise.Document.Observable **READ-ONLY** --- ---@field sample_effects_column_visible boolean ----@field sample_effects_column_visible_observable renoise.Document.Observable +---@field sample_effects_column_visible_observable renoise.Document.Observable **READ-ONLY** ---### functions @@ -284,24 +283,24 @@ renoise.InstrumentPhraseMapping = { --- ---Phrase's key-tracking mode. ---@field key_tracking renoise.InstrumentPhraseMapping.KeyTrackingMode ----@field key_tracking_observable renoise.Document.Observable +---@field key_tracking_observable renoise.Document.Observable --- ---Phrase's base-note. Only relevant when key_tracking is set to transpose. ---@field base_note integer Range: (0 - 119) where C-4 is 48 ----@field base_note_observable renoise.Document.Observable +---@field base_note_observable renoise.Document.Observable --- ---Note range the mapping is triggered at. Phrases may not overlap, so ---note_range start can only be set behind previous's (if any) end and ---note_range end can only be set before next mapping's (if any) start. ---@field note_range integer[] Range: (0 - 119) where C-4 is 48 ----@field note_range_observable renoise.Document.Observable +---@field note_range_observable renoise.Document.Observable --- ---Loop mode. The phrase plays as one-shot when disabled. ---@field looping boolean ----@field looping_observable renoise.Document.Observable +---@field looping_observable renoise.Document.Observable --- ---@field loop_start integer ----@field loop_start_observable renoise.Document.Observable +---@field loop_start_observable renoise.Document.Observable --- ---@field loop_end integer ----@field loop_end_observable renoise.Document.Observable +---@field loop_end_observable renoise.Document.Observable diff --git a/library/renoise/song/instrument/phrase_script.lua b/library/renoise/song/instrument/phrase_script.lua index 6fa8630..94693e2 100644 --- a/library/renoise/song/instrument/phrase_script.lua +++ b/library/renoise/song/instrument/phrase_script.lua @@ -30,12 +30,12 @@ renoise.InstrumentPhraseScript = {} ---When false, a preview of the script is shown instead of a text editor. ---@field editor_visible boolean ---fired, when the editor visibility changed. ----@field editor_visible_observable renoise.Document.Observable +---@field editor_visible_observable renoise.Document.Observable **READ-ONLY** --- ---- **READ-ONLY** List of script input parameters, if any. ----@field parameters renoise.DeviceParameter[] +---List of script input parameters, if any. +---@field parameters renoise.DeviceParameter[] **READ-ONLY** ---fired, when the input parameter set changed. ----@field parameters_observable renoise.Document.ObservableList +---@field parameters_observable renoise.Document.ObservableList **READ-ONLY** --- ---Script content. When changing paragraphs, changes are visible in the ---script editor, but are not applied for playback until they get committed. @@ -46,27 +46,27 @@ renoise.InstrumentPhraseScript = {} ---Notifier which is called when existing paragraph content changed. ---@field paragraphs_assignment_observable renoise.Document.Observable --- ----**READ-ONLY** When not empty, the script failed to compile. +---When not empty, the script failed to compile. ---This error text is also visible to the user in the script preview. ----@field compile_error string ----@field compile_error_observable renoise.Document.Observable ----**READ-ONLY** When not empty, script compiled successfully, but caused an +---@field compile_error string **READ-ONLY** +---@field compile_error_observable renoise.Document.Observable **READ-ONLY** +---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. ----@field runtime_error string ----@field runtime_error_observable renoise.Document.Observable +---@field runtime_error string **READ-ONLY** +---@field runtime_error_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Number of changes since the last commit() or auto-commit call, +---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. ----@field pending_changes integer ----@field pending_changes_observable renoise.Document.Observable +---@field pending_changes integer **READ-ONLY** +---@field pending_changes_observable renoise.Document.Observable **READ-ONLY** --- ---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. ----@field committed_observable renoise.Document.Observable +---@field committed_observable renoise.Document.Observable **READ-ONLY** ---### functions diff --git a/library/renoise/song/instrument/plugin.lua b/library/renoise/song/instrument/plugin.lua index 9addb09..ee6c8f0 100644 --- a/library/renoise/song/instrument/plugin.lua +++ b/library/renoise/song/instrument/plugin.lua @@ -27,18 +27,18 @@ renoise.InstrumentPluginProperties = {} ---@class renoise.InstrumentPluginProperties --- ----**READ-ONLY** List of all currently available plugins. This is a list of +---List of all currently available plugins. This is a list of ---unique plugin names which also contains the plugin's type (VST/AU/DSSI/...), ---not including the vendor names as visible in Renoise's GUI. So its an ---identifier, and not the name as visible in the GUI. When no plugin is loaded, ---the identifier is an empty string. ----@field available_plugins string[] +---@field available_plugins string[] **READ-ONLY** --- ----**READ-ONLY** Returns a list of tables containing more information about the plugins. ----@field available_plugin_infos PluginInfo[] +---Returns a list of tables containing more information about the plugins. +---@field available_plugin_infos PluginInfo[] **READ-ONLY** --- ----**READ-ONLY** Returns true when a plugin is present; loaded successfully. ----@see renoise.PluginProperties.plugin_device_observable for related notifications. +---Returns true when a plugin is present; loaded successfully. +---@see renoise.PluginProperties.plugin_device_observable for related notifications. **READ-ONLY** ---@field plugin_loaded boolean --- ---Valid object for successfully loaded plugins, otherwise nil. Alias plugin @@ -46,37 +46,38 @@ renoise.InstrumentPluginProperties = {} ---the alias points to. ---The observable is fired when the device changes: when a plugin gets loaded or ---unloaded or a plugin alias is assigned or unassigned. ----@field plugin_device (renoise.InstrumentPluginDevice|renoise.AudioDevice)? ----@field plugin_device_observable renoise.Document.Observable ---- ----**READ-ONLY** Valid for loaded and unloaded plugins. ----@field alias_instrument_index integer 0 when no alias instrument is set ----@field alias_instrument_index_observable renoise.Document.Observable ----**READ-ONLY** 0 when no alias FX is set ----@field alias_fx_track_index integer ----@field alias_fx_track_index_observable renoise.Document.Observable ----**READ-ONLY** 0 when no alias FX is set ----@field alias_fx_device_index integer ----@field alias_fx_device_index_observable renoise.Document.Observable ---- ----**READ-ONLY** Valid for loaded and unloaded plugins. +---@field plugin_device (renoise.InstrumentPluginDevice|renoise.AudioDevice)? **READ-ONLY** +---@field plugin_device_observable renoise.Document.Observable **READ-ONLY** +--- +---Valid for loaded and unloaded plugins, +---0 when no alias instrument is set. +---@field alias_instrument_index integer **READ-ONLY** +---@field alias_instrument_index_observable renoise.Document.Observable **READ-ONLY** +---0 when no alias FX is set +---@field alias_fx_track_index integer **READ-ONLY** +---@field alias_fx_track_index_observable renoise.Document.Observable **READ-ONLY** +---0 when no alias FX is set +---@field alias_fx_device_index integer **READ-ONLY** +---@field alias_fx_device_index_observable renoise.Document.Observable **READ-ONLY** +--- +---Valid for loaded and unloaded plugins. ---target instrument index of the plugin's MIDI output (when present) ----@field midi_output_routing_index integer 0 when no routing is set ----@field midi_output_routing_index_observable renoise.Document.Observable +---@field midi_output_routing_index integer 0 when no routing is set **READ-ONLY** +---@field midi_output_routing_index_observable renoise.Document.Observable **READ-ONLY** --- ---Valid for loaded and unloaded plugins. ---@field channel integer Range: (1 - 16) ----@field channel_observable renoise.Document.Observable +---@field channel_observable renoise.Document.Observable **READ-ONLY** ---@field transpose integer Range: (-120 - 120) ----@field transpose_observable renoise.Document.Observable +---@field transpose_observable renoise.Document.Observable **READ-ONLY** --- ---Valid for loaded and unloaded plugins. ---@field volume number Range: (0.0 - 4.0) linear gain ----@field volume_observable renoise.Document.Observable +---@field volume_observable renoise.Document.Observable **READ-ONLY** --- ---Valid for loaded and unloaded plugins. ---@field auto_suspend boolean ----@field auto_suspend_observable renoise.Document.Observable +---@field auto_suspend_observable renoise.Document.Observable **READ-ONLY** ---### functions @@ -97,35 +98,35 @@ renoise.InstrumentPluginDevice = {} ---@class renoise.InstrumentPluginDevice --- ----**READ-ONLY** Device name. ----@field name string ----**READ-ONLY** ----@field short_name string +---Device name. +---@field name string **READ-ONLY** +--- +---@field short_name string **READ-ONLY** --- ----**READ-ONLY** ----@field presets string[] +--- +---@field presets string[] **READ-ONLY** ---Preset handling. 0 when when none is active (or available) ---@field active_preset integer ---@field active_preset_observable renoise.Document.Observable ---raw XML data of the active preset ---@field active_preset_data string --- ----**READ-ONLY** ----@field parameters renoise.DeviceParameter[] --- ----**READ-ONLY** Returns whether or not the plugin provides its own custom GUI. +---@field parameters renoise.DeviceParameter[] **READ-ONLY** +--- +---Returns whether or not the plugin provides its own custom GUI. --- ----@field external_editor_available boolean +---@field external_editor_available boolean **READ-ONLY** --- ---When the plugin has no custom GUI, Renoise will create a dummy editor for it which ---lists the plugin parameters. ---set to true to show the editor, false to close it ---@field external_editor_visible boolean --- ----**READ-ONLY** Returns a string that uniquely identifies the plugin +---Returns a string that uniquely identifies the plugin ---@see renoise.InstrumentPluginProperties.available_plugins for the list of valid paths ---The string can be passed into: renoise.InstrumentPluginProperties:load_plugin() ----@field device_path string +---@field device_path string **READ-ONLY** ---### functions diff --git a/library/renoise/song/instrument/sample.lua b/library/renoise/song/instrument/sample.lua index 7d60095..ea3542d 100644 --- a/library/renoise/song/instrument/sample.lua +++ b/library/renoise/song/instrument/sample.lua @@ -52,10 +52,10 @@ renoise.Sample = { ---@class renoise.Sample --- ----**READ-ONLY** True, when the sample slot is an alias to a sliced master sample. +---True, when the sample slot is an alias to a sliced master sample. ---Such sample slots are read-only and automatically managed with the master samples ---slice list. ----@field is_slice_alias boolean +---@field is_slice_alias boolean **READ-ONLY** ---Read/write access to the slice marker list of a sample. When new markers are ---set or existing ones unset, existing 0S effects or notes to existing slices ---will NOT be remapped (unlike its done with the insert/remove/move_slice_marker @@ -65,71 +65,70 @@ renoise.Sample = { ---@field slice_markers_observable renoise.Document.ObservableList ---Name. ---@field name string ----@field name_observable renoise.Document.Observable +---@field name_observable renoise.Document.Observable **READ-ONLY** --- ---Panning, volume. ---@field panning number Range: (0.0 - 1.0) ----@field panning_observable renoise.Document.Observable +---@field panning_observable renoise.Document.Observable **READ-ONLY** ---@field volume number Range: (0.0 - 4.0) ----@field volume_observable renoise.Document.Observable +---@field volume_observable renoise.Document.Observable **READ-ONLY** --- ---Tuning. ---@field transpose integer Range: (-120 - 120) ----@field transpose_observable renoise.Document.Observable +---@field transpose_observable renoise.Document.Observable **READ-ONLY** ---@field fine_tune integer Range: (-127 - 127) ----@field fine_tune_observable renoise.Document.Observable +---@field fine_tune_observable renoise.Document.Observable **READ-ONLY** --- ---Beat sync. ---@field beat_sync_enabled boolean ----@field beat_sync_enabled_observable renoise.Document.Observable +---@field beat_sync_enabled_observable renoise.Document.Observable **READ-ONLY** ---@field beat_sync_lines integer Range: (1 - 512) ----@field beat_sync_lines_observable renoise.Document.Observable +---@field beat_sync_lines_observable renoise.Document.Observable **READ-ONLY** ---@field beat_sync_mode renoise.Sample.BeatSyncMode ----@field beat_sync_mode_observable renoise.Document.Observable +---@field beat_sync_mode_observable renoise.Document.Observable **READ-ONLY** --- ---Interpolation, new note action, oneshot, mute_group, autoseek, autofade. ---@field interpolation_mode renoise.Sample.InterpolationMode ----@field interpolation_mode_observable renoise.Document.Observable +---@field interpolation_mode_observable renoise.Document.Observable **READ-ONLY** ---@field oversample_enabled boolean ----@field oversample_enabled_observable renoise.Document.Observable +---@field oversample_enabled_observable renoise.Document.Observable **READ-ONLY** --- ---@field new_note_action renoise.Sample.NewNoteActionMode ----@field new_note_action_observable renoise.Document.Observable +---@field new_note_action_observable renoise.Document.Observable **READ-ONLY** ---@field oneshot boolean ----@field oneshot_observable renoise.Document.Observable +---@field oneshot_observable renoise.Document.Observable **READ-ONLY** ---@field mute_group integer Range: (0 - 15) where 0 means no group ----@field mute_group_observable renoise.Document.Observable +---@field mute_group_observable renoise.Document.Observable **READ-ONLY** ---@field autoseek boolean ----@field autoseek_observable renoise.Document.Observable +---@field autoseek_observable renoise.Document.Observable **READ-ONLY** ---@field autofade boolean ----@field autofade_observable renoise.Document.Observable +---@field autofade_observable renoise.Document.Observable **READ-ONLY** --- ---Loops. ---@field loop_mode renoise.Sample.LoopMode ----@field loop_mode_observable renoise.Document.Observable +---@field loop_mode_observable renoise.Document.Observable **READ-ONLY** ---@field loop_release boolean ----@field loop_release_observable renoise.Document.Observable +---@field loop_release_observable renoise.Document.Observable **READ-ONLY** ---@field loop_start integer Range: (1 - num_sample_frames) ----@field loop_start_observable renoise.Document.Observable +---@field loop_start_observable renoise.Document.Observable **READ-ONLY** ---@field loop_end integer Range: (1 - num_sample_frames) ----@field loop_end_observable renoise.Document.Observable +---@field loop_end_observable renoise.Document.Observable **READ-ONLY** --- ---The linked modulation set. 0 when disable, else a valid index for the ---renoise.Instrument.sample_modulation_sets table ---@field modulation_set_index integer ----@field modulation_set_index_observable renoise.Document.Observable +---@field modulation_set_index_observable renoise.Document.Observable **READ-ONLY** --- ---The linked instrument device chain. 0 when disable, else a valid index for the ---renoise.Instrument.sample_device_chain table ---@field device_chain_index integer ----@field device_chain_index_observable renoise.Document.Observable +---@field device_chain_index_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** ----@field sample_buffer renoise.SampleBuffer ----@field sample_buffer_observable renoise.Document.Observable +---@field sample_buffer renoise.SampleBuffer **READ-ONLY** +---@field sample_buffer_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** Keyboard Note/velocity mapping ----@field sample_mapping renoise.SampleMapping +---Keyboard Note/velocity mapping +---@field sample_mapping renoise.SampleMapping **READ-ONLY** ---### functions @@ -179,9 +178,9 @@ renoise.SampleMapping = {} ---modified. See `sample_mappings[].read_only` ---@class renoise.SampleMapping --- ----**READ-ONLY** True for sliced instruments. No sample mapping properties are +---True for sliced instruments. No sample mapping properties are ---allowed to be modified, but can be read. ----@field read_only boolean +---@field read_only boolean **READ-ONLY** --- ---Linked sample. ---@field sample renoise.Sample @@ -232,24 +231,24 @@ renoise.SampleBuffer = { ---'has_sample_data' returns false: ---@class renoise.SampleBuffer --- ----**READ-ONLY** Check this before accessing properties ----@field has_sample_data boolean +---Check this before accessing properties +---@field has_sample_data boolean **READ-ONLY** --- ----**READ-ONLY** True, when the sample buffer can only be read, but not be +---True, when the sample buffer can only be read, but not be ---modified. true for sample aliases of sliced samples. To modify such sample ---buffers, modify the sliced master sample buffer instead. ----@field read_only boolean ----**READ-ONLY** The current sample rate in Hz, like 44100. ----@field sample_rate integer +---@field read_only boolean **READ-ONLY** +---The current sample rate in Hz, like 44100. +---@field sample_rate integer **READ-ONLY** --- ----**READ-ONLY** The current bit depth, like 32, 16, 8. ----@field bit_depth integer +---The current bit depth, like 32, 16, 8. +---@field bit_depth integer **READ-ONLY** --- ----**READ-ONLY** The integer of sample channels (1 or 2) ----@field number_of_channels integer +---The integer of sample channels (1 or 2) +---@field number_of_channels integer **READ-ONLY** --- ----**READ-ONLY** The sample frame count (integer of samples per channel) ----@field number_of_frames integer +---The sample frame count (integer of samples per channel) +---@field number_of_frames integer **READ-ONLY** --- ---The first sample displayed in the sample editor view. Set together with ---DisplayLength to control zooming. diff --git a/library/renoise/song/instrument/sample_device_chain.lua b/library/renoise/song/instrument/sample_device_chain.lua index f24a1b8..1b9c330 100644 --- a/library/renoise/song/instrument/sample_device_chain.lua +++ b/library/renoise/song/instrument/sample_device_chain.lua @@ -20,25 +20,25 @@ renoise.SampleDeviceChain = {} ---@field name string ---@field name_observable renoise.Document.Observable --- ----**READ-ONLY** Allowed, available devices for 'insert_device_at'. ----@field available_devices string[] +---Allowed, available devices for 'insert_device_at'. +---@field available_devices string[] **READ-ONLY** --- ----**READ-ONLY** Returns a list of tables containing more information about +---Returns a list of tables containing more information about ---the devices. ---@see renoise.Track.available_device_infos ----@field available_device_infos AudioDeviceInfo[] +---@field available_device_infos AudioDeviceInfo[] **READ-ONLY** --- ----**READ-ONLY** Device access. ----@field devices renoise.AudioDevice[] ----@field devices_observable renoise.Document.ObservableList +---Device access. +---@field devices renoise.AudioDevice[] **READ-ONLY** +---@field devices_observable renoise.Document.ObservableList **READ-ONLY** --- ----**READ-ONLY** Output routing. ----@field available_output_routings string[] +---Output routing. +---@field available_output_routings string[] **READ-ONLY** --- ---One of 'available_output_routings' ---@see renoise.SampleDeviceChain.available_output_routings ---@field output_routing string ----@field output_routing_observable renoise.Document.Observable +---@field output_routing_observable renoise.Document.Observable **READ-ONLY** ---### functions diff --git a/library/renoise/song/instrument/sample_modulation.lua b/library/renoise/song/instrument/sample_modulation.lua index 8f86fb4..735cc82 100644 --- a/library/renoise/song/instrument/sample_modulation.lua +++ b/library/renoise/song/instrument/sample_modulation.lua @@ -93,7 +93,7 @@ renoise.SampleModulationSet = {} --- ---Name of the modulation set. ---@field name string ----@field name_observable renoise.Document.Observable +---@field name_observable renoise.Document.Observable **READ-ONLY** --- ---Input value for the volume domain ---@field volume_input renoise.DeviceParameter @@ -115,28 +115,28 @@ renoise.SampleModulationSet = {} --- ---Pitch range in semitones ---@field pitch_range integer Range: (1 - 96) ----@field pitch_range_observable renoise.Document.Observable +---@field pitch_range_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** All available devices, to be used in 'insert_device_at'. ----@field available_devices string[] +---All available devices, to be used in 'insert_device_at'. +---@field available_devices string[] **READ-ONLY** --- ----**READ-ONLY** Device list access. ----@field devices renoise.SampleModulationDevice[] ----@field devices_observable renoise.Document.ObservableList +---Device list access. +---@field devices renoise.SampleModulationDevice[] **READ-ONLY** +---@field devices_observable renoise.Document.ObservableList **READ-ONLY** --- ----**READ-ONLY** Filter version, 3 is the latest. +---Filter version, 3 is the latest. ---@see renoise.SampleModulationSet.upgrade_filter_version ----@field filter_version 1 | 2 | 3 ----@field filter_version_observable renoise.Document.Observable +---@field filter_version 1 | 2 | 3 **READ-ONLY** +---@field filter_version_observable renoise.Document.Observable **READ-ONLY** --- ----**READ-ONLY** List of available filter types depending on the filter_version. ----@field available_filter_types FilterTypes[] +---List of available filter types depending on the filter_version. +---@field available_filter_types FilterTypes[] **READ-ONLY** --- ---The type of the filter selected for the modulation set. ---Songs made with previous versions of Renoise may use old filter types. ---@see renoise.SampleModulationSet.available_filter_types ----@field filter_type FilterTypes ----@field filter_type_observable renoise.Document.Observable +---@field filter_type FilterTypes **READ-ONLY** +---@field filter_type_observable renoise.Document.Observable **READ-ONLY** ---### functions @@ -200,11 +200,11 @@ renoise.SampleModulationDevice = { ---@class renoise.SampleModulationDevice --- ----**READ-ONLY** Fixed name of the device. ----@field name string +---Fixed name of the device. +---@field name string **READ-ONLY** +--- --- ----**READ-ONLY** ----@field short_name string +---@field short_name string **READ-ONLY** --- ---Configurable device display name. ---@field display_name string @@ -223,9 +223,9 @@ renoise.SampleModulationDevice = { ---@field is_maximized boolean ---@field is_maximized_observable renoise.Document.Observable --- ----**READ-ONLY** Where the modulation gets applied (Volume, +---Where the modulation gets applied (Volume, ---Pan, Pitch, Cutoff, Resonance). ----@field target renoise.SampleModulationDevice.TargetType +---@field target renoise.SampleModulationDevice.TargetType **READ-ONLY** --- ---Modulation operator: how the device applies. ---@field operator renoise.SampleModulationDevice.OperatorType @@ -237,10 +237,10 @@ renoise.SampleModulationDevice = { ---@field bipolar boolean ---@field bipolar_observable renoise.Document.Observable --- ----**READ-ONLY** When true, the device has one of more time parameters, +---When true, the device has one of more time parameters, ---which can be switched to operate in synced or unsynced mode. ---- see also field tempo_synced. ----@field tempo_sync_switching_allowed boolean +---see also field tempo_synced. +---@field tempo_sync_switching_allowed boolean **READ-ONLY** --- ---When true and the device supports sync switching the device operates ---in wall-clock (ms) instead of beat times. @@ -248,11 +248,11 @@ renoise.SampleModulationDevice = { ---@field tempo_synced boolean ---@field tempo_synced_observable renoise.Document.Observable --- ----**READ-ONLY** Generic access to all parameters of this device. ----@field is_active_parameter renoise.DeviceParameter +---Generic access to all parameters of this device. +---@field is_active_parameter renoise.DeviceParameter **READ-ONLY** --- ----**READ-ONLY** ----@field parameters renoise.DeviceParameter[] +--- +---@field parameters renoise.DeviceParameter[] **READ-ONLY** ---### functions @@ -416,7 +416,7 @@ renoise.SampleEnvelopeModulationDevice = { ---@class renoise.SampleEnvelopeModulationDevice : renoise.SampleModulationDevice --- ---External editor visibility. ---- set to true to show the editor, false to close it +---set to true to show the editor, false to close it ---@field external_editor_visible boolean --- ---Play mode (interpolation mode). diff --git a/library/renoise/song/pattern.lua b/library/renoise/song/pattern.lua index 036b0ee..0960f20 100644 --- a/library/renoise/song/pattern.lua +++ b/library/renoise/song/pattern.lua @@ -34,9 +34,9 @@ renoise.Pattern.MAX_NUMBER_OF_LINES = 512 ---@field number_of_lines integer ---@field number_of_lines_observable renoise.Document.Observable --- ----**READ-ONLY** Access to the pattern tracks. Each pattern has +---Access to the pattern tracks. Each pattern has ---#renoise.song().tracks amount of tracks. ----@field tracks renoise.PatternTrack[] +---@field tracks renoise.PatternTrack[] **READ-ONLY** ---### functions diff --git a/library/renoise/song/pattern/automation.lua b/library/renoise/song/pattern/automation.lua index 538b170..7f3efed 100644 --- a/library/renoise/song/pattern/automation.lua +++ b/library/renoise/song/pattern/automation.lua @@ -53,9 +53,9 @@ renoise.PatternTrackAutomation = { ---@field playmode renoise.PatternTrackAutomation.Playmode ---@field playmode_observable renoise.Document.Observable --- ----**READ-ONLY** Max length (time in lines) of the automation. +---Max length (time in lines) of the automation. ---Will always fit the patterns length. ----@field length integer Range: (1 - NUM_LINES_IN_PATTERN) +---@field length integer Range: (1 - NUM_LINES_IN_PATTERN) **READ-ONLY** --- ---Selection range as visible in the automation editor. always valid. ---returns the automation range no selection is present in the UI. diff --git a/library/renoise/song/pattern/line.lua b/library/renoise/song/pattern/line.lua index fa10526..dfa1df9 100644 --- a/library/renoise/song/pattern/line.lua +++ b/library/renoise/song/pattern/line.lua @@ -92,12 +92,12 @@ renoise.NoteColumn = {} ---@class renoise.NoteColumn --- ----**READ-ONLY** True, when all note column properties are empty. ----@field is_empty boolean +---True, when all note column properties are empty. +---@field is_empty boolean **READ-ONLY** --- ----**READ-ONLY** True, when this column is selected in the pattern or phrase +---True, when this column is selected in the pattern or phrase ---editors current pattern. ----@field is_selected boolean +---@field is_selected boolean **READ-ONLY** --- ---@field note_value integer Range: (0-119) or 120=Off or 121=Empty ---@field note_string string Range: (\'C-0\'-\'G-9\') or \'OFF\' or \'---\' @@ -165,11 +165,11 @@ renoise.EffectColumn = {} ---@class renoise.EffectColumn --- ----**READ-ONLY** True, when all effect column properties are empty. ----@field is_empty boolean +---True, when all effect column properties are empty. +---@field is_empty boolean **READ-ONLY** --- ----**READ-ONLY** True, when this column is selected in the pattern or phrase editor. ----@field is_selected boolean +---True, when this column is selected in the pattern or phrase editor. +---@field is_selected boolean **READ-ONLY** --- ---0-65535 in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2 ---@field number_value integer diff --git a/library/renoise/song/pattern/track.lua b/library/renoise/song/pattern/track.lua index 7a021fe..538a19b 100644 --- a/library/renoise/song/pattern/track.lua +++ b/library/renoise/song/pattern/track.lua @@ -30,9 +30,9 @@ renoise.PatternTrack = {} ---@field is_empty boolean ---@field is_empty_observable renoise.Document.Observable --- ----**READ-ONLY** Get all lines in range [1, number_of_lines_in_pattern]. +---Get all lines in range [1, number_of_lines_in_pattern]. ---Use `renoise.Pattern:add/remove_line_notifier` for change notifications. ----@field lines renoise.PatternLine[] +---@field lines renoise.PatternLine[] **READ-ONLY** --- ---Automation. ---@field automation renoise.PatternTrackAutomation[] diff --git a/library/renoise/song/track.lua b/library/renoise/song/track.lua index 38acc90..f93bf9c 100644 --- a/library/renoise/song/track.lua +++ b/library/renoise/song/track.lua @@ -48,18 +48,18 @@ renoise.Track = { ---Type, name, color. ---@field type renoise.Track.TrackType **READ-ONLY** ---@field name string Name, as visible in track headers ----@field name_observable renoise.Document.Observable +---@field name_observable renoise.Document.Observable **READ-ONLY** ---@field color RGBColor ----@field color_observable renoise.Document.Observable +---@field color_observable renoise.Document.Observable **READ-ONLY** ---@field color_blend integer Range: (0 - 100) Color blend in percent ----@field color_blend_observable renoise.Document.Observable +---@field color_blend_observable renoise.Document.Observable **READ-ONLY** --- ---Mute and solo states. Not available for the master track. ---@field mute_state renoise.Track.MuteState ----@field mute_state_observable renoise.Document.Observable +---@field mute_state_observable renoise.Document.Observable **READ-ONLY** --- ---@field solo_state boolean ----@field solo_state_observable renoise.Document.Observable +---@field solo_state_observable renoise.Document.Observable **READ-ONLY** --- ---Volume, panning, width. ---@field prefx_volume renoise.DeviceParameter **READ-ONLY** @@ -71,7 +71,7 @@ renoise.Track = { --- ---Collapsed/expanded visual appearance. ---@field collapsed boolean ----@field collapsed_observable renoise.Document.Observable +---@field collapsed_observable renoise.Document.Observable **READ-ONLY** --- ---Returns most immediate group parent or nil if not in a group. ---@field group_parent renoise.GroupTrack? **READ-ONLY** @@ -79,11 +79,11 @@ renoise.Track = { ---Output routing. ---@field available_output_routings string[] **READ-ONLY** ---@field output_routing string One of `available_output_routings` ----@field output_routing_observable renoise.Document.Observable +---@field output_routing_observable renoise.Document.Observable **READ-ONLY** --- ---Delay. ---@field output_delay number Range: (-100.0-100.0) in ms ----@field output_delay_observable renoise.Document.Observable +---@field output_delay_observable renoise.Document.Observable **READ-ONLY** --- ---Pattern editor columns. ---@field max_effect_columns integer **READ-ONLY** 8 OR 0 depending on the track type @@ -93,26 +93,27 @@ renoise.Track = { ---@field min_note_columns integer **READ-ONLY** 1 OR 0 depending on the track type --- ---@field visible_effect_columns integer 1-8 OR 0-8, depending on the track type ----@field visible_effect_columns_observable renoise.Document.Observable +---@field visible_effect_columns_observable renoise.Document.Observable **READ-ONLY** ---@field visible_note_columns integer 0 OR 1-12, depending on the track type ----@field visible_note_columns_observable renoise.Document.Observable +---@field visible_note_columns_observable renoise.Document.Observable **READ-ONLY** --- ---@field volume_column_visible boolean ----@field volume_column_visible_observable renoise.Document.Observable +---@field volume_column_visible_observable renoise.Document.Observable **READ-ONLY** ---@field panning_column_visible boolean ----@field panning_column_visible_observable renoise.Document.Observable +---@field panning_column_visible_observable renoise.Document.Observable **READ-ONLY** ---@field delay_column_visible boolean ----@field delay_column_visible_observable renoise.Document.Observable +---@field delay_column_visible_observable renoise.Document.Observable **READ-ONLY** ---@field sample_effects_column_visible boolean ----@field sample_effects_column_visible_observable renoise.Document.Observable +---@field sample_effects_column_visible_observable renoise.Document.Observable **READ-ONLY** --- ----Devices. ----@field available_devices string[] **READ-ONLY** FX devices this track can handle. ----**READ-ONLY** Array of tables containing information about the devices. ----@field available_device_infos AudioDeviceInfo[] +---The FX devices this track can handle. +---@field available_devices string[] **READ-ONLY** +---Array of tables containing information about the devices. +---@field available_device_infos AudioDeviceInfo[] **READ-ONLY** --- ----@field devices renoise.AudioDevice[] **READ-ONLY** List of audio DSP FX. ----@field devices_observable renoise.Document.ObservableList +---List of audio DSP FX. +---@field devices renoise.AudioDevice[] **READ-ONLY** +---@field devices_observable renoise.Document.ObservableList **READ-ONLY** ---### functions @@ -190,13 +191,11 @@ renoise.GroupTrack = {} ---### properties ---Group track component of a Renoise song. ----@class renoise.GroupTrack : renoise.Track ---- ----**READ-ONLY** All member tracks of this group, including subgroups and ----their tracks. ----@field members renoise.Track[] ---- ----Collapsed/expanded visual appearance of whole group. +---All member tracks of this group, including subgroups +---and their tracks. +---@class renoise.GroupTrack +---@field members renoise.Track[] **READ-ONLY** +---Collapsed/expanded visual appearce of whole group. ---@field group_collapsed boolean diff --git a/library/renoise/sqlite.lua b/library/renoise/sqlite.lua index 5575963..0447bf2 100644 --- a/library/renoise/sqlite.lua +++ b/library/renoise/sqlite.lua @@ -19,8 +19,8 @@ error("Do not try to execute this file. It's just a type definition file.") --- ---@class SQLite --- ----**READ-ONLY** SQLite version information, in the form `x.y[.z[.p]]`. ----@field version string +---SQLite version information, in the form `x.y[.z[.p]]`. +---@field version string **READ-ONLY** renoise.SQLite = {} ---### constants @@ -100,31 +100,31 @@ function renoise.SQLite.open(filename, flags) end ---@class SQLiteDatabase : userdata --- ----**READ-ONLY** Whether or not the database is open. ----@field is_open boolean ----**READ-ONLY** Whether or not the database is closed. ----@field is_closed boolean +---Whether or not the database is open. +---@field is_open boolean **READ-ONLY** +---Whether or not the database is closed. +---@field is_closed boolean **READ-ONLY** --- ----**READ-ONLY** The most recent error code. ----@field error_code renoise.SQLite.Status ----**READ-ONLY** The most recent error message. ----@field error_message string +---The most recent error code. +---@field error_code renoise.SQLite.Status **READ-ONLY** +---The most recent error message. +---@field error_message string **READ-ONLY** --- ----**READ-ONLY** Number of database rows that were changed, inserted, or deleted by +---Number of database rows that were changed, inserted, or deleted by ---the most recent SQL statement. ---Only changes that are directly specified by INSERT, UPDATE, or DELETE statements ---are counted. ---Auxiliary changes caused by triggers are not counted. Use `db.total_changes` ---to find the total number of changes. ----@field changes integer ----**READ-ONLY** The number of database rows that have been modified by INSERT, +---@field changes integer **READ-ONLY** +---The number of database rows that have been modified by INSERT, ---UPDATE or DELETE statements since the database was opened. ---This includes UPDATE, INSERT and DELETE statements executed as part of ---trigger programs. All changes are counted as soon as the statement that ---produces them is completed by calling either `stmt:reset()` or `stmt:finalize()`. ----@field total_changes integer +---@field total_changes integer **READ-ONLY** --- ----**READ-ONLY** Gets the rowid of the most recent INSERT into the database. +---Gets the rowid of the most recent INSERT into the database. ---If no inserts have ever occurred, 0 is returned. ---(Each row in an SQLite table has a unique 64-bit signed integer ---key called the 'rowid'. This id is always available as an undeclared @@ -135,7 +135,7 @@ function renoise.SQLite.open(filename, flags) end ---If an INSERT occurs within a trigger, then the rowid of the inserted ---row is returned as long as the trigger is running. Once the trigger terminates, ---the value returned reverts to the last value inserted before the trigger fired. ----@field last_insert_rowid integer +---@field last_insert_rowid integer **READ-ONLY** local SQLiteDatabase = {} --- Closes a database. All SQL statements prepared using `db:prepare()` should @@ -282,45 +282,45 @@ function SQLiteDatabase:urows(sql) end ---Precompiled SQLite statements, as created with `db:prepare()`. ---@class SQLiteStatement: userdata --- ----**READ-ONLY** Whether or not the statement hasn't been finalized. ----@field is_open boolean ----**READ-ONLY** Whether or not the statement has been finalized. ----@field is_closed boolean +---Whether or not the statement hasn't been finalized. +---@field is_open boolean **READ-ONLY** +---Whether or not the statement has been finalized. +---@field is_closed boolean **READ-ONLY** --- ----**READ-ONLY** Number of columns in the result set returned by the statement, +---Number of columns in the result set returned by the statement, ---or 0 if the statement does not return data (for example an UPDATE). ----@field columns integer +---@field columns integer **READ-ONLY** --- ----**READ-ONLY** rowid of the most recent INSERT into the database corresponding +---rowid of the most recent INSERT into the database corresponding ---to this statement. ----@field last_insert_rowid integer +---@field last_insert_rowid integer **READ-ONLY** --- ----**READ-ONLY** A table with the names and types of all columns in the current +---A table with the names and types of all columns in the current ---result set of the statement. ----@field named_types table ----**READ-ONLY** A table with names and values of all columns in the current +---@field named_types table **READ-ONLY** +---A table with names and values of all columns in the current ---result row of a query. ----@field named_values table +---@field named_values table **READ-ONLY** --- ----**READ-ONLY** A list of the names of all columns in the result set returned +---A list of the names of all columns in the result set returned ---by the statement. ----@field names string[] ----**READ-ONLY** A list of the values of all columns in the result set +---@field names string[] **READ-ONLY** +---A list of the values of all columns in the result set ---returned by the statement. ----@field values SQLiteValue[] ----**READ-ONLY** A list of the types of all columns in the result set returned +---@field values SQLiteValue[] **READ-ONLY** +---A list of the types of all columns in the result set returned ---by the statement. ----@field types string[] +---@field types string[] **READ-ONLY** --- ----**READ-ONLY** A list of the names of all columns in the result set returned +---A list of the names of all columns in the result set returned ---by the statement. ----@field unames string[] ----**READ-ONLY** A list of the types of all columns in the result set returned +---@field unames string[] **READ-ONLY** +---A list of the types of all columns in the result set returned ---by the statement. ----@field utypes string[] ----**READ-ONLY** A list of the values of all columns in the current result +---@field utypes string[] **READ-ONLY** +---A list of the values of all columns in the current result ---row of a query. ----@field uvalues SQLiteValue[] +---@field uvalues SQLiteValue[] **READ-ONLY** local SQLiteStatement = {} ---### functions diff --git a/library/renoise/tool.lua b/library/renoise/tool.lua index ba5f900..2b414f5 100644 --- a/library/renoise/tool.lua +++ b/library/renoise/tool.lua @@ -18,8 +18,8 @@ error("Do not try to execute this file. It's just a type definition file.") ---attaching it to some common tool related notifiers. ---@class renoise.ScriptingTool --- ----**READ_ONLY** Full absolute path and name to your tool's bundle directory. ----@field bundle_path string +---Full absolute path and name to your tool's bundle directory. +---@field bundle_path string **READ_ONLY** --- ---Invoked when the tool finished loading/initializing and no errors happened. ---When the tool has preferences, they are loaded here as well when the diff --git a/library/renoise/views/canvas.lua b/library/renoise/views/canvas.lua index daa6bba..97e58ed 100644 --- a/library/renoise/views/canvas.lua +++ b/library/renoise/views/canvas.lua @@ -93,16 +93,15 @@ function Canvas:update() end --- [HTML5 Canvas Documentation](https://www.w3schools.com/tags/ref_canvas.asp) ---@class renoise.Views.Canvas.Context --- ----**READ_ONLY** Size of the render context backend **in raw pixel resolution**. +---Size of the render context backend **in raw pixel resolution**. ---This is the view ports size, multiplied with the global UI scaling factor. ---It does not change with transformations. ----@field pixel_size { width: integer, height: integer } +---@field pixel_size { width: integer, height: integer } **READ-ONLY** --- ----**READ_ONLY** Size of the render context **with transformations applied**. +---Size of the render context **with transformations applied**. ---This initially will be the view's size. Calls to `transform` or `scale` ---may change the size further. ----@field size { width: integer, height: integer } ---- +---@field size { width: integer, height: integer } **READ_ONLY** ---The degree of opacity applied to all drawing operations.
--- ---If an operation already uses a transparent color, this can make it diff --git a/library/renoise/views/multiline_text.lua b/library/renoise/views/multiline_text.lua index 138c6bf..ff08278 100644 --- a/library/renoise/views/multiline_text.lua +++ b/library/renoise/views/multiline_text.lua @@ -8,7 +8,7 @@ error("Do not try to execute this file. It's just a type definition file.") -------------------------------------------------------------------------------- ----**READ-ONLY** The currently selected text, if any. +---The currently selected text, if any. ---Newlines (Windows, Mac or Unix styled) will use the unix newline format. ---@alias TextMultilineSelectedString string @@ -47,7 +47,7 @@ error("Do not try to execute this file. It's just a type definition file.") ---``` ---@class renoise.Views.MultiLineText : renoise.Views.View ---@field text TextMultilineString ----@field selected_text TextMultilineSelectedString +---@field selected_text TextMultilineSelectedString **READ-ONLY** ---@field paragraphs TextParagraphs ---@field font TextFontStyle ---@field style TextBackgroundStyle Default: "body" diff --git a/library/renoise/views/view.lua b/library/renoise/views/view.lua index d54fdf4..b884ad2 100644 --- a/library/renoise/views/view.lua +++ b/library/renoise/views/view.lua @@ -176,9 +176,9 @@ error("Do not try to execute this file. It's just a type definition file.") ---@field size ViewSize ---@field tooltip ViewTooltip ---@field cursor ViewCursorShape ----**READ-ONLY** Empty for all controls, for layout views this contains the +---Empty for all controls, for layout views this contains the ---layout child views in the order they got added ----@field views renoise.Views.View[] +---@field views renoise.Views.View[] **READ-ONLY** local View = {} ---### functions From 32c1dcd8c338118672613496678a594b272daf0b Mon Sep 17 00:00:00 2001 From: unlessgames Date: Fri, 18 Sep 2026 14:26:35 +0200 Subject: [PATCH 3/5] move read-only tag to end of descriptions --- library/renoise/application.lua | 45 ++++--- library/renoise/application/theme.lua | 15 ++- library/renoise/application/window.lua | 6 +- library/renoise/osc.lua | 18 ++- library/renoise/socket.lua | 18 ++- library/renoise/song.lua | 88 ++++++++----- library/renoise/song/device.lua | 33 +++-- library/renoise/song/instrument.lua | 41 +++--- library/renoise/song/instrument/macro.lua | 6 +- library/renoise/song/instrument/phrase.lua | 31 +++-- .../renoise/song/instrument/phrase_script.lua | 21 ++-- library/renoise/song/instrument/plugin.lua | 37 ++++-- library/renoise/song/instrument/sample.lua | 40 +++--- .../song/instrument/sample_device_chain.lua | 12 +- .../song/instrument/sample_modulation.lua | 118 +++++++++++------- library/renoise/song/pattern.lua | 7 +- library/renoise/song/pattern/automation.lua | 20 +-- library/renoise/song/pattern/line.lua | 18 ++- library/renoise/song/pattern/track.lua | 6 +- library/renoise/song/track.lua | 56 +++++---- library/renoise/song/transport.lua | 74 +++++------ library/renoise/sqlite.lua | 60 ++++++--- library/renoise/views/canvas.lua | 6 +- library/renoise/views/view.lua | 17 +-- 24 files changed, 488 insertions(+), 305 deletions(-) diff --git a/library/renoise/application.lua b/library/renoise/application.lua index 6a1de63..f117f08 100644 --- a/library/renoise/application.lua +++ b/library/renoise/application.lua @@ -20,46 +20,58 @@ renoise.Application = {} ---Access to the application's full log filename and path. Will ---already be opened for writing, but you nevertheless should be able to read ---from it. ----@field log_filename string **READ-ONLY** +---**READ-ONLY** +---@field log_filename string --- ---Get the apps main document, the song. ---The global "renoise.song()" function is, in fact, a shortcut to this property. ----@field current_song renoise.Song? **READ-ONLY** +---**READ-ONLY** +---@field current_song renoise.Song? --- ---List of recently loaded song files. ----@field recently_loaded_song_files string[] **READ-ONLY** +---**READ-ONLY** +---@field recently_loaded_song_files string[] ---List of recently saved song files. ----@field recently_saved_song_files string[] **READ-ONLY** +---**READ-ONLY** +---@field recently_saved_song_files string[] --- ---Returns information about all currently installed tools. ----@field installed_tools table **READ-ONLY** +---**READ-ONLY** +---@field installed_tools table ---Fired when the list of installed tools changed. ----@field installed_tools_observable renoise.Document.Observable **READ-ONLY** +---**READ-ONLY** +---@field installed_tools_observable renoise.Document.Observable --- ---Fired when the list of available audio plugin effects changed, for example ---when scanning for new plugins in the preferences. ---Use the component's `available_plugins` or `available_devices` properties ---to access currently available devices which are supported by the component ---such as the track device chains. ----@field audio_plugin_effects_observable renoise.Document.Observable **READ-ONLY** +---**READ-ONLY** +---@field audio_plugin_effects_observable renoise.Document.Observable ---Fired when the list of available audio plugin instruments changed, for example ---when scanning for new plugins in the preferences. ----@field audio_plugin_instruments_observable renoise.Document.Observable **READ-ONLY** +---**READ-ONLY** +---@field audio_plugin_instruments_observable renoise.Document.Observable --- ---**Deprecated.** **READ-ONLY** Use `key_modifier_flags` instead ---@deprecated ---@field key_modifier_states table ---Access keyboard modifier states. ----@field key_modifier_flags ModifierFlags **READ-ONLY** +---**READ-ONLY** +---@field key_modifier_flags ModifierFlags --- ---Access to the application's window. ----@field window renoise.ApplicationWindow **READ-ONLY** +---**READ-ONLY** +---@field window renoise.ApplicationWindow --- ---Access to the application's color theme. ----@field theme renoise.ApplicationTheme **READ-ONLY** +---**READ-ONLY** +---@field theme renoise.ApplicationTheme ---Fired, when *any* theme color changed. e.g. when a new theme got loaded ---or when theme colors got edited in the theme preferences. ----@field theme_observable renoise.Document.Observable **READ-ONLY** +---**READ-ONLY** +---@field theme_observable renoise.Document.Observable --- ---Range: (1 - 4) Get or set globally used clipboard "slots" in the application. ---@field active_clipboard_index 1|2|3|4 @@ -120,7 +132,8 @@ function renoise.Application:show_prompt(title, message, button_labels) end ---@deprecated **READ-ONLY** ---@field modifiers ModifierStates ---the held down modifiers as flags ----@field modifier_flags ModifierFlags **READ-ONLY** +---**READ-ONLY** +---@field modifier_flags ModifierFlags ---possible character representation of the key ---@field character string? ---virtual keyboard piano key value (starting from 0) @@ -424,9 +437,11 @@ function renoise.Application:save_theme(filename) end ---@class renoise.Dialog --- ---Check if a dialog is alive and visible. ----@field visible boolean **READ-ONLY** +---**READ-ONLY** +---@field visible boolean ---Check if a dialog is visible and is the key window. ----@field focused boolean **READ-ONLY** +---**READ-ONLY** +---@field focused boolean renoise.Dialog = {} ---### functions diff --git a/library/renoise/application/theme.lua b/library/renoise/application/theme.lua index 1695e1a..9e68719 100644 --- a/library/renoise/application/theme.lua +++ b/library/renoise/application/theme.lua @@ -135,22 +135,27 @@ renoise.ApplicationTheme = {} ---use `renoise.app().theme.color(color_name)` instead. --- ---To get notified of color changes, use `renoise.app().theme_observable` ----@field colors { [ThemeColor]: RGBColor } **READ-ONLY** +---**READ-ONLY** +---@field colors { [ThemeColor]: RGBColor } --- ---Get theme's knob shade setting. Range: (1 - 2) ----@field knob_shade number **READ-ONLY** +---**READ-ONLY** +---@field knob_shade number ---@field knob_shade_observable renoise.Document.Observable **READ-ONLY** --- ---Get theme's body shade setting. Range: (1 - 2) ----@field body_shade number **READ-ONLY** +---**READ-ONLY** +---@field body_shade number ---@field body_shade_observable renoise.Document.Observable **READ-ONLY** --- ---Get theme's contrast setting. Range: (-0.5 - 0.5) ----@field contrast number **READ-ONLY** +---**READ-ONLY** +---@field contrast number ---@field contrast_observable renoise.Document.Observable **READ-ONLY** --- ---Get theme's texture set name ----@field texture_set string **READ-ONLY** +---**READ-ONLY** +---@field texture_set string ---@field texture_set_observable renoise.Document.Observable **READ-ONLY** --- ---### functions diff --git a/library/renoise/application/window.lua b/library/renoise/application/window.lua index 186fe5e..ebe468a 100644 --- a/library/renoise/application/window.lua +++ b/library/renoise/application/window.lua @@ -77,10 +77,12 @@ renoise.ApplicationWindow = { ---@field fullscreen boolean --- ---Window status flag. ----@field is_maximized boolean **READ-ONLY** +---**READ-ONLY** +---@field is_maximized boolean --- ---Window status flag. ----@field is_minimized boolean **READ-ONLY** +---**READ-ONLY** +---@field is_minimized boolean --- ---When true, the middle frame views (like the pattern editor) will ---stay focused unless alt or middle mouse is clicked. diff --git a/library/renoise/osc.lua b/library/renoise/osc.lua index d0119bf..f6e42f7 100644 --- a/library/renoise/osc.lua +++ b/library/renoise/osc.lua @@ -34,15 +34,18 @@ function renoise.Osc.from_binary_data(binary_data) end ---@class renoise.Osc.Message --- ---The message pattern (e.g. "/renoise/transport/start") ----@field pattern string **READ-ONLY** +---**READ-ONLY** +---@field pattern string --- ---Table of `{tag="X", value=SomeValue}` that represents the ---message arguments. See `renoise.Osc.Message.create` for more info. ----@field arguments OscValue[] **READ-ONLY** +---**READ-ONLY** +---@field arguments OscValue[] --- ---Raw binary representation of the message, as needed when e.g. ---sending the message over the network through sockets. ----@field binary_data string **READ-ONLY** +---**READ-ONLY** +---@field binary_data string renoise.Osc.Message = {} ---### functions @@ -88,13 +91,16 @@ function renoise.Osc.Message(pattern, arguments) end ---@class renoise.Osc.Bundle --- ---Time value of the bundle. ----@field timetag number **READ-ONLY** +---**READ-ONLY** +---@field timetag number --- ---Access to the bundle elements (table of messages or bundles) ----@field elements (renoise.Osc.Message|renoise.Osc.Bundle)[] **READ-ONLY** +---**READ-ONLY** +---@field elements (renoise.Osc.Message|renoise.Osc.Bundle)[] --- --- **READ-ONLY** Raw binary representation of the bundle, as needed when e.g. +---Raw binary representation of the bundle, as needed when e.g. ---sending the message over the network through sockets. +---**READ-ONLY** ---@field binary_data string renoise.Osc.Bundle = {} diff --git a/library/renoise/socket.lua b/library/renoise/socket.lua index 0d234b7..49bed14 100644 --- a/library/renoise/socket.lua +++ b/library/renoise/socket.lua @@ -84,14 +84,17 @@ function renoise.Socket.create_client(server_address, server_port, protocol, tim ---Sockets can manually be closed (see socket:close()). Client sockets can also ---actively be closed/refused by the server. In this case the client:receive() ---calls will fail and return an error. ----@field is_open boolean **READ-ONLY** +---**READ-ONLY** +---@field is_open boolean --- ---The socket's resolved local address (for example "127.0.0.1" ---when a socket is bound to "localhost") ----@field local_address string **READ-ONLY** +---**READ-ONLY** +---@field local_address string --- ---The socket's local port number, as specified when instantiated. ----@field local_port integer **READ-ONLY** +---**READ-ONLY** +---@field local_port integer renoise.Socket.SocketBase = {} ---### functions @@ -122,11 +125,13 @@ function renoise.Socket.SocketBase:close() end --- ---Address of the socket's peer, the socket address this client ---is connected to. ----@field peer_address string **READ-ONLY** +---**READ-ONLY** +---@field peer_address string --- ---Port of the socket's peer, the socket this client is ---connected to. ----@field peer_port integer **READ-ONLY** +---**READ-ONLY** +---@field peer_port integer renoise.Socket.SocketClient = {} ---### functions @@ -193,7 +198,8 @@ function renoise.Socket.SocketClient:receive(mode, timeout_ms) end ---@class renoise.Socket.SocketServer : renoise.Socket.SocketBase --- ---true while the server is running, else false. ----@field is_running boolean **READ-ONLY** +---**READ-ONLY** +---@field is_running boolean renoise.Socket.SocketServer = {} diff --git a/library/renoise/song.lua b/library/renoise/song.lua index 6e1595e..38ec44c 100644 --- a/library/renoise/song.lua +++ b/library/renoise/song.lua @@ -71,7 +71,8 @@ renoise.Song = { --- ---When the song is loaded from or saved to a file, the absolute ---path and name to the XRNS file, otherwise an empty string. ----@field file_name string **READ-ONLY** +---**READ-ONLY** +---@field file_name string --- ---Song Comments ---@field artist string @@ -85,7 +86,8 @@ renoise.Song = { ---@field comments string[] ---@field comments_observable renoise.Document.ObservableList **READ-ONLY** ---Notifier is called as soon as any paragraph in the comments change. ----@field comments_assignment_observable renoise.Document.Observable **READ-ONLY** +---**READ-ONLY** +---@field comments_assignment_observable renoise.Document.Observable ---Set this to true to show the comments dialog after loading a song ---@field show_comments_after_loading boolean ---@field show_comments_after_loading_observable renoise.Document.Observable **READ-ONLY** @@ -105,10 +107,13 @@ renoise.Song = { --- ---True while rendering is in progress. ---@see renoise.Song.render ----@field rendering boolean **READ-ONLY** +---**READ-ONLY** +---@field rendering boolean ---The current render progress amount ---@see renoise.Song.render ----@field rendering_progress number Range: (0.0 - 1.0) **READ-ONLY** +---Range: (0.0 - 1.0) +---**READ-ONLY** +---@field rendering_progress number --- --- ---@field transport renoise.Transport **READ-ONLY** @@ -120,22 +125,28 @@ renoise.Song = { ---@field pattern_iterator renoise.PatternIterator **READ-ONLY** --- ---number of normal playback tracks (non-master or sends) in song. ----@field sequencer_track_count integer **READ-ONLY** +---**READ-ONLY** +---@field sequencer_track_count integer ---number of send tracks in song. ----@field send_track_count integer **READ-ONLY** +---**READ-ONLY** +---@field send_track_count integer --- ---Instrument arrays ----@field instruments renoise.Instrument[] **READ-ONLY** +---**READ-ONLY** +---@field instruments renoise.Instrument[] ---@field instruments_observable renoise.Document.ObservableList **READ-ONLY** ---Pattern arrays ----@field patterns renoise.Pattern[] **READ-ONLY** +---**READ-ONLY** +---@field patterns renoise.Pattern[] ---@field patterns_observable renoise.Document.ObservableList **READ-ONLY** ---Track array ----@field tracks renoise.Track[] **READ-ONLY** +---**READ-ONLY** +---@field tracks renoise.Track[] ---@field tracks_observable renoise.Document.ObservableList **READ-ONLY** --- ---Selected in the instrument box. ----@field selected_instrument renoise.Instrument **READ-ONLY** +---**READ-ONLY** +---@field selected_instrument renoise.Instrument ---@field selected_instrument_observable renoise.Document.Observable **READ-ONLY** ---Selected instrument index in the instrument box. ---Note, Renoise displays zero-based indices here @@ -144,46 +155,53 @@ renoise.Song = { ---@field selected_instrument_index_observable renoise.Document.Observable **READ-ONLY** --- ---Selected phrase the instrument's phrase map piano view. ----@field selected_phrase renoise.InstrumentPhrase? **READ-ONLY** +---**READ-ONLY** +---@field selected_phrase renoise.InstrumentPhrase? ---@field selected_phrase_observable renoise.Document.Observable **READ-ONLY** ---Selected phrase index the instrument's phrase map piano view. ---@field selected_phrase_index integer --- ---Selected in the instrument's sample list. ---Only nil when no samples are present in the selected instrument. ----@field selected_sample renoise.Sample? **READ-ONLY** +---**READ-ONLY** +---@field selected_sample renoise.Sample? ---@field selected_sample_observable renoise.Document.Observable **READ-ONLY** ---Selected sample index in the instrument's sample list. ---Only 0 when no samples are present in the selected instrument. ---@field selected_sample_index integer --- ---Selected in the instrument's modulation view. ----@field selected_sample_modulation_set renoise.SampleModulationSet? **READ-ONLY** +---**READ-ONLY** +---@field selected_sample_modulation_set renoise.SampleModulationSet? ---@field selected_sample_modulation_set_observable renoise.Document.Observable **READ-ONLY** ---Selected modulation set index in the instrument's modulation view. ---@field selected_sample_modulation_set_index integer --- ---Selected in the instrument's effects view. ----@field selected_sample_device_chain renoise.SampleDeviceChain? **READ-ONLY** +---**READ-ONLY** +---@field selected_sample_device_chain renoise.SampleDeviceChain? ---@field selected_sample_device_chain_observable renoise.Document.Observable **READ-ONLY** ---Selected chain index in the instrument's effects view. ---@field selected_sample_device_chain_index integer --- ---Selected in the sample effect mixer. ----@field selected_sample_device renoise.AudioDevice? **READ-ONLY** +---**READ-ONLY** +---@field selected_sample_device renoise.AudioDevice? ---@field selected_sample_device_observable renoise.Document.Observable **READ-ONLY** ---Selected device index in the sample effect mixer. ---@field selected_sample_device_index integer --- ---Selected in the pattern editor or mixer. ----@field selected_track renoise.Track **READ-ONLY** +---**READ-ONLY** +---@field selected_track renoise.Track ---@field selected_track_observable renoise.Document.Observable **READ-ONLY** ---Selected track index in the pattern editor or mixer. ---@field selected_track_index integer ---@field selected_track_index_observable renoise.Document.Observable **READ-ONLY** --- ---Selected in the track DSP chain editor. ----@field selected_track_device renoise.AudioDevice? **READ-ONLY** +---**READ-ONLY** +---@field selected_track_device renoise.AudioDevice? ---@field selected_track_device_observable renoise.Document.Observable **READ-ONLY** ---Selected device index in the track DSP chain editor. ---@field selected_track_device_index integer @@ -205,14 +223,17 @@ renoise.Song = { ---Selected parameter in the automation editor. ---When setting a new parameter, parameter must be automateable and ---must be one of the currently selected track device chain. ----@field selected_automation_parameter renoise.DeviceParameter? **READ-ONLY** +---**READ-ONLY** +---@field selected_automation_parameter renoise.DeviceParameter? ---@field selected_automation_parameter_observable renoise.Document.Observable **READ-ONLY** ---Parent device of 'selected_automation_parameter'. ----@field selected_automation_device renoise.AudioDevice? **READ-ONLY** +---**READ-ONLY** +---@field selected_automation_device renoise.AudioDevice? ---@field selected_automation_device_observable renoise.Document.Observable **READ-ONLY** --- ---The currently edited pattern. ----@field selected_pattern renoise.Pattern **READ-ONLY** +---**READ-ONLY** +---@field selected_pattern renoise.Pattern ---@field selected_pattern_observable renoise.Document.Observable **READ-ONLY** ---The currently edited pattern index. ---@field selected_pattern_index integer @@ -220,7 +241,8 @@ renoise.Song = { --- ---The currently edited pattern track object. ---and selected_track_observable for notifications. ----@field selected_pattern_track renoise.PatternTrack **READ-ONLY** +---**READ-ONLY** +---@field selected_pattern_track renoise.PatternTrack ---@field selected_pattern_track_observable renoise.Document.Observable **READ-ONLY** --- ---The currently edited sequence position. @@ -228,19 +250,23 @@ renoise.Song = { ---@field selected_sequence_index_observable renoise.Document.Observable **READ-ONLY** --- ---The currently edited line in the edited pattern. ----@field selected_line renoise.PatternLine **READ-ONLY** +---**READ-ONLY** +---@field selected_line renoise.PatternLine ---@field selected_line_index integer ---The currently edited column in the selected line in the edited ---sequence/pattern. Nil when an effect column is selected. ----@field selected_note_column renoise.NoteColumn? **READ-ONLY** +---**READ-ONLY** +---@field selected_note_column renoise.NoteColumn? ---@field selected_note_column_index integer ---The currently edited column in the selected line in the edited ---sequence/pattern. Nil when a note column is selected. ----@field selected_effect_column renoise.EffectColumn? **READ-ONLY** +---**READ-ONLY** +---@field selected_effect_column renoise.EffectColumn? ---@field selected_effect_column_index integer ---The currently edited sub column type within the selected ---note/effect column. ----@field selected_sub_column_type renoise.Song.SubColumnType **READ-ONLY** +---**READ-ONLY** +---@field selected_sub_column_type renoise.Song.SubColumnType --- ---Read/write access to the selection in the pattern editor. --- @@ -267,25 +293,29 @@ renoise.Song = { --- ---The currently edited line in the currently edited phrase. ---Nil when no phrase is selected. ----@field selected_phrase_line renoise.PatternLine? **READ-ONLY** +---**READ-ONLY** +---@field selected_phrase_line renoise.PatternLine? ---The currently edited line index in the currently edited phrase. ---0 when no phrase is selected. ---@field selected_phrase_line_index integer ---The currently edited column in the selected line in the currently ---edited phrase. Nil when no phrase is selected or when an effect column is selected. ----@field selected_phrase_note_column renoise.NoteColumn? **READ-ONLY** +---**READ-ONLY** +---@field selected_phrase_note_column renoise.NoteColumn? ---The currently edited column index in the selected line in the currently edited ---phrase. 0 when no phrase is selected or when an effect column is selected. ---@field selected_phrase_note_column_index integer ---The currently edited column in the selected line in the currently ---edited phrase. Nil when no phrase is selected or when a note column is selected. ----@field selected_phrase_effect_column renoise.EffectColumn? **READ-ONLY** +---**READ-ONLY** +---@field selected_phrase_effect_column renoise.EffectColumn? ---The currently edited effect column index in the selected line in the currently ---edited phrase. 0 when no phrase is selected or when a note column is selected. ---@field selected_phrase_effect_column_index integer ---The currently edited sub column type within the selected ---note/effect column in the current phrase. 0 when no phrase is selected. ----@field selected_phrase_sub_column_type renoise.Song.SubColumnType **READ-ONLY** +---**READ-ONLY** +---@field selected_phrase_sub_column_type renoise.Song.SubColumnType --- ---Same as `selection_in_pattern` but for the currently selected phrase (if any). ---@field selection_in_phrase PhraseSelection? diff --git a/library/renoise/song/device.lua b/library/renoise/song/device.lua index 2e222f0..47fc481 100644 --- a/library/renoise/song/device.lua +++ b/library/renoise/song/device.lua @@ -18,7 +18,8 @@ renoise.AudioDevice = {} ---@class renoise.AudioDevice --- ---Fixed name of the device. ----@field name string **READ-ONLY** +---**READ-ONLY** +---@field name string ---@field short_name string **READ-ONLY** --- ---Configurable device display name. When empty `name` is displayed. @@ -38,15 +39,17 @@ renoise.AudioDevice = {} ---@field active_preset_observable renoise.Document.Observable **READ-ONLY** ---@field active_preset_data string raw serialized data in XML format of the active preset ---The names of existing presets ----@field presets string[] **READ-ONLY** +---**READ-ONLY** +---@field presets string[] --- ----Parameters. ---@field is_active_parameter renoise.DeviceParameter **READ-ONLY** +---Parameters. ---@field parameters renoise.DeviceParameter[] **READ-ONLY** --- ---Returns whether or not the device provides its own custom GUI ---(only available for some plugin devices) ----@field external_editor_available boolean **READ-ONLY** +---**READ-ONLY** +---@field external_editor_available boolean --- ---When the device has no custom GUI an error will be fired (see ---external_editor_available), otherwise the external editor is opened/closed. @@ -55,7 +58,8 @@ renoise.AudioDevice = {} ---Returns a string that uniquely identifies the device, from ---`available_devices`. The string can be passed into: ---`renoise.song().tracks[]:insert_device_at()` ----@field device_path string **READ-ONLY** +---**READ-ONLY** +---@field device_path string ---### functions @@ -93,10 +97,12 @@ renoise.DeviceParameter = { ---@class renoise.DeviceParameter --- ---Device parameters. ----@field name string **READ-ONLY** +---**READ-ONLY** +---@field name string ---@field name_observable renoise.Document.ObservableString **READ-ONLY** -- ----@field polarity renoise.DeviceParameter.Polarity **READ-ONLY** +---**READ-ONLY** +---@field polarity renoise.DeviceParameter.Polarity --- ---@field value_min number **READ-ONLY** ---@field value_max number **READ-ONLY** @@ -106,26 +112,29 @@ renoise.DeviceParameter = { ---The minimum interval in pattern lines (as a number) at which a parameter can ---have automation points. It is 1/256 for most parameters, but 1 for e.g. song ---tempo, LPB and TPL which can only be automated once per pattern line. ----@field time_quantum number **READ-ONLY** +---**READ-ONLY** +---@field time_quantum number --- ---Not valid for parameters of instrument devices. Returns true if creating ---envelope automation is possible for the parameter (see also ---renoise.song().patterns[].tracks[]:create_automation) ----@field is_automatable boolean **READ-ONLY** +---**READ-ONLY** +---@field is_automatable boolean --- ---Is automated. Not valid for parameters of instrument devices. ----@field is_automated boolean **READ-ONLY** +---**READ-ONLY** +---@field is_automated boolean ---@field is_automated_observable renoise.Document.Observable **READ-ONLY** --- ---Parameter has a custom MIDI mapping in the current song. ----@field is_midi_mapped boolean **READ-ONLY** +---**READ-ONLY** +---@field is_midi_mapped boolean ---@field is_midi_mapped_observable renoise.Document.Observable **READ-ONLY** --- ---Show in mixer. Not valid for parameters of instrument devices. ---@field show_in_mixer boolean ---@field show_in_mixer_observable renoise.Document.Observable **READ-ONLY** --- ----Values. ---@field value number value in Range: (value_min - value_max) ---@field value_observable renoise.Document.Observable **READ-ONLY** --- diff --git a/library/renoise/song/instrument.lua b/library/renoise/song/instrument.lua index c71d329..65ee772 100644 --- a/library/renoise/song/instrument.lua +++ b/library/renoise/song/instrument.lua @@ -79,7 +79,8 @@ renoise.Instrument = { ---@field macros_visible_observable renoise.Document.Observable --- ---Macro parameters. Array with size Instrument.NUMBER_OF_MACROS. ----@field macros renoise.InstrumentMacro[] **READ-ONLY** +---**READ-ONLY** +---@field macros renoise.InstrumentMacro[] --- ---Access the MIDI pitch-bend macro ---@field pitchbend_macro renoise.InstrumentMacro @@ -92,7 +93,8 @@ renoise.Instrument = { --- ---Global linear volume of the instrument. Applied to all samples, MIDI and ---plugins in the instrument. ----@field volume number Range: (0 - math.db2lin(6)) +---Range: (0 - math.db2lin(6)) +---@field volume number ---@field volume_observable renoise.Document.Observable **READ-ONLY** --- ---Range: (-120 - 120). Global relative pitch in semi tones. @@ -119,16 +121,16 @@ renoise.Instrument = { ---@field phrase_program integer ---@field phrase_program_observable renoise.Document.Observable **READ-ONLY** --- ----Phrases. ----@field phrases renoise.InstrumentPhrase[] **READ-ONLY** +---**READ-ONLY** +---@field phrases renoise.InstrumentPhrase[] ---@field phrases_observable renoise.Document.ObservableList **READ-ONLY** --- ----Phrase mappings. ----@field phrase_mappings renoise.InstrumentPhraseMapping[] **READ-ONLY** +---**READ-ONLY** +---@field phrase_mappings renoise.InstrumentPhraseMapping[] ---@field phrase_mappings_observable renoise.Document.ObservableList **READ-ONLY** --- ----Samples slots. ----@field samples renoise.Sample[] **READ-ONLY** +---**READ-ONLY** +---@field samples renoise.Sample[] ---@field samples_observable renoise.Document.ObservableList **READ-ONLY** --- ---Sample mappings (key/velocity to sample slot mappings). @@ -137,22 +139,22 @@ renoise.Instrument = { ---@field sample_mappings renoise.SampleMapping[] ---@field sample_mappings_observable renoise.Document.ObservableList **READ-ONLY** --- ----Sample modulation sets. ----@field sample_modulation_sets renoise.SampleModulationSet[] **READ-ONLY** +---**READ-ONLY** +---@field sample_modulation_sets renoise.SampleModulationSet[] ---@field sample_modulation_sets_observable renoise.Document.ObservableList **READ-ONLY** --- ----Sample device chains. ----@field sample_device_chains renoise.SampleDeviceChain[] **READ-ONLY** +---**READ-ONLY** +---@field sample_device_chains renoise.SampleDeviceChain[] ---@field sample_device_chains_observable renoise.Document.ObservableList **READ-ONLY** --- ----MIDI input properties. ----@field midi_input_properties renoise.InstrumentMidiInputProperties **READ-ONLY** +---**READ-ONLY** +---@field midi_input_properties renoise.InstrumentMidiInputProperties --- ----MIDI output properties. ----@field midi_output_properties renoise.InstrumentMidiOutputProperties **READ-ONLY** +---**READ-ONLY** +---@field midi_output_properties renoise.InstrumentMidiOutputProperties --- ----Plugin properties. ----@field plugin_properties renoise.InstrumentPluginProperties **READ-ONLY** +---**READ-ONLY** +---@field plugin_properties renoise.InstrumentPluginProperties ---### functions @@ -305,7 +307,8 @@ renoise.InstrumentTriggerOptions = { ---@class renoise.InstrumentTriggerOptions --- ---List of all available scale modes. ----@field available_scale_modes string[] **READ-ONLY** +---**READ-ONLY** +---@field available_scale_modes string[] --- ---Scale to use when transposing. One of 'available_scales'. ---@field scale_mode string, one of 'available_scales'] diff --git a/library/renoise/song/instrument/macro.lua b/library/renoise/song/instrument/macro.lua index 7705e8d..d702003 100644 --- a/library/renoise/song/instrument/macro.lua +++ b/library/renoise/song/instrument/macro.lua @@ -29,7 +29,8 @@ renoise.InstrumentMacro = {} ---@field value_string_observable renoise.Document.Observable **READ-ONLY** --- ---Macro mappings, target parameters ----@field mappings renoise.InstrumentMacroMapping[] **READ-ONLY** +---**READ-ONLY** +---@field mappings renoise.InstrumentMacroMapping[] ---@field mappings_observable renoise.Document.ObservableList **READ-ONLY** ---### functions @@ -65,7 +66,8 @@ renoise.InstrumentMacroMapping = { --- ---Linked parameter. ---Can be a sample FX- or modulation parameter. Never nil. ----@field parameter renoise.DeviceParameter **READ-ONLY** +---**READ-ONLY** +---@field parameter renoise.DeviceParameter --- ---Min/max range in which the macro applies its value to the target parameter. ---Max can be < than Min. Mapping is then flipped. diff --git a/library/renoise/song/instrument/phrase.lua b/library/renoise/song/instrument/phrase.lua index ebc680e..dc6d4d7 100644 --- a/library/renoise/song/instrument/phrase.lua +++ b/library/renoise/song/instrument/phrase.lua @@ -65,10 +65,12 @@ renoise.InstrumentPhrase = { --- ---Phrase script properties. Only used when `playback_mode` is ---set to `renoise.InstrumentPhrase.PLAY_SCRIPT` ----@field script renoise.InstrumentPhraseScript **READ-ONLY** +---**READ-ONLY** +---@field script renoise.InstrumentPhraseScript --- ---Quickly check if a phrase has some non empty pattern lines. ----@field is_empty boolean **READ-ONLY** +---**READ-ONLY** +---@field is_empty boolean ---@field is_empty_observable renoise.Document.Observable **READ-ONLY** --- ---Default: 16, Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_LINES) @@ -77,7 +79,8 @@ renoise.InstrumentPhrase = { ---@field number_of_lines_observable renoise.Document.Observable **READ-ONLY** --- ---Get all lines in a range [1, number_of_lines_in_pattern] ----@field lines renoise.PatternLine[] **READ-ONLY** +---**READ-ONLY** +---@field lines renoise.PatternLine[] --- ---Range: (MIN_NUMBER_OF_NOTE_COLUMNS - MAX_NUMBER_OF_NOTE_COLUMNS) ---How many note columns are visible in the phrase. @@ -219,7 +222,7 @@ function renoise.InstrumentPhrase:remove_line_edited_notifier(func, obj) end function renoise.InstrumentPhrase:column_is_muted(column) end ---@param column integer Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_NOTE_COLUMNS) ----@return renoise.Document.Observable +---@return renoise.Document.Observable **READ-ONLY** function renoise.InstrumentPhrase:column_is_muted_observable(column) end ---@param column integer Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_NOTE_COLUMNS) @@ -232,7 +235,7 @@ function renoise.InstrumentPhrase:set_column_is_muted(column, muted) end function renoise.InstrumentPhrase:column_name(column) end ---@param column integer Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_NOTE_COLUMNS) ----@return renoise.Document.Observable +---@return renoise.Document.Observable **READ-ONLY** function renoise.InstrumentPhrase:column_name_observable(column) end ---@param column integer Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_NOTE_COLUMNS) @@ -283,24 +286,26 @@ renoise.InstrumentPhraseMapping = { --- ---Phrase's key-tracking mode. ---@field key_tracking renoise.InstrumentPhraseMapping.KeyTrackingMode ----@field key_tracking_observable renoise.Document.Observable +---@field key_tracking_observable renoise.Document.Observable **READ-ONLY** --- ---Phrase's base-note. Only relevant when key_tracking is set to transpose. ----@field base_note integer Range: (0 - 119) where C-4 is 48 ----@field base_note_observable renoise.Document.Observable +--- Range: (0 - 119) where C-4 is 48 +---@field base_note integer +---@field base_note_observable renoise.Document.Observable **READ-ONLY** --- ---Note range the mapping is triggered at. Phrases may not overlap, so ---note_range start can only be set behind previous's (if any) end and ---note_range end can only be set before next mapping's (if any) start. ----@field note_range integer[] Range: (0 - 119) where C-4 is 48 ----@field note_range_observable renoise.Document.Observable +---Range: (0 - 119) where C-4 is 48 +---@field note_range integer[] +---@field note_range_observable renoise.Document.Observable **READ-ONLY** --- ---Loop mode. The phrase plays as one-shot when disabled. ---@field looping boolean ----@field looping_observable renoise.Document.Observable +---@field looping_observable renoise.Document.Observable **READ-ONLY** --- ---@field loop_start integer ----@field loop_start_observable renoise.Document.Observable +---@field loop_start_observable renoise.Document.Observable **READ-ONLY** --- ---@field loop_end integer ----@field loop_end_observable renoise.Document.Observable +---@field loop_end_observable renoise.Document.Observable **READ-ONLY** diff --git a/library/renoise/song/instrument/phrase_script.lua b/library/renoise/song/instrument/phrase_script.lua index 94693e2..e63f942 100644 --- a/library/renoise/song/instrument/phrase_script.lua +++ b/library/renoise/song/instrument/phrase_script.lua @@ -30,12 +30,15 @@ renoise.InstrumentPhraseScript = {} ---When false, a preview of the script is shown instead of a text editor. ---@field editor_visible boolean ---fired, when the editor visibility changed. ----@field editor_visible_observable renoise.Document.Observable **READ-ONLY** +---**READ-ONLY** +---@field editor_visible_observable renoise.Document.Observable --- ---List of script input parameters, if any. ----@field parameters renoise.DeviceParameter[] **READ-ONLY** +---**READ-ONLY** +---@field parameters renoise.DeviceParameter[] ---fired, when the input parameter set changed. ----@field parameters_observable renoise.Document.ObservableList **READ-ONLY** +---**READ-ONLY** +---@field parameters_observable renoise.Document.ObservableList --- ---Script content. When changing paragraphs, changes are visible in the ---script editor, but are not applied for playback until they get committed. @@ -48,25 +51,29 @@ renoise.InstrumentPhraseScript = {} --- ---When not empty, the script failed to compile. ---This error text is also visible to the user in the script preview. ----@field compile_error string **READ-ONLY** +---**READ-ONLY** +---@field compile_error string ---@field compile_error_observable renoise.Document.Observable **READ-ONLY** ---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. ----@field runtime_error string **READ-ONLY** +---**READ-ONLY** +---@field runtime_error string ---@field runtime_error_observable renoise.Document.Observable **READ-ONLY** --- ---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. ----@field pending_changes integer **READ-ONLY** +---**READ-ONLY** +---@field pending_changes integer ---@field pending_changes_observable renoise.Document.Observable **READ-ONLY** --- ---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. ----@field committed_observable renoise.Document.Observable **READ-ONLY** +---**READ-ONLY** +---@field committed_observable renoise.Document.Observable ---### functions diff --git a/library/renoise/song/instrument/plugin.lua b/library/renoise/song/instrument/plugin.lua index ee6c8f0..a1a00b4 100644 --- a/library/renoise/song/instrument/plugin.lua +++ b/library/renoise/song/instrument/plugin.lua @@ -32,13 +32,16 @@ renoise.InstrumentPluginProperties = {} ---not including the vendor names as visible in Renoise's GUI. So its an ---identifier, and not the name as visible in the GUI. When no plugin is loaded, ---the identifier is an empty string. ----@field available_plugins string[] **READ-ONLY** +---**READ-ONLY** +---@field available_plugins string[] --- ---Returns a list of tables containing more information about the plugins. ----@field available_plugin_infos PluginInfo[] **READ-ONLY** +---**READ-ONLY** +---@field available_plugin_infos PluginInfo[] --- ---Returns true when a plugin is present; loaded successfully. ----@see renoise.PluginProperties.plugin_device_observable for related notifications. **READ-ONLY** +---@see renoise.PluginProperties.plugin_device_observable for related notifications. +---**READ-ONLY** ---@field plugin_loaded boolean --- ---Valid object for successfully loaded plugins, otherwise nil. Alias plugin @@ -46,33 +49,40 @@ renoise.InstrumentPluginProperties = {} ---the alias points to. ---The observable is fired when the device changes: when a plugin gets loaded or ---unloaded or a plugin alias is assigned or unassigned. ----@field plugin_device (renoise.InstrumentPluginDevice|renoise.AudioDevice)? **READ-ONLY** +---**READ-ONLY** +---@field plugin_device (renoise.InstrumentPluginDevice|renoise.AudioDevice)? ---@field plugin_device_observable renoise.Document.Observable **READ-ONLY** --- ---Valid for loaded and unloaded plugins, ---0 when no alias instrument is set. ----@field alias_instrument_index integer **READ-ONLY** +---**READ-ONLY** +---@field alias_instrument_index integer ---@field alias_instrument_index_observable renoise.Document.Observable **READ-ONLY** ---0 when no alias FX is set ----@field alias_fx_track_index integer **READ-ONLY** +---**READ-ONLY** +---@field alias_fx_track_index integer ---@field alias_fx_track_index_observable renoise.Document.Observable **READ-ONLY** ---0 when no alias FX is set ----@field alias_fx_device_index integer **READ-ONLY** +---**READ-ONLY** +---@field alias_fx_device_index integer ---@field alias_fx_device_index_observable renoise.Document.Observable **READ-ONLY** --- ---Valid for loaded and unloaded plugins. ---target instrument index of the plugin's MIDI output (when present) ----@field midi_output_routing_index integer 0 when no routing is set **READ-ONLY** +---**READ-ONLY** +---@field midi_output_routing_index integer 0 when no routing is set ---@field midi_output_routing_index_observable renoise.Document.Observable **READ-ONLY** --- ---Valid for loaded and unloaded plugins. ----@field channel integer Range: (1 - 16) +---Range: (1 - 16) +---@field channel integer ---@field channel_observable renoise.Document.Observable **READ-ONLY** ---@field transpose integer Range: (-120 - 120) ---@field transpose_observable renoise.Document.Observable **READ-ONLY** --- ---Valid for loaded and unloaded plugins. ----@field volume number Range: (0.0 - 4.0) linear gain +---Range: (0.0 - 4.0) linear gain +---@field volume number ---@field volume_observable renoise.Document.Observable **READ-ONLY** --- ---Valid for loaded and unloaded plugins. @@ -115,8 +125,8 @@ renoise.InstrumentPluginDevice = {} ---@field parameters renoise.DeviceParameter[] **READ-ONLY** --- ---Returns whether or not the plugin provides its own custom GUI. ---- ----@field external_editor_available boolean **READ-ONLY** +---**READ-ONLY** +---@field external_editor_available boolean --- ---When the plugin has no custom GUI, Renoise will create a dummy editor for it which ---lists the plugin parameters. @@ -126,7 +136,8 @@ renoise.InstrumentPluginDevice = {} ---Returns a string that uniquely identifies the plugin ---@see renoise.InstrumentPluginProperties.available_plugins for the list of valid paths ---The string can be passed into: renoise.InstrumentPluginProperties:load_plugin() ----@field device_path string **READ-ONLY** +---**READ-ONLY** +---@field device_path string ---### functions diff --git a/library/renoise/song/instrument/sample.lua b/library/renoise/song/instrument/sample.lua index ea3542d..9b99530 100644 --- a/library/renoise/song/instrument/sample.lua +++ b/library/renoise/song/instrument/sample.lua @@ -55,7 +55,8 @@ renoise.Sample = { ---True, when the sample slot is an alias to a sliced master sample. ---Such sample slots are read-only and automatically managed with the master samples ---slice list. ----@field is_slice_alias boolean **READ-ONLY** +---**READ-ONLY** +---@field is_slice_alias boolean ---Read/write access to the slice marker list of a sample. When new markers are ---set or existing ones unset, existing 0S effects or notes to existing slices ---will NOT be remapped (unlike its done with the insert/remove/move_slice_marker @@ -97,7 +98,7 @@ renoise.Sample = { ---@field new_note_action_observable renoise.Document.Observable **READ-ONLY** ---@field oneshot boolean ---@field oneshot_observable renoise.Document.Observable **READ-ONLY** ----@field mute_group integer Range: (0 - 15) where 0 means no group +---@field mute_group integer Range: (0 - 15) where 0 means no group ---@field mute_group_observable renoise.Document.Observable **READ-ONLY** ---@field autoseek boolean ---@field autoseek_observable renoise.Document.Observable **READ-ONLY** @@ -128,7 +129,8 @@ renoise.Sample = { ---@field sample_buffer_observable renoise.Document.Observable **READ-ONLY** --- ---Keyboard Note/velocity mapping ----@field sample_mapping renoise.SampleMapping **READ-ONLY** +---**READ-ONLY** +---@field sample_mapping renoise.SampleMapping ---### functions @@ -180,7 +182,8 @@ renoise.SampleMapping = {} --- ---True for sliced instruments. No sample mapping properties are ---allowed to be modified, but can be read. ----@field read_only boolean **READ-ONLY** +---**READ-ONLY** +---@field read_only boolean --- ---Linked sample. ---@field sample renoise.Sample @@ -196,17 +199,20 @@ renoise.SampleMapping = {} ---@field map_key_to_pitch_observable renoise.Document.Observable --- ---Mappings base-note. Final pitch of the played sample is: ---- played_note - mapping.base_note + sample.transpose + sample.finetune ----@field base_note integer Range: (0-119, c-4=48)] +---`played_note - mapping.base_note + sample.transpose + sample.finetune` +---Range: (0-119, c-4=48) +---@field base_note integer ---@field base_note_observable renoise.Document.Observable --- ---Note range the mapping is triggered for. ---table of two integers ----@field note_range integer[] Range: (0 - 119) where C-4 is 48 +---Range: (0 - 119) where C-4 is 48 +---@field note_range integer[] ---@field note_range_observable renoise.Document.Observable --- ---Velocity range the mapping is triggered for. ----@field velocity_range integer[] Range: (0 - 127) +---Range: (0 - 127) +---@field velocity_range integer[] ---@field velocity_range_observable renoise.Document.Observable -------------------------------------------------------------------------------- @@ -232,23 +238,29 @@ renoise.SampleBuffer = { ---@class renoise.SampleBuffer --- ---Check this before accessing properties ----@field has_sample_data boolean **READ-ONLY** +---**READ-ONLY** +---@field has_sample_data boolean --- ---True, when the sample buffer can only be read, but not be ---modified. true for sample aliases of sliced samples. To modify such sample ---buffers, modify the sliced master sample buffer instead. ----@field read_only boolean **READ-ONLY** +---**READ-ONLY** +---@field read_only boolean ---The current sample rate in Hz, like 44100. ----@field sample_rate integer **READ-ONLY** +---**READ-ONLY** +---@field sample_rate integer --- ---The current bit depth, like 32, 16, 8. ----@field bit_depth integer **READ-ONLY** +---**READ-ONLY** +---@field bit_depth integer --- ---The integer of sample channels (1 or 2) ----@field number_of_channels integer **READ-ONLY** +---**READ-ONLY** +---@field number_of_channels integer --- ---The sample frame count (integer of samples per channel) ----@field number_of_frames integer **READ-ONLY** +---**READ-ONLY** +---@field number_of_frames integer --- ---The first sample displayed in the sample editor view. Set together with ---DisplayLength to control zooming. diff --git a/library/renoise/song/instrument/sample_device_chain.lua b/library/renoise/song/instrument/sample_device_chain.lua index 1b9c330..aaccda7 100644 --- a/library/renoise/song/instrument/sample_device_chain.lua +++ b/library/renoise/song/instrument/sample_device_chain.lua @@ -21,19 +21,23 @@ renoise.SampleDeviceChain = {} ---@field name_observable renoise.Document.Observable --- ---Allowed, available devices for 'insert_device_at'. ----@field available_devices string[] **READ-ONLY** +---**READ-ONLY** +---@field available_devices string[] --- ---Returns a list of tables containing more information about ---the devices. ---@see renoise.Track.available_device_infos ----@field available_device_infos AudioDeviceInfo[] **READ-ONLY** +---**READ-ONLY** +---@field available_device_infos AudioDeviceInfo[] --- ---Device access. ----@field devices renoise.AudioDevice[] **READ-ONLY** +---**READ-ONLY** +---@field devices renoise.AudioDevice[] ---@field devices_observable renoise.Document.ObservableList **READ-ONLY** --- ---Output routing. ----@field available_output_routings string[] **READ-ONLY** +---**READ-ONLY** +---@field available_output_routings string[] --- ---One of 'available_output_routings' ---@see renoise.SampleDeviceChain.available_output_routings diff --git a/library/renoise/song/instrument/sample_modulation.lua b/library/renoise/song/instrument/sample_modulation.lua index 735cc82..7f09d5a 100644 --- a/library/renoise/song/instrument/sample_modulation.lua +++ b/library/renoise/song/instrument/sample_modulation.lua @@ -118,24 +118,29 @@ renoise.SampleModulationSet = {} ---@field pitch_range_observable renoise.Document.Observable **READ-ONLY** --- ---All available devices, to be used in 'insert_device_at'. ----@field available_devices string[] **READ-ONLY** +---**READ-ONLY** +---@field available_devices string[] --- ---Device list access. ----@field devices renoise.SampleModulationDevice[] **READ-ONLY** +---**READ-ONLY** +---@field devices renoise.SampleModulationDevice[] ---@field devices_observable renoise.Document.ObservableList **READ-ONLY** --- ---Filter version, 3 is the latest. ---@see renoise.SampleModulationSet.upgrade_filter_version ----@field filter_version 1 | 2 | 3 **READ-ONLY** +---**READ-ONLY** +---@field filter_version 1 | 2 | 3 ---@field filter_version_observable renoise.Document.Observable **READ-ONLY** --- ---List of available filter types depending on the filter_version. ----@field available_filter_types FilterTypes[] **READ-ONLY** +---**READ-ONLY** +---@field available_filter_types FilterTypes[] --- ---The type of the filter selected for the modulation set. ---Songs made with previous versions of Renoise may use old filter types. ---@see renoise.SampleModulationSet.available_filter_types ----@field filter_type FilterTypes **READ-ONLY** +---**READ-ONLY** +---@field filter_type FilterTypes ---@field filter_type_observable renoise.Document.Observable **READ-ONLY** ---### functions @@ -201,55 +206,57 @@ renoise.SampleModulationDevice = { ---@class renoise.SampleModulationDevice --- ---Fixed name of the device. ----@field name string **READ-ONLY** ---- ---- +---**READ-ONLY** +---@field name string ---@field short_name string **READ-ONLY** --- ---Configurable device display name. ---@field display_name string ----@field display_name_observable renoise.Document.Observable +---@field display_name_observable renoise.Document.Observable **READ-ONLY** --- ---**Deprecated.** Use `is_active` instead. ---@deprecated ---@field enabled boolean ----@field enabled_observable renoise.Document.Observable +---@field enabled_observable renoise.Document.Observable **READ-ONLY** --- ---Enable/bypass the device. ---@field is_active boolean not active = bypassed ----@field is_active_observable renoise.Document.Observable +---@field is_active_observable renoise.Document.Observable **READ-ONLY** --- ---Maximize state in modulation chain. ---@field is_maximized boolean ----@field is_maximized_observable renoise.Document.Observable +---@field is_maximized_observable renoise.Document.Observable **READ-ONLY** --- ---Where the modulation gets applied (Volume, ---Pan, Pitch, Cutoff, Resonance). ----@field target renoise.SampleModulationDevice.TargetType **READ-ONLY** +---**READ-ONLY** +---@field target renoise.SampleModulationDevice.TargetType --- ---Modulation operator: how the device applies. ----@field operator renoise.SampleModulationDevice.OperatorType ----@field operator_observable renoise.Document.Observable +---@field operator renoise.SampleModulationDevice.OperatorType **READ-ONLY** +---@field operator_observable renoise.Document.Observable **READ-ONLY** --- ---Modulation polarity: ---when bipolar, the device applies it's values in a -1 to 1 range, ---when unipolar in a 0 to 1 range. ---@field bipolar boolean ----@field bipolar_observable renoise.Document.Observable +---@field bipolar_observable renoise.Document.Observable **READ-ONLY** --- ---When true, the device has one of more time parameters, ---which can be switched to operate in synced or unsynced mode. ---see also field tempo_synced. ----@field tempo_sync_switching_allowed boolean **READ-ONLY** +---**READ-ONLY** +---@field tempo_sync_switching_allowed boolean --- ---When true and the device supports sync switching the device operates ---in wall-clock (ms) instead of beat times. ---see also property 'tempo_sync_switching_allowed' ---@field tempo_synced boolean ----@field tempo_synced_observable renoise.Document.Observable +---@field tempo_synced_observable renoise.Document.Observable **READ-ONLY** --- ---Generic access to all parameters of this device. ----@field is_active_parameter renoise.DeviceParameter **READ-ONLY** +---**READ-ONLY** +---@field is_active_parameter renoise.DeviceParameter --- --- ---@field parameters renoise.DeviceParameter[] **READ-ONLY** @@ -307,7 +314,7 @@ renoise.SampleFaderModulationDevice = { --- ---Scaling mode. ---@field scaling renoise.SampleFaderModulationDevice.ScalingType ----@field scaling_observable renoise.Document.Observable +---@field scaling_observable renoise.Document.Observable **READ-ONLY** --- ---Start value. ---@field from renoise.DeviceParameter @@ -330,15 +337,20 @@ renoise.SampleAhdrsModulationDevice = {} ---@class renoise.SampleAhdrsModulationDevice : renoise.SampleModulationDevice --- ---Attack duration. ----@field attack renoise.DeviceParameter with range (0-1) +---Range: (0 - 1) +---@field attack renoise.DeviceParameter ---Hold duration. ----@field hold renoise.DeviceParameter with range (0-1) +---Range: (0 - 1) +---@field hold renoise.DeviceParameter ---Duration. ----@field duration renoise.DeviceParameter with range (0-1) +---Range: (0 - 1) +---@field duration renoise.DeviceParameter ---Sustain amount. ----@field sustain renoise.DeviceParameter with range (0-1) +---Range: (0 - 1) +---@field sustain renoise.DeviceParameter ---Release duration. ----@field release renoise.DeviceParameter with range (0-1) +---Range: (0 - 1) +---@field release renoise.DeviceParameter -------------------------------------------------------------------------------- ---### renoise.SampleKeyTrackingModulationDevice @@ -351,8 +363,10 @@ renoise.SampleKeyTrackingModulationDevice = {} ---@class renoise.SampleKeyTrackingModulationDevice : renoise.SampleModulationDevice --- ---Min/Max key value. ----@field min renoise.DeviceParameter with range (0-119) ----@field max renoise.DeviceParameter with range (0-119) +---Range: (0 - 119) +---@field min renoise.DeviceParameter +---Range: (0 - 119) +---@field max renoise.DeviceParameter -------------------------------------------------------------------------------- @@ -380,8 +394,10 @@ renoise.SampleVelocityTrackingModulationDevice = { --- --- ---Min/Max velocity. ----@field min renoise.DeviceParameter with range (0-127) ----@field max renoise.DeviceParameter with range (0-127) +---Range: (0 - 127) +---@field min renoise.DeviceParameter +---Range: (0 - 127) +---@field max renoise.DeviceParameter -------------------------------------------------------------------------------- ---## renoise.SampleEnvelopeModulationDevice @@ -424,10 +440,10 @@ renoise.SampleEnvelopeModulationDevice = { ---@field play_mode_observable renoise.Document.Observable --- ---Envelope length. ----@field length integer Range: (6 - 1000) +---Range: (6 - 1000) +---@field length integer ---@field length_observable renoise.Document.Observable --- ----Loop. ---@field loop_mode renoise.SampleEnvelopeModulationDevice.LoopMode ---@field loop_mode_observable renoise.Document.Observable --- @@ -437,7 +453,6 @@ renoise.SampleEnvelopeModulationDevice = { ---@field loop_end integer Range: (1 - envelope.length) ---@field loop_end_observable renoise.Document.Observable --- ----Sustain. ---@field sustain_enabled boolean ---@field sustain_enabled_observable renoise.Document.Observable --- @@ -458,11 +473,14 @@ renoise.SampleEnvelopeModulationDevice = { --- ---@class SampleEnvelopeModulationDevice.Point ---An envelope point's time. ----@field time integer Range: (1 - envelope.length) +---Range: (1 - envelope.length) +---@field time integer ---An envelope point's value. ----@field value number Range: (0.0 - 1.0) +---Range: (0.0 - 1.0) +---@field value number ---An envelope point's scaling (used in 'lines' playback mode only - 0.0 is linear). ----@field scaling number Range: (-1.0 - 1.0) +---Range: ( - 1.0 - 1.0) +---@field scaling number ---### functions @@ -492,7 +510,7 @@ function renoise.SampleEnvelopeModulationDevice:has_point_at(time) end ---@param time integer Range: (1 - envelope.length) ---@param value number Range: (0.0 - 1.0) ----@param scaling number? Range: (-1.0 - 1.0) +---@param scaling number? Range: ( - 1.0 - 1.0) ---Add a new point value (or replace any existing value) at time. function renoise.SampleEnvelopeModulationDevice:add_point_at(time, value, scaling) end @@ -532,11 +550,13 @@ renoise.SampleStepperModulationDevice = { ---@field play_mode_observable renoise.Document.Observable --- ---Step size. -1 is the same as choosing RANDOM ----@field play_step integer Range: (-1 - 16) +---Range: ( - 1 - 16) +---@field play_step integer ---@field play_step_observable renoise.Document.Observable --- ---Envelope length. ----@field length integer Range: (1 - 256) +---Range: (1 - 256) +---@field length integer ---@field length_observable renoise.Document.Observable --- ---Get all points of the envelope. When setting a new list of points, @@ -549,11 +569,14 @@ renoise.SampleStepperModulationDevice = { --- ---@class SampleStepperModulationDevice.Point ---An envelope point's time. ----@field time integer Range: (1 - envelope.length) +---Range: (1 - envelope.length) +---@field time integer ---An envelope point's value. ----@field value number Range: (0.0 - 1.0) +---Range: (0.0 - 1.0) +---@field value number ---An envelope point's scaling (used in 'lines' playback mode only - 0.0 is linear). ----@field scaling number Range: (-1.0 - 1.0) +---Range: ( - 1.0 - 1.0) +---@field scaling number ---### functions @@ -615,14 +638,13 @@ renoise.SampleLfoModulationDevice = { ---LFO mode. ---@field mode renoise.SampleLfoModulationDevice.Mode --- ----Phase. ----@field phase renoise.DeviceParameter with range (0-360) +---Range: (0 - 360) +---@field phase renoise.DeviceParameter -- ----Frequency. ----@field frequency renoise.DeviceParameter with range (0-1) +---Range: (0 - 1) +---@field frequency renoise.DeviceParameter --- ----Amount. ----@field amount renoise.DeviceParameter with range (0-1) +---Range: (0 - 1) +---@field amount renoise.DeviceParameter --- ----Delay. ---@field delay renoise.DeviceParameter diff --git a/library/renoise/song/pattern.lua b/library/renoise/song/pattern.lua index 0960f20..e1404ff 100644 --- a/library/renoise/song/pattern.lua +++ b/library/renoise/song/pattern.lua @@ -27,16 +27,17 @@ renoise.Pattern.MAX_NUMBER_OF_LINES = 512 --- ---Name of the pattern, as visible in the pattern sequencer. ---@field name string ----@field name_observable renoise.Document.Observable +---@field name_observable renoise.Document.Observable **READ-ONLY** --- ---Number of lines the pattern currently has. 64 by default. Max is ---renoise.Pattern.MAX_NUMBER_OF_LINES, min is 1. ---@field number_of_lines integer ----@field number_of_lines_observable renoise.Document.Observable +---@field number_of_lines_observable renoise.Document.Observable **READ-ONLY** --- ---Access to the pattern tracks. Each pattern has ---#renoise.song().tracks amount of tracks. ----@field tracks renoise.PatternTrack[] **READ-ONLY** +---**READ-ONLY** +---@field tracks renoise.PatternTrack[] ---### functions diff --git a/library/renoise/song/pattern/automation.lua b/library/renoise/song/pattern/automation.lua index 7f3efed..5664bde 100644 --- a/library/renoise/song/pattern/automation.lua +++ b/library/renoise/song/pattern/automation.lua @@ -51,24 +51,28 @@ renoise.PatternTrackAutomation = { --- ---play-mode (interpolation mode). ---@field playmode renoise.PatternTrackAutomation.Playmode ----@field playmode_observable renoise.Document.Observable +---@field playmode_observable renoise.Document.Observable **READ-ONLY** --- ---Max length (time in lines) of the automation. ---Will always fit the patterns length. ----@field length integer Range: (1 - NUM_LINES_IN_PATTERN) **READ-ONLY** +---Range: (1 - NUM_LINES_IN_PATTERN) +---**READ-ONLY** +---@field length integer --- ---Selection range as visible in the automation editor. always valid. ---returns the automation range no selection is present in the UI. ----@field selection_start integer Range: (1 - automation.length + 1) ----@field selection_start_observable renoise.Document.Observable ----@field selection_end integer Range: (1 - automation.length + 1) ----@field selection_end_observable renoise.Document.Observable +---Range: (1 - automation.length + 1) +---@field selection_start integer +---@field selection_start_observable renoise.Document.Observable **READ-ONLY** +---Range: (1 - automation.length + 1) +---@field selection_end integer +---@field selection_end_observable renoise.Document.Observable **READ-ONLY** --- ---Get or set selection range. when setting an empty table, the existing ---selection, if any, will be cleared. ---array of two numbers [] OR Range: (1 - automation.length + 1) ---@field selection_range integer[] ----@field selection_range_observable renoise.Document.Observable +---@field selection_range_observable renoise.Document.Observable **READ-ONLY** --- ---Get all points of the automation. When setting a new list of points, ---items may be unsorted by time, but there may not be multiple points @@ -76,7 +80,7 @@ renoise.PatternTrackAutomation = { ---`points[1].value` will not do anything. Instead, change them via ---`points = { modified_points }`. ---@field points EnvelopePoint[] ----@field points_observable renoise.Document.ObservableList +---@field points_observable renoise.Document.ObservableList **READ-ONLY** ---### functions diff --git a/library/renoise/song/pattern/line.lua b/library/renoise/song/pattern/line.lua index dfa1df9..a3ede2a 100644 --- a/library/renoise/song/pattern/line.lua +++ b/library/renoise/song/pattern/line.lua @@ -30,10 +30,12 @@ renoise.PatternLine.EMPTY_EFFECT_AMOUNT = 0 ---@class renoise.PatternLine --- ---Is empty. ----@field is_empty boolean **READ-ONLY** +---**READ-ONLY** +---@field is_empty boolean --- ---Columns. ----@field note_columns renoise.NoteColumn[] **READ-ONLY** +---**READ-ONLY** +---@field note_columns renoise.NoteColumn[] ---@field effect_columns renoise.EffectColumn[] **READ-ONLY** ---### functions @@ -93,11 +95,13 @@ renoise.NoteColumn = {} ---@class renoise.NoteColumn --- ---True, when all note column properties are empty. ----@field is_empty boolean **READ-ONLY** +---**READ-ONLY** +---@field is_empty boolean --- ---True, when this column is selected in the pattern or phrase ---editors current pattern. ----@field is_selected boolean **READ-ONLY** +---**READ-ONLY** +---@field is_selected boolean --- ---@field note_value integer Range: (0-119) or 120=Off or 121=Empty ---@field note_string string Range: (\'C-0\'-\'G-9\') or \'OFF\' or \'---\' @@ -166,10 +170,12 @@ renoise.EffectColumn = {} ---@class renoise.EffectColumn --- ---True, when all effect column properties are empty. ----@field is_empty boolean **READ-ONLY** +---**READ-ONLY** +---@field is_empty boolean --- ---True, when this column is selected in the pattern or phrase editor. ----@field is_selected boolean **READ-ONLY** +---**READ-ONLY** +---@field is_selected boolean --- ---0-65535 in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2 ---@field number_value integer diff --git a/library/renoise/song/pattern/track.lua b/library/renoise/song/pattern/track.lua index 538a19b..8307952 100644 --- a/library/renoise/song/pattern/track.lua +++ b/library/renoise/song/pattern/track.lua @@ -17,7 +17,8 @@ renoise.PatternTrack = {} ---@class renoise.PatternTrack --- ---Ghosting (aliases) ----@field is_alias boolean **READ-ONLY** +---**READ-ONLY** +---@field is_alias boolean --- ---Pattern index the pattern track is aliased or 0 when its not aliased. ---@field alias_pattern_index integer index or 0 when no alias is present @@ -32,7 +33,8 @@ renoise.PatternTrack = {} --- ---Get all lines in range [1, number_of_lines_in_pattern]. ---Use `renoise.Pattern:add/remove_line_notifier` for change notifications. ----@field lines renoise.PatternLine[] **READ-ONLY** +---**READ-ONLY** +---@field lines renoise.PatternLine[] --- ---Automation. ---@field automation renoise.PatternTrackAutomation[] diff --git a/library/renoise/song/track.lua b/library/renoise/song/track.lua index f93bf9c..f661c91 100644 --- a/library/renoise/song/track.lua +++ b/library/renoise/song/track.lua @@ -45,13 +45,14 @@ renoise.Track = { ---@class renoise.Track --- ----Type, name, color. ----@field type renoise.Track.TrackType **READ-ONLY** +---**READ-ONLY** +---@field type renoise.Track.TrackType ---@field name string Name, as visible in track headers ---@field name_observable renoise.Document.Observable **READ-ONLY** ---@field color RGBColor ---@field color_observable renoise.Document.Observable **READ-ONLY** ----@field color_blend integer Range: (0 - 100) Color blend in percent +---Range: (0 - 100) Color blend in percent +---@field color_blend integer ---@field color_blend_observable renoise.Document.Observable **READ-ONLY** --- ---Mute and solo states. Not available for the master track. @@ -61,7 +62,6 @@ renoise.Track = { ---@field solo_state boolean ---@field solo_state_observable renoise.Document.Observable **READ-ONLY** --- ----Volume, panning, width. ---@field prefx_volume renoise.DeviceParameter **READ-ONLY** ---@field prefx_panning renoise.DeviceParameter **READ-ONLY** ---@field prefx_width renoise.DeviceParameter **READ-ONLY** @@ -74,27 +74,38 @@ renoise.Track = { ---@field collapsed_observable renoise.Document.Observable **READ-ONLY** --- ---Returns most immediate group parent or nil if not in a group. ----@field group_parent renoise.GroupTrack? **READ-ONLY** +---**READ-ONLY** +---@field group_parent renoise.GroupTrack? --- ---Output routing. ----@field available_output_routings string[] **READ-ONLY** ----@field output_routing string One of `available_output_routings` +---**READ-ONLY** +---@field available_output_routings string[] +---One of `available_output_routings` +---@field output_routing string ---@field output_routing_observable renoise.Document.Observable **READ-ONLY** --- ----Delay. ----@field output_delay number Range: (-100.0-100.0) in ms +---Range: (-100.0-100.0) in ms +---@field output_delay number ---@field output_delay_observable renoise.Document.Observable **READ-ONLY** --- ----Pattern editor columns. ----@field max_effect_columns integer **READ-ONLY** 8 OR 0 depending on the track type ----@field min_effect_columns integer **READ-ONLY** 1 OR 0 depending on the track type ---- ----@field max_note_columns integer **READ-ONLY** 12 OR 0 depending on the track type ----@field min_note_columns integer **READ-ONLY** 1 OR 0 depending on the track type ---- ----@field visible_effect_columns integer 1-8 OR 0-8, depending on the track type +---8 OR 0 depending on the track type +---**READ-ONLY** +---@field max_effect_columns integer +---1 OR 0 depending on the track type +---**READ-ONLY** +---@field min_effect_columns integer +---12 OR 0 depending on the track type +---**READ-ONLY** +---@field max_note_columns integer +---1 OR 0 depending on the track type +---**READ-ONLY** +---@field min_note_columns integer +--- +---1-8 OR 0-8, depending on the track type +---@field visible_effect_columns integer ---@field visible_effect_columns_observable renoise.Document.Observable **READ-ONLY** ----@field visible_note_columns integer 0 OR 1-12, depending on the track type +---0 OR 1-12, depending on the track type +---@field visible_note_columns integer ---@field visible_note_columns_observable renoise.Document.Observable **READ-ONLY** --- ---@field volume_column_visible boolean @@ -107,12 +118,15 @@ renoise.Track = { ---@field sample_effects_column_visible_observable renoise.Document.Observable **READ-ONLY** --- ---The FX devices this track can handle. ----@field available_devices string[] **READ-ONLY** +---**READ-ONLY** +---@field available_devices string[] ---Array of tables containing information about the devices. ----@field available_device_infos AudioDeviceInfo[] **READ-ONLY** +---**READ-ONLY** +---@field available_device_infos AudioDeviceInfo[] --- ---List of audio DSP FX. ----@field devices renoise.AudioDevice[] **READ-ONLY** +---**READ-ONLY** +---@field devices renoise.AudioDevice[] ---@field devices_observable renoise.Document.ObservableList **READ-ONLY** ---### functions diff --git a/library/renoise/song/transport.lua b/library/renoise/song/transport.lua index 4b9d20b..9a458db 100644 --- a/library/renoise/song/transport.lua +++ b/library/renoise/song/transport.lua @@ -51,27 +51,28 @@ renoise.Transport = { --- ---Playing ---@field playing boolean ----@field playing_observable renoise.Document.Observable +---@field playing_observable renoise.Document.Observable **READ-ONLY** --- ---Transport sync mode. ---Note: `SYNC_MODE_JACK` only is available on Linux. Trying to enable it on ---other platforms will fire an error. ---@field sync_mode renoise.Transport.SyncMode ----@field sync_mode_observable renoise.Document.Observable +---@field sync_mode_observable renoise.Document.Observable **READ-ONLY** --- ----*READ-ONLY* Old school speed or new LPB timing used? +---Old school speed or new LPB timing used? ---With `TIMING_MODEL_SPEED`, tpl is used as speed factor. The lpb property ---is unused then. With `TIMING_MODEL_LPB`, tpl is used as event rate for effects ---only and lpb defines relationship between pattern lines and beats. +---**READ-ONLY** ---@field timing_model renoise.Transport.TimingModel --- ---BPM, LPB, and TPL ---@field bpm number Range: (32 - 999) Beats per Minute ----@field bpm_observable renoise.Document.Observable +---@field bpm_observable renoise.Document.Observable **READ-ONLY** ---@field lpb integer Range: (1 - 256) Lines per Beat ----@field lpb_observable renoise.Document.Observable +---@field lpb_observable renoise.Document.Observable **READ-ONLY** ---@field tpl integer Range: (1 - 16) Ticks per Line ----@field tpl_observable renoise.Document.Observable +---@field tpl_observable renoise.Document.Observable **READ-ONLY** --- ---Playback position ---@field playback_pos renoise.SongPos @@ -81,11 +82,9 @@ renoise.Transport = { ---@field edit_pos renoise.SongPos ---@field edit_pos_beats number Range: (0 - song_end_beats) Song position in beats --- ----Song length ---@field song_length renoise.SongPos **READ-ONLY** ---@field song_length_beats number **READ-ONLY** --- ----Loop ---@field loop_start renoise.SongPos **READ-ONLY** ---@field loop_end renoise.SongPos **READ-ONLY** ---@field loop_range renoise.SongPos[] {loop start, loop end} @@ -98,87 +97,82 @@ renoise.Transport = { ---@field loop_sequence_range integer[] {} or Range(sequence start, sequence end) --- ---@field loop_pattern boolean Pattern Loop On/Off ----@field loop_pattern_observable renoise.Document.Observable +---@field loop_pattern_observable renoise.Document.Observable **READ-ONLY** --- ---@field loop_block_enabled boolean Block Loop On/Off ----@field loop_block_enabled_observable renoise.Document.Observable +---@field loop_block_enabled_observable renoise.Document.Observable **READ-ONLY** ---@field loop_block_range_coeff integer Range: (2 - 16) ----@field loop_block_range_coeff_observable renoise.Document.Observable +---@field loop_block_range_coeff_observable renoise.Document.Observable **READ-ONLY** --- ---@field loop_block_start_pos renoise.SongPos Start of block loop --- ----Edit modes ---@field edit_mode boolean Pattern edit/record mode On/Off ----@field edit_mode_observable renoise.Document.Observable +---@field edit_mode_observable renoise.Document.Observable **READ-ONLY** ---@field edit_step integer Range: (0 - 64) ----@field edit_step_observable renoise.Document.Observable +---@field edit_step_observable renoise.Document.Observable **READ-ONLY** --- ---@field octave integer Range: (0 - 8) ----@field octave_observable renoise.Document.Observable +---@field octave_observable renoise.Document.Observable **READ-ONLY** ---@field octave_enabled boolean Enabled for MIDI keyboards ----@field octave_enabled_observable renoise.Document.Observable +---@field octave_enabled_observable renoise.Document.Observable **READ-ONLY** --- ----Metronome ---@field metronome_enabled boolean Metronome playback On/Off ----@field metronome_enabled_observable renoise.Document.Observable +---@field metronome_enabled_observable renoise.Document.Observable **READ-ONLY** ---@field metronome_beats_per_bar integer Range: (1 - 16) or 0 = guess from pattern length ----@field metronome_beats_per_bar_observable renoise.Document.Observable +---@field metronome_beats_per_bar_observable renoise.Document.Observable **READ-ONLY** ---@field metronome_lines_per_beat integer Range: (1 - 256) or 0 = songs current LPB ----@field metronome_lines_per_beat_observable renoise.Document.Observable +---@field metronome_lines_per_beat_observable renoise.Document.Observable **READ-ONLY** --- ----Metronome precount ---@field metronome_precount_enabled boolean Metronome precount playback On/Off ----@field metronome_precount_enabled_observable renoise.Document.Observable +---@field metronome_precount_enabled_observable renoise.Document.Observable **READ-ONLY** ---@field metronome_precount_bars integer Range: (1 - 4) ----@field metronome_precount_bars_observable renoise.Document.Observable +---@field metronome_precount_bars_observable renoise.Document.Observable **READ-ONLY** ---@field metronome_volume number Range: (0 - math.db2lin(6)) ----@field metronome_volume_observable renoise.Document.Observable +---@field metronome_volume_observable renoise.Document.Observable **READ-ONLY** --- ----Quantize ---@field record_quantize_enabled boolean Record note quantization On/Off ----@field record_quantize_enabled_observable renoise.Document.Observable +---@field record_quantize_enabled_observable renoise.Document.Observable **READ-ONLY** ---@field record_quantize_lines integer Range: (1 - 32) ----@field record_quantize_lines_observable renoise.Document.Observable +---@field record_quantize_lines_observable renoise.Document.Observable **READ-ONLY** --- ----Record parameter ---@field record_parameter_mode renoise.Transport.RecordParameterMode ----@field record_parameter_mode_observable renoise.Document.Observable +---@field record_parameter_mode_observable renoise.Document.Observable **READ-ONLY** --- ----Follow, wrapped pattern, single track modes ---@field follow_player boolean ----@field follow_player_observable renoise.Document.Observable +---@field follow_player_observable renoise.Document.Observable **READ-ONLY** ---@field wrapped_pattern_edit boolean ----@field wrapped_pattern_edit_observable renoise.Document.Observable +---@field wrapped_pattern_edit_observable renoise.Document.Observable **READ-ONLY** ---@field single_track_edit_mode boolean ----@field single_track_edit_mode_observable renoise.Document.Observable +---@field single_track_edit_mode_observable renoise.Document.Observable **READ-ONLY** --- ---Groove (aka Shuffle) ---@field groove_enabled boolean ----@field groove_enabled_observable renoise.Document.Observable ----@field groove_amounts number[] table with 4 numbers in Range: (0 - 1) +---@field groove_enabled_observable renoise.Document.Observable **READ-ONLY** +---table with 4 numbers in Range: (0 - 1) +---@field groove_amounts number[] ---Will be called as soon as any groove value changed. ----@field groove_assignment_observable renoise.Document.Observable +---@field groove_assignment_observable renoise.Document.Observable **READ-ONLY** --- ---Global Track Headroom ---To convert to dB: `dB = math.lin2db(renoise.Transport.track_headroom)` ---To convert from dB: `renoise.Transport.track_headroom = math.db2lin(dB)` ---Range: (math.db2lin(-12) - math.db2lin(0)) ---@field track_headroom number ----@field track_headroom_observable renoise.Document.Observable +---@field track_headroom_observable renoise.Document.Observable **READ-ONLY** --- ---Computer Keyboard Velocity. ---@field keyboard_velocity_enabled boolean ----@field keyboard_velocity_enabled_observable renoise.Document.Observable +---@field keyboard_velocity_enabled_observable renoise.Document.Observable **READ-ONLY** ---Will return the default value of 127 when keyboard_velocity_enabled == false. ---Range: (0 - 127) ---@field keyboard_velocity integer ----@field keyboard_velocity_observable renoise.Document.Observable +---@field keyboard_velocity_observable renoise.Document.Observable **READ-ONLY** --- ---*READ-ONLY* true when sample sample dialog is visible and recording started. ---@field sample_recording boolean ---Sample recording pattern quantization On/Off. ---@field sample_recording_sync_enabled boolean ----@field sample_recording_sync_enabled_observable renoise.Document.Observable +---@field sample_recording_sync_enabled_observable renoise.Document.Observable **READ-ONLY** ---### functions diff --git a/library/renoise/sqlite.lua b/library/renoise/sqlite.lua index 0447bf2..e8ed083 100644 --- a/library/renoise/sqlite.lua +++ b/library/renoise/sqlite.lua @@ -20,7 +20,8 @@ error("Do not try to execute this file. It's just a type definition file.") ---@class SQLite --- ---SQLite version information, in the form `x.y[.z[.p]]`. ----@field version string **READ-ONLY** +---**READ-ONLY** +---@field version string renoise.SQLite = {} ---### constants @@ -101,14 +102,18 @@ function renoise.SQLite.open(filename, flags) end ---@class SQLiteDatabase : userdata --- ---Whether or not the database is open. ----@field is_open boolean **READ-ONLY** +---**READ-ONLY** +---@field is_open boolean ---Whether or not the database is closed. ----@field is_closed boolean **READ-ONLY** +---**READ-ONLY** +---@field is_closed boolean --- ---The most recent error code. ----@field error_code renoise.SQLite.Status **READ-ONLY** +---**READ-ONLY** +---@field error_code renoise.SQLite.Status ---The most recent error message. ----@field error_message string **READ-ONLY** +---**READ-ONLY** +---@field error_message string --- ---Number of database rows that were changed, inserted, or deleted by ---the most recent SQL statement. @@ -116,13 +121,15 @@ function renoise.SQLite.open(filename, flags) end ---are counted. ---Auxiliary changes caused by triggers are not counted. Use `db.total_changes` ---to find the total number of changes. ----@field changes integer **READ-ONLY** +---**READ-ONLY** +---@field changes integer ---The number of database rows that have been modified by INSERT, ---UPDATE or DELETE statements since the database was opened. ---This includes UPDATE, INSERT and DELETE statements executed as part of ---trigger programs. All changes are counted as soon as the statement that ---produces them is completed by calling either `stmt:reset()` or `stmt:finalize()`. ----@field total_changes integer **READ-ONLY** +---**READ-ONLY** +---@field total_changes integer --- ---Gets the rowid of the most recent INSERT into the database. ---If no inserts have ever occurred, 0 is returned. @@ -135,7 +142,8 @@ function renoise.SQLite.open(filename, flags) end ---If an INSERT occurs within a trigger, then the rowid of the inserted ---row is returned as long as the trigger is running. Once the trigger terminates, ---the value returned reverts to the last value inserted before the trigger fired. ----@field last_insert_rowid integer **READ-ONLY** +---**READ-ONLY** +---@field last_insert_rowid integer local SQLiteDatabase = {} --- Closes a database. All SQL statements prepared using `db:prepare()` should @@ -283,44 +291,56 @@ function SQLiteDatabase:urows(sql) end ---@class SQLiteStatement: userdata --- ---Whether or not the statement hasn't been finalized. ----@field is_open boolean **READ-ONLY** +---**READ-ONLY** +---@field is_open boolean ---Whether or not the statement has been finalized. ----@field is_closed boolean **READ-ONLY** +---**READ-ONLY** +---@field is_closed boolean --- ---Number of columns in the result set returned by the statement, ---or 0 if the statement does not return data (for example an UPDATE). ----@field columns integer **READ-ONLY** +---**READ-ONLY** +---@field columns integer --- ---rowid of the most recent INSERT into the database corresponding ---to this statement. ----@field last_insert_rowid integer **READ-ONLY** +---**READ-ONLY** +---@field last_insert_rowid integer --- ---A table with the names and types of all columns in the current ---result set of the statement. ----@field named_types table **READ-ONLY** +---**READ-ONLY** +---@field named_types table ---A table with names and values of all columns in the current ---result row of a query. ----@field named_values table **READ-ONLY** +---**READ-ONLY** +---@field named_values table --- ---A list of the names of all columns in the result set returned ---by the statement. ----@field names string[] **READ-ONLY** +---**READ-ONLY** +---@field names string[] ---A list of the values of all columns in the result set ---returned by the statement. ----@field values SQLiteValue[] **READ-ONLY** +---**READ-ONLY** +---@field values SQLiteValue[] ---A list of the types of all columns in the result set returned ---by the statement. ----@field types string[] **READ-ONLY** +---**READ-ONLY** +---@field types string[] --- ---A list of the names of all columns in the result set returned ---by the statement. ----@field unames string[] **READ-ONLY** +---**READ-ONLY** +---@field unames string[] ---A list of the types of all columns in the result set returned ---by the statement. ----@field utypes string[] **READ-ONLY** +---**READ-ONLY** +---@field utypes string[] ---A list of the values of all columns in the current result ---row of a query. ----@field uvalues SQLiteValue[] **READ-ONLY** +---**READ-ONLY** +---@field uvalues SQLiteValue[] local SQLiteStatement = {} ---### functions diff --git a/library/renoise/views/canvas.lua b/library/renoise/views/canvas.lua index 97e58ed..3eaaefb 100644 --- a/library/renoise/views/canvas.lua +++ b/library/renoise/views/canvas.lua @@ -96,12 +96,14 @@ function Canvas:update() end ---Size of the render context backend **in raw pixel resolution**. ---This is the view ports size, multiplied with the global UI scaling factor. ---It does not change with transformations. ----@field pixel_size { width: integer, height: integer } **READ-ONLY** +---**READ-ONLY** +---@field pixel_size { width: integer, height: integer } --- ---Size of the render context **with transformations applied**. ---This initially will be the view's size. Calls to `transform` or `scale` ---may change the size further. ----@field size { width: integer, height: integer } **READ_ONLY** +---**READ-ONLY** +---@field size { width: integer, height: integer } ---The degree of opacity applied to all drawing operations.
--- ---If an operation already uses a transparent color, this can make it diff --git a/library/renoise/views/view.lua b/library/renoise/views/view.lua index b884ad2..29df14e 100644 --- a/library/renoise/views/view.lua +++ b/library/renoise/views/view.lua @@ -8,9 +8,9 @@ error("Do not try to execute this file. It's just a type definition file.") -------------------------------------------------------------------------------- ----Unique identifier to resolve the view later on in the viewbuilder, +---Unique identifier to resolve the view later on in the viewbuilder, ---e.g. `vb.views.SomeString` or `vb.views["Some String"]` ----View ids must be unique within a single view builder instance. +---View ids must be unique within a single view builder instance. ---@alias ViewId string ---The dimensions of a view has to be larger than 0. @@ -20,9 +20,9 @@ error("Do not try to execute this file. It's just a type definition file.") ---@alias ViewDimension integer|string ---The dimensions of a view has to be larger than 0. ----For nested views you can also specify relative size, for example ----`vb:text { size = { width = "80%", height = 20}}`. ----The percentage values are relative to the view's parent size and will +---For nested views you can also specify relative size, for example +---`vb:text { size = { width = "80%", height = 20}}`. +---The percentage values are relative to the view's parent size and will ---automatically update when the parent view's size changes. ---@alias ViewSize { width: ViewDimension, height: ViewDimension }|{ [1]:ViewDimension, [2]:ViewDimension } @@ -81,7 +81,7 @@ error("Do not try to execute this file. It's just a type definition file.") ---* Default: true ---@alias ViewVisibility boolean ----Setup a background style for the view. +---Setup a background style for the view. ---@alias ViewBackgroundStyle ---| "invisible" # no background (Default) ---| "plain" # undecorated, single coloured background @@ -178,7 +178,8 @@ error("Do not try to execute this file. It's just a type definition file.") ---@field cursor ViewCursorShape ---Empty for all controls, for layout views this contains the ---layout child views in the order they got added ----@field views renoise.Views.View[] **READ-ONLY** +---**READ-ONLY** +---@field views renoise.Views.View[] local View = {} ---### functions @@ -203,7 +204,7 @@ function View:swap_views(child1, child2) end function View:add_child(child) end ---**Deprecated.** Use `remove_view` instead ----@deprecated +---@deprecated ---@param child renoise.Views.View function View:remove_child(child) end From 884c53d9113ea985e25eaccf8dca6be18c93f0f7 Mon Sep 17 00:00:00 2001 From: unlessgames Date: Fri, 18 Sep 2026 14:57:30 +0200 Subject: [PATCH 4/5] explicit types for numeric ranges --- library/renoise/song/instrument/midi_input.lua | 6 +++--- library/renoise/song/instrument/phrase.lua | 2 +- library/renoise/song/instrument/sample.lua | 13 +++++++------ library/renoise/song/pattern/automation.lua | 12 ++++++++---- library/renoise/song/sequencer.lua | 7 ++++--- library/renoise/song/transport.lua | 11 +++++++---- 6 files changed, 30 insertions(+), 21 deletions(-) diff --git a/library/renoise/song/instrument/midi_input.lua b/library/renoise/song/instrument/midi_input.lua index 4321e4d..78437cf 100644 --- a/library/renoise/song/instrument/midi_input.lua +++ b/library/renoise/song/instrument/midi_input.lua @@ -18,14 +18,14 @@ renoise.InstrumentMidiInputProperties = {} --- ---When setting new devices, device names must be one of ---`renoise.Midi.available_input_devices()` or "Renoise OSC Device". ----To close a device and disconnect it from the instrument, assign +---To close a device and disconnect it from the instrument, assign ---an empty string. ---@field device_name string ---@field device_name_observable renoise.Document.Observable ---@field channel integer Range: (1 - 16) 0 = Omni ---@field channel_observable renoise.Document.Observable ----Table of two numbers in range (0-119) where C-4 is 48 ----@field note_range integer[] +---Range: (0-119) where C-4 is 48 +---@field note_range {[1]: integer, [2]: integer} ---@field note_range_observable renoise.Document.Observable ---Range: (1 - song.sequencer_track_count) 0 = Current track ---@field assigned_track integer diff --git a/library/renoise/song/instrument/phrase.lua b/library/renoise/song/instrument/phrase.lua index dc6d4d7..deaff44 100644 --- a/library/renoise/song/instrument/phrase.lua +++ b/library/renoise/song/instrument/phrase.lua @@ -297,7 +297,7 @@ renoise.InstrumentPhraseMapping = { ---note_range start can only be set behind previous's (if any) end and ---note_range end can only be set before next mapping's (if any) start. ---Range: (0 - 119) where C-4 is 48 ----@field note_range integer[] +---@field note_range {[1]: integer, [2]: integer} ---@field note_range_observable renoise.Document.Observable **READ-ONLY** --- ---Loop mode. The phrase plays as one-shot when disabled. diff --git a/library/renoise/song/instrument/sample.lua b/library/renoise/song/instrument/sample.lua index 9b99530..4ca86da 100644 --- a/library/renoise/song/instrument/sample.lua +++ b/library/renoise/song/instrument/sample.lua @@ -207,12 +207,12 @@ renoise.SampleMapping = {} ---Note range the mapping is triggered for. ---table of two integers ---Range: (0 - 119) where C-4 is 48 ----@field note_range integer[] +---@field note_range {[1]: integer, [2]: integer} ---@field note_range_observable renoise.Document.Observable --- ---Velocity range the mapping is triggered for. ---Range: (0 - 127) ----@field velocity_range integer[] +---@field velocity_range {[1]: integer, [2]: integer} ---@field velocity_range_observable renoise.Document.Observable -------------------------------------------------------------------------------- @@ -272,8 +272,9 @@ renoise.SampleBuffer = { ---@field display_length integer Range: (1 - number_of_frames) ---@field display_length_observable renoise.Document.Observable --- ----Array of two integers, the start and end points of the sample editor display. ----@field display_range integer[] Range: (1 - number_of_frames) +---The start and end points of the sample editor display. +---Range: (1 - number_of_frames) +---@field display_range {[1]: integer, [2]: integer} ---@field display_range_observable renoise.Document.Observable --- ---The vertical zoom level where 1.0 is fully zoomed out. @@ -286,8 +287,8 @@ renoise.SampleBuffer = { ---@field selection_start_observable renoise.Document.Observable ---@field selection_end integer Range: (1 - number_of_frames) ---@field selection_end_observable renoise.Document.Observable ----Array of two integers ----@field selection_range integer[] Range: (1 - number_of_frames) +---Range: (1 - number_of_frames) +---@field selection_range {[1]: integer, [2]: integer} ---@field selection_range_observable renoise.Document.Observable --- ---The selected channel. diff --git a/library/renoise/song/pattern/automation.lua b/library/renoise/song/pattern/automation.lua index 5664bde..ece1b11 100644 --- a/library/renoise/song/pattern/automation.lua +++ b/library/renoise/song/pattern/automation.lua @@ -59,19 +59,23 @@ renoise.PatternTrackAutomation = { ---**READ-ONLY** ---@field length integer --- ----Selection range as visible in the automation editor. always valid. ----returns the automation range no selection is present in the UI. +---Selection range as visible in the automation editor, always valid. +---1 when no selection is present. ---Range: (1 - automation.length + 1) ---@field selection_start integer ---@field selection_start_observable renoise.Document.Observable **READ-ONLY** +---Selection range as visible in the automation editor, always valid. +---The automation's length + 1 when no selection is present. ---Range: (1 - automation.length + 1) ---@field selection_end integer ---@field selection_end_observable renoise.Document.Observable **READ-ONLY** --- +---Selection range as visible in the automation editor, always valid. ---Get or set selection range. when setting an empty table, the existing ---selection, if any, will be cleared. ----array of two numbers [] OR Range: (1 - automation.length + 1) ----@field selection_range integer[] +---The whole automation range when no selection is present. +---Range: (1 - automation.length + 1) +---@field selection_range {[1]: integer, [2]: integer} ---@field selection_range_observable renoise.Document.Observable **READ-ONLY** --- ---Get all points of the automation. When setting a new list of points, diff --git a/library/renoise/song/sequencer.lua b/library/renoise/song/sequencer.lua index 73da884..9afc66f 100644 --- a/library/renoise/song/sequencer.lua +++ b/library/renoise/song/sequencer.lua @@ -21,9 +21,10 @@ renoise.PatternSequencer = {} ---@field keep_sequence_sorted boolean ---@field keep_sequence_sorted_observable renoise.Document.Observable --- ----Access to the selected slots in the sequencer. When no selection is present ----`{0, 0}` is returned, else Range: (1 - #sequencer.pattern_sequence) ----@field selection_range integer[] +---Access to the selected slots in the sequencer. +---Range: (1 - #sequencer.pattern_sequence) +---The table will contain two zeros when no selection is present +---@field selection_range {[1]: integer, [2]: integer} ---@field selection_range_observable renoise.Document.Observable --- ---Pattern order list: Notifiers will only be fired when sequence positions are diff --git a/library/renoise/song/transport.lua b/library/renoise/song/transport.lua index 9a458db..771ce05 100644 --- a/library/renoise/song/transport.lua +++ b/library/renoise/song/transport.lua @@ -90,11 +90,14 @@ renoise.Transport = { ---@field loop_range renoise.SongPos[] {loop start, loop end} ---@field loop_start_beats number **READ-ONLY** Range: (0 - song_end_beats) ---@field loop_end_beats number **READ-ONLY** Range: (0 - song_end_beats) ----@field loop_range_beats number[] {loop start beats, loop end beats} +---{loop start beats, loop end beats} +---@field loop_range_beats {[1]: number, [2]: number} --- ---@field loop_sequence_start integer **READ-ONLY** 0 or Range: (1 - sequence length) ---@field loop_sequence_end integer **READ-ONLY** 0 or Range: (1 - sequence length) ----@field loop_sequence_range integer[] {} or Range(sequence start, sequence end) +---Range: (sequence_start - sequence_end) +---The table will contain two zeros when no sequence loop is selected +---@field loop_sequence_range {[1]: integer, [2]: integer} --- ---@field loop_pattern boolean Pattern Loop On/Off ---@field loop_pattern_observable renoise.Document.Observable **READ-ONLY** @@ -148,8 +151,8 @@ renoise.Transport = { ---Groove (aka Shuffle) ---@field groove_enabled boolean ---@field groove_enabled_observable renoise.Document.Observable **READ-ONLY** ----table with 4 numbers in Range: (0 - 1) ----@field groove_amounts number[] +---Range: (0 - 1) +---@field groove_amounts {[1]: number, [2]: number, [3]: number, [4]: number} ---Will be called as soon as any groove value changed. ---@field groove_assignment_observable renoise.Document.Observable **READ-ONLY** --- From 75bad41cae9e3e7d7917ba85c72a4399c48e7854 Mon Sep 17 00:00:00 2001 From: unlessgames Date: Fri, 18 Sep 2026 15:06:36 +0200 Subject: [PATCH 5/5] add missing read-only tags --- library/renoise/application/window.lua | 36 +++++++++---------- library/renoise/song/instrument.lua | 12 +++---- .../renoise/song/instrument/midi_output.lua | 16 ++++----- library/renoise/song/pattern/track.lua | 8 ++--- library/renoise/tool.lua | 18 +++++----- 5 files changed, 45 insertions(+), 45 deletions(-) diff --git a/library/renoise/application/window.lua b/library/renoise/application/window.lua index ebe468a..a8f5a55 100644 --- a/library/renoise/application/window.lua +++ b/library/renoise/application/window.lua @@ -93,26 +93,26 @@ renoise.ApplicationWindow = { --- ---Diskbrowser Panel. ---@field disk_browser_is_visible boolean ----@field disk_browser_is_visible_observable renoise.Document.Observable +---@field disk_browser_is_visible_observable renoise.Document.Observable **READ-ONLY** --- ---@field disk_browser_category renoise.ApplicationWindow.DiskBrowserCategory ----@field disk_browser_category_observable renoise.Document.Observable +---@field disk_browser_category_observable renoise.Document.Observable **READ-ONLY** --- ---InstrumentBox ---@field instrument_box_is_visible boolean ----@field instrument_box_is_visible_observable renoise.Document.Observable +---@field instrument_box_is_visible_observable renoise.Document.Observable **READ-ONLY** --- ---InstrumentBox slot size ---@field instrument_box_slot_size renoise.ApplicationWindow.InstrumentBoxSlotSize ----@field instrument_box_slot_size_observable renoise.Document.Observable +---@field instrument_box_slot_size_observable renoise.Document.Observable **READ-ONLY** --- ---Instrument Editor detaching. ---@field instrument_editor_is_detached boolean ----@field instrument_editor_is_detached_observable renoise.Document.Observable +---@field instrument_editor_is_detached_observable renoise.Document.Observable **READ-ONLY** --- ---InstrumentProperties (below InstrumentBox) ---@field instrument_properties_is_visible boolean ----@field instrument_properties_is_visible_observable renoise.Document.Observable +---@field instrument_properties_is_visible_observable renoise.Document.Observable **READ-ONLY** ---@field instrument_properties_show_volume_transpose boolean ---@field instrument_properties_show_trigger_options boolean ---@field instrument_properties_show_scale_options boolean @@ -125,47 +125,47 @@ renoise.ApplicationWindow = { --- ---SampleProperties (below SampleNavigator) ---@field sample_properties_is_visible boolean ----@field sample_properties_is_visible_observable renoise.Document.Observable +---@field sample_properties_is_visible_observable renoise.Document.Observable **READ-ONLY** --- ---Mixer View detaching. ---@field mixer_view_is_detached boolean ----@field mixer_view_is_detached_observable renoise.Document.Observable +---@field mixer_view_is_detached_observable renoise.Document.Observable **READ-ONLY** --- ---Frame with the scopes/master spectrum... ---@field upper_frame_is_visible boolean ----@field upper_frame_is_visible_observable renoise.Document.Observable +---@field upper_frame_is_visible_observable renoise.Document.Observable **READ-ONLY** ---@field active_upper_frame renoise.ApplicationWindow.UpperFrame ----@field active_upper_frame_observable renoise.Document.Observable +---@field active_upper_frame_observable renoise.Document.Observable **READ-ONLY** --- --Frame with the pattern editor, mixer... ---@field active_middle_frame renoise.ApplicationWindow.MiddleFrame ----@field active_middle_frame_observable renoise.Document.Observable +---@field active_middle_frame_observable renoise.Document.Observable **READ-ONLY** --- ---Frame with the DSP chain view, automation, etc. ---@field lower_frame_is_visible boolean ----@field lower_frame_is_visible_observable renoise.Document.Observable +---@field lower_frame_is_visible_observable renoise.Document.Observable **READ-ONLY** ---@field active_lower_frame renoise.ApplicationWindow.LowerFrame ----@field active_lower_frame_observable renoise.Document.Observable +---@field active_lower_frame_observable renoise.Document.Observable **READ-ONLY** --- ---Frame with Disk Browser and Instrument Box. ---@field right_frame_is_visible boolean ----@field right_frame_is_visible_observable renoise.Document.Observable +---@field right_frame_is_visible_observable renoise.Document.Observable **READ-ONLY** --- ---Pattern matrix, visible in pattern editor and mixer only... ---@field pattern_matrix_is_visible boolean ----@field pattern_matrix_is_visible_observable renoise.Document.Observable +---@field pattern_matrix_is_visible_observable renoise.Document.Observable **READ-ONLY** --- ---Pattern advanced edit, visible in pattern editor only... ---@field pattern_advanced_edit_is_visible boolean ----@field pattern_advanced_edit_is_visible_observable renoise.Document.Observable +---@field pattern_advanced_edit_is_visible_observable renoise.Document.Observable **READ-ONLY** --- ---Mixer views Pre/Post volume setting. ---@field mixer_view_post_fx boolean ----@field mixer_view_post_fx_observable renoise.Document.Observable +---@field mixer_view_post_fx_observable renoise.Document.Observable **READ-ONLY** --- ---Mixer fader type setting. ---@field mixer_fader_type renoise.ApplicationWindow.MixerFader ----@field mixer_fader_type_observable renoise.Document.Observable +---@field mixer_fader_type_observable renoise.Document.Observable **READ-ONLY** ---### functions diff --git a/library/renoise/song/instrument.lua b/library/renoise/song/instrument.lua index 65ee772..733aceb 100644 --- a/library/renoise/song/instrument.lua +++ b/library/renoise/song/instrument.lua @@ -56,27 +56,27 @@ renoise.Instrument = { ---Currently active tab in the instrument GUI (samples, plugin or MIDI). ---@see renoise. ---@field active_tab renoise.Instrument.Tab ----@field active_tab_observable renoise.Document.Observable +---@field active_tab_observable renoise.Document.Observable **READ-ONLY** -- ---Instrument's name. ---@field name string ----@field name_observable renoise.Document.Observable +---@field name_observable renoise.Document.Observable **READ-ONLY** -- ---Instrument's comment list. See renoise.song().comments for more info on ---how to get notified on changes and how to change it. ---@field comments string[] ----@field comments_observable renoise.Document.Observable +---@field comments_observable renoise.Document.Observable **READ-ONLY** -- ---Notifier which is called as soon as any paragraph in the comments change. ----@field comments_assignment_observable renoise.Document.Observable +---@field comments_assignment_observable renoise.Document.Observable **READ-ONLY** -- ---Set this to true to show the comments dialog after loading a song ---@field show_comments_after_loading boolean ----@field show_comments_after_loading_observable renoise.Document.Observable +---@field show_comments_after_loading_observable renoise.Document.Observable **READ-ONLY** --- ---Macro parameter pane visibility in the GUI. ---@field macros_visible boolean ----@field macros_visible_observable renoise.Document.Observable +---@field macros_visible_observable renoise.Document.Observable **READ-ONLY** --- ---Macro parameters. Array with size Instrument.NUMBER_OF_MACROS. ---**READ-ONLY** diff --git a/library/renoise/song/instrument/midi_output.lua b/library/renoise/song/instrument/midi_output.lua index 88951a9..c866ac5 100644 --- a/library/renoise/song/instrument/midi_output.lua +++ b/library/renoise/song/instrument/midi_output.lua @@ -31,29 +31,29 @@ renoise.InstrumentMidiOutputProperties = { -- channels are not configurable for ReWire MIDI, and instrument_type will -- always be "TYPE_INTERNAL" for ReWire devices. ---@field instrument_type renoise.InstrumentMidiOutputProperties.Type ----@field instrument_type_observable renoise.Document.Observable +---@field instrument_type_observable renoise.Document.Observable **READ-ONLY** --- -- When setting new devices, device names must be one of: -- renoise.Midi.available_output_devices. -- Devices are automatically opened when needed. To close a device, set its name -- to "", e.g. an empty string. ---@field device_name string ----@field device_name_observable renoise.Document.Observable +---@field device_name_observable renoise.Document.Observable **READ-ONLY** --- ---@field channel integer Range: (1 - 16) ----@field channel_observable renoise.Document.Observable +---@field channel_observable renoise.Document.Observable **READ-ONLY** --- ---@field transpose integer Range: (-120 - 120) ----@field transpose_observable renoise.Document.Observable +---@field transpose_observable renoise.Document.Observable **READ-ONLY** --- ---@field program integer Range: (1 - 128) 0 = OFF ----@field program_observable renoise.Document.Observable +---@field program_observable renoise.Document.Observable **READ-ONLY** --- ---@field bank integer Range: (1 - 65536) 0 = OFF ----@field bank_observable renoise.Document.Observable +---@field bank_observable renoise.Document.Observable **READ-ONLY** --- ---@field delay integer Range: (0 - 100) ----@field delay_observable renoise.Document.Observable +---@field delay_observable renoise.Document.Observable **READ-ONLY** --- ---@field duration integer Range: (1 - 8000) 8000 = INF ----@field duration_observable renoise.Document.Observable +---@field duration_observable renoise.Document.Observable **READ-ONLY** diff --git a/library/renoise/song/pattern/track.lua b/library/renoise/song/pattern/track.lua index 8307952..2bd1ed8 100644 --- a/library/renoise/song/pattern/track.lua +++ b/library/renoise/song/pattern/track.lua @@ -22,14 +22,14 @@ renoise.PatternTrack = {} --- ---Pattern index the pattern track is aliased or 0 when its not aliased. ---@field alias_pattern_index integer index or 0 when no alias is present ----@field alias_pattern_index_observable renoise.Document.Observable +---@field alias_pattern_index_observable renoise.Document.Observable **READ-ONLY** ---- ---@field color RGBColor? slot color of the pattern in the matrix, nil when no slot color is set ----@field color_observable renoise.Document.Observable +---@field color_observable renoise.Document.Observable **READ-ONLY** --- ---Returns true when all the track lines are empty. Does not look at automation. ---@field is_empty boolean ----@field is_empty_observable renoise.Document.Observable +---@field is_empty_observable renoise.Document.Observable **READ-ONLY** --- ---Get all lines in range [1, number_of_lines_in_pattern]. ---Use `renoise.Pattern:add/remove_line_notifier` for change notifications. @@ -38,7 +38,7 @@ renoise.PatternTrack = {} --- ---Automation. ---@field automation renoise.PatternTrackAutomation[] ----@field automation_observable renoise.Document.ObservableList +---@field automation_observable renoise.Document.ObservableList **READ-ONLY** ---### functions diff --git a/library/renoise/tool.lua b/library/renoise/tool.lua index 2b414f5..4257f28 100644 --- a/library/renoise/tool.lua +++ b/library/renoise/tool.lua @@ -26,21 +26,21 @@ error("Do not try to execute this file. It's just a type definition file.") ---notification fires, but 'renoise.song()' may not yet be available. --- ---See also 'renoise.tool().app_new_document_observable'. ----@field tool_finished_loading_observable renoise.Document.Observable +---@field tool_finished_loading_observable renoise.Document.Observable **READ-ONLY** --- ---Invoked right before a tool gets unloaded: either because it got disabled, ---reloaded or the application exists. You can cleanup resources or connections ---to other devices here if necessary. ----@field tool_will_unload_observable renoise.Document.Observable +---@field tool_will_unload_observable renoise.Document.Observable **READ-ONLY** --- ---Invoked as soon as the application becomes the foreground window. ---For example, when you ATL-TAB to it, or activate it with the mouse ---from another app to Renoise. ----@field app_became_active_observable renoise.Document.Observable +---@field app_became_active_observable renoise.Document.Observable **READ-ONLY** --- ---Invoked as soon as the application looses focus and another app ---becomes the foreground window. ----@field app_resigned_active_observable renoise.Document.Observable +---@field app_resigned_active_observable renoise.Document.Observable **READ-ONLY** --- ---Invoked periodically in the background, more often when the work load ---is low, less often when Renoise's work load is high. @@ -48,29 +48,29 @@ error("Do not try to execute this file. It's just a type definition file.") ---around 10 times per sec. ---You can do stuff in the background without blocking the application here. ---Be gentle and don't do CPU heavy stuff please! ----@field app_idle_observable renoise.Document.Observable +---@field app_idle_observable renoise.Document.Observable **READ-ONLY** --- ---Invoked each time before a new document gets created or loaded: this is the ---last time renoise.song() still points to the old song before a new one arrives. ---You can explicitly release notifiers to the old document here, or do your own ---housekeeping. Also called right before the application exits. ----@field app_release_document_observable renoise.Document.Observable +---@field app_release_document_observable renoise.Document.Observable **READ-ONLY** --- ---Invoked each time a new document (song) is created or loaded. In other words: ---each time the result of renoise.song() is changed. Also called when the script ---gets reloaded (only happens with the auto_reload debugging tools), in order ---to connect the new script instance to the already running document. ----@field app_new_document_observable renoise.Document.Observable +---@field app_new_document_observable renoise.Document.Observable **READ-ONLY** --- ---Invoked just before the application document (song) is saved. ---This is the last chance to make any changes that should be part of ---the saved song. You could for example write your tool data to ---`renoise.song().tool_data` here. ----@field app_will_save_document_observable renoise.Document.Observable +---@field app_will_save_document_observable renoise.Document.Observable **READ-ONLY** --- ---Invoked each time the app's document (song) is successfully saved. ---renoise.song().file_name will point to the filename that it was saved to. ----@field app_saved_document_observable renoise.Document.Observable +---@field app_saved_document_observable renoise.Document.Observable **READ-ONLY** --- ---Get or set an optional renoise.Document.DocumentNode object, which will be ---used as set of persistent "options" or preferences for your tool.