From e8e210ac4b7da320ac80c65ce605bbaccb6e7db8 Mon Sep 17 00:00:00 2001 From: Nik Silver Date: Sun, 13 Oct 2024 20:44:06 +0100 Subject: [PATCH] More Lua API doc improvements. (#1801) * Fix name of module pattern_time in API docs. * Correct ldoc descriptions for lib.util and softcut. * Explain lib.beatclock is old. * Include all param types in API documentation. --- doc/index.html | 67 +++++++-- doc/modules/arc.html | 13 +- doc/modules/audio.html | 13 +- doc/modules/clock.html | 13 +- doc/modules/controlspec.html | 13 +- doc/modules/core.crow.public.html | 13 +- doc/modules/core.crow.quote.html | 13 +- doc/modules/crow.html | 13 +- doc/modules/encoders.html | 13 +- doc/modules/engine.html | 13 +- doc/modules/gamepad.html | 13 +- doc/modules/grid.html | 13 +- doc/modules/hid.html | 13 +- doc/modules/keyboard.html | 13 +- doc/modules/lib.beatclock.html | 15 +- doc/modules/lib.container.defaulttable.html | 13 +- doc/modules/lib.container.deque.html | 13 +- doc/modules/lib.container.observable.html | 13 +- doc/modules/lib.container.watchtable.html | 13 +- doc/modules/lib.container.weaktable.html | 13 +- doc/modules/lib.elca.html | 13 +- doc/modules/lib.envgraph.html | 13 +- doc/modules/lib.er.html | 13 +- doc/modules/lib.fileselect.html | 13 +- doc/modules/lib.filtergraph.html | 13 +- doc/modules/lib.filters.html | 13 +- doc/modules/lib.formatters.html | 13 +- doc/modules/lib.graph.html | 13 +- doc/modules/lib.intonation.html | 13 +- doc/modules/lib.lattice.html | 13 +- doc/modules/lib.lfo.html | 13 +- doc/modules/lib.listselect.html | 13 +- doc/modules/lib.musicutil.html | 13 +- ...lib.pattern.html => lib.pattern_time.html} | 15 +- doc/modules/lib.reflection.html | 13 +- doc/modules/lib.sequins.html | 13 +- doc/modules/lib.tabutil.html | 13 +- doc/modules/lib.test.luaunit.html | 13 +- doc/modules/lib.textentry.html | 13 +- doc/modules/lib.textentry_kbd.html | 13 +- doc/modules/lib.timeline.html | 13 +- doc/modules/lib.ui.html | 13 +- doc/modules/lib.util.html | 48 ++++++- doc/modules/lib.voice.html | 13 +- doc/modules/metro.html | 13 +- doc/modules/midi.html | 13 +- doc/modules/norns.html | 13 +- doc/modules/osc.html | 13 +- doc/modules/params.binary.html | 128 ++++++++++++++++++ doc/modules/params.control.html | 17 ++- doc/modules/params.file.html | 128 ++++++++++++++++++ doc/modules/params.group.html | 128 ++++++++++++++++++ doc/modules/params.number.html | 128 ++++++++++++++++++ doc/modules/params.option.html | 128 ++++++++++++++++++ doc/modules/params.separator.html | 128 ++++++++++++++++++ doc/modules/params.taper.html | 128 ++++++++++++++++++ doc/modules/params.text.html | 128 ++++++++++++++++++ doc/modules/params.trigger.html | 128 ++++++++++++++++++ doc/modules/paramset.html | 15 +- doc/modules/poll.html | 13 +- doc/modules/screen.html | 13 +- doc/modules/script.html | 13 +- doc/modules/softcut.html | 20 ++- lua/core/params/binary.lua | 9 +- lua/core/params/control.lua | 4 +- lua/core/params/file.lua | 7 +- lua/core/params/group.lua | 7 +- lua/core/params/number.lua | 7 +- lua/core/params/option.lua | 7 +- lua/core/params/separator.lua | 7 +- lua/core/params/taper.lua | 8 +- lua/core/params/text.lua | 7 +- lua/core/params/trigger.lua | 7 +- lua/core/paramset.lua | 2 +- lua/core/softcut.lua | 2 +- lua/lib/beatclock.lua | 3 +- lua/lib/pattern_time.lua | 3 +- lua/lib/util.lua | 2 +- 78 files changed, 1894 insertions(+), 148 deletions(-) rename doc/modules/{lib.pattern.html => lib.pattern_time.html} (91%) create mode 100644 doc/modules/params.binary.html create mode 100644 doc/modules/params.file.html create mode 100644 doc/modules/params.group.html create mode 100644 doc/modules/params.number.html create mode 100644 doc/modules/params.option.html create mode 100644 doc/modules/params.separator.html create mode 100644 doc/modules/params.taper.html create mode 100644 doc/modules/params.text.html create mode 100644 doc/modules/params.trigger.html diff --git a/doc/index.html b/doc/index.html index f7ad55316..9eb8f4d58 100644 --- a/doc/index.html +++ b/doc/index.html @@ -49,7 +49,16 @@

Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -74,7 +83,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -165,13 +174,49 @@

    Modules

    osc osc device + + params.binary + Binary (toggling) parameters + params.control - Control class + Parameter with granular control + + + params.file + An easy way to load files into scripts via parameters + + + params.group + Groups of parameters + + + params.number + Defines parameters which require discrete incrementing values + + + params.option + Select a parameter from a list + + + params.separator + Separator between parameters + + + params.taper + Non-linear parameter using @catfact's taper function + + + params.text + Parameter for text entry + + + params.trigger + Parameter for an “on/off” action trigger paramset - ParamSet class + Sets of parameters, such as those in the PARAMETERS menu. poll @@ -189,17 +234,11 @@

    Modules

    softcut - Softcut module

    - -

    API for controlling the "softcut" buffer processor - includes low-level setters and mid-level utilities

    - -

    IMPORTANT: all indices are 1-based, per lua convention! - this applies to indices for selecting voice, ADC/DAC channel, buffer, &c. + Softcut module. lib.beatclock - BeatClock + Older clock library - see clock instead lib.container.defaulttable @@ -274,7 +313,7 @@

    Modules

    Music utility module. - lib.pattern + lib.pattern_time timed pattern event recorder/player @@ -314,7 +353,7 @@

    Modules

    lib.util - db to amp. + Utility functions. lib.voice @@ -326,7 +365,7 @@

    Modules

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/arc.html b/doc/modules/arc.html index 4b84adf77..3a770c4a4 100644 --- a/doc/modules/arc.html +++ b/doc/modules/arc.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -369,7 +378,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/audio.html b/doc/modules/audio.html index 67987e1f1..95d12383a 100644 --- a/doc/modules/audio.html +++ b/doc/modules/audio.html @@ -61,7 +61,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -86,7 +95,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -1031,7 +1040,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/clock.html b/doc/modules/clock.html index 85263e2fe..69f1253e8 100644 --- a/doc/modules/clock.html +++ b/doc/modules/clock.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -399,7 +408,7 @@

    Fields

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/controlspec.html b/doc/modules/controlspec.html index 8896feba6..4f19eb5b5 100644 --- a/doc/modules/controlspec.html +++ b/doc/modules/controlspec.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -647,7 +656,7 @@

    Presets

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/core.crow.public.html b/doc/modules/core.crow.public.html index aca8f9102..b8eebc8f9 100644 --- a/doc/modules/core.crow.public.html +++ b/doc/modules/core.crow.public.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -267,7 +276,7 @@

    Fields:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/core.crow.quote.html b/doc/modules/core.crow.quote.html index e27dd3fe1..66e2cc1f2 100644 --- a/doc/modules/core.crow.quote.html +++ b/doc/modules/core.crow.quote.html @@ -52,7 +52,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -77,7 +86,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -114,7 +123,7 @@

    Module core.crow.quote

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/crow.html b/doc/modules/crow.html index b345ded3d..c15839499 100644 --- a/doc/modules/crow.html +++ b/doc/modules/crow.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -215,7 +224,7 @@

    Fields:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/encoders.html b/doc/modules/encoders.html index 14a97c6a2..18d4429a7 100644 --- a/doc/modules/encoders.html +++ b/doc/modules/encoders.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -246,7 +255,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/engine.html b/doc/modules/engine.html index e8fb4adca..8f67a6e3d 100644 --- a/doc/modules/engine.html +++ b/doc/modules/engine.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -332,7 +341,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/gamepad.html b/doc/modules/gamepad.html index bba68632d..fc8ba4d79 100644 --- a/doc/modules/gamepad.html +++ b/doc/modules/gamepad.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -421,7 +430,7 @@

    Fields:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/grid.html b/doc/modules/grid.html index f47da33c8..887d72b59 100644 --- a/doc/modules/grid.html +++ b/doc/modules/grid.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -373,7 +382,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/hid.html b/doc/modules/hid.html index c86cbd25c..b90066309 100644 --- a/doc/modules/hid.html +++ b/doc/modules/hid.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -201,7 +210,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/keyboard.html b/doc/modules/keyboard.html index 15f2946cf..e10903f01 100644 --- a/doc/modules/keyboard.html +++ b/doc/modules/keyboard.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -316,7 +325,7 @@

    Tables

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.beatclock.html b/doc/modules/lib.beatclock.html index aab7e581e..69db1dab4 100644 --- a/doc/modules/lib.beatclock.html +++ b/doc/modules/lib.beatclock.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -99,7 +108,7 @@

    Modules

    Module lib.beatclock

    -

    BeatClock

    +

    Older clock library - see clock instead

    @@ -394,7 +403,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.container.defaulttable.html b/doc/modules/lib.container.defaulttable.html index 5e82e3592..35c00ba6a 100644 --- a/doc/modules/lib.container.defaulttable.html +++ b/doc/modules/lib.container.defaulttable.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -165,7 +174,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.container.deque.html b/doc/modules/lib.container.deque.html index 11ead4ab4..c9806a192 100644 --- a/doc/modules/lib.container.deque.html +++ b/doc/modules/lib.container.deque.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -457,7 +466,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.container.observable.html b/doc/modules/lib.container.observable.html index 2115c0cbf..fc914906a 100644 --- a/doc/modules/lib.container.observable.html +++ b/doc/modules/lib.container.observable.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -326,7 +335,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.container.watchtable.html b/doc/modules/lib.container.watchtable.html index b308531f4..3570056ad 100644 --- a/doc/modules/lib.container.watchtable.html +++ b/doc/modules/lib.container.watchtable.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -163,7 +172,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.container.weaktable.html b/doc/modules/lib.container.weaktable.html index cb919ba1a..80c132472 100644 --- a/doc/modules/lib.container.weaktable.html +++ b/doc/modules/lib.container.weaktable.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -157,7 +166,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.elca.html b/doc/modules/lib.elca.html index 72620493e..089b8a20d 100644 --- a/doc/modules/lib.elca.html +++ b/doc/modules/lib.elca.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -326,7 +335,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.envgraph.html b/doc/modules/lib.envgraph.html index e66316d1e..9c67244c3 100644 --- a/doc/modules/lib.envgraph.html +++ b/doc/modules/lib.envgraph.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -726,7 +735,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.er.html b/doc/modules/lib.er.html index 726f1d63d..35348d45d 100644 --- a/doc/modules/lib.er.html +++ b/doc/modules/lib.er.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -163,7 +172,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.fileselect.html b/doc/modules/lib.fileselect.html index 51d2ab632..509c7b2d6 100644 --- a/doc/modules/lib.fileselect.html +++ b/doc/modules/lib.fileselect.html @@ -52,7 +52,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -77,7 +86,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -111,7 +120,7 @@

    Module lib.fileselect

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.filtergraph.html b/doc/modules/lib.filtergraph.html index 776dc5f60..0cece949d 100644 --- a/doc/modules/lib.filtergraph.html +++ b/doc/modules/lib.filtergraph.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -320,7 +329,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.filters.html b/doc/modules/lib.filters.html index cb323f2a9..0ee3cdd98 100644 --- a/doc/modules/lib.filters.html +++ b/doc/modules/lib.filters.html @@ -59,7 +59,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -84,7 +93,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -327,7 +336,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.formatters.html b/doc/modules/lib.formatters.html index a9d6e1100..48eeef146 100644 --- a/doc/modules/lib.formatters.html +++ b/doc/modules/lib.formatters.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -487,7 +496,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.graph.html b/doc/modules/lib.graph.html index e2f40fbe8..df4225f08 100644 --- a/doc/modules/lib.graph.html +++ b/doc/modules/lib.graph.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -1345,7 +1354,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.intonation.html b/doc/modules/lib.intonation.html index 1e6d3d899..e33728bae 100644 --- a/doc/modules/lib.intonation.html +++ b/doc/modules/lib.intonation.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -346,7 +355,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.lattice.html b/doc/modules/lib.lattice.html index 864439a9e..56ce37c4c 100644 --- a/doc/modules/lib.lattice.html +++ b/doc/modules/lib.lattice.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -628,7 +637,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.lfo.html b/doc/modules/lib.lfo.html index 69e4af160..dcbfb285a 100644 --- a/doc/modules/lib.lfo.html +++ b/doc/modules/lib.lfo.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -375,7 +384,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.listselect.html b/doc/modules/lib.listselect.html index f630ac81e..e4b37395e 100644 --- a/doc/modules/lib.listselect.html +++ b/doc/modules/lib.listselect.html @@ -52,7 +52,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -77,7 +86,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -111,7 +120,7 @@

    Module lib.listselect

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.musicutil.html b/doc/modules/lib.musicutil.html index 9b1d37f9b..e14df33a1 100644 --- a/doc/modules/lib.musicutil.html +++ b/doc/modules/lib.musicutil.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -772,7 +781,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.pattern.html b/doc/modules/lib.pattern_time.html similarity index 91% rename from doc/modules/lib.pattern.html rename to doc/modules/lib.pattern_time.html index c039669c8..db1a8ca6e 100644 --- a/doc/modules/lib.pattern.html +++ b/doc/modules/lib.pattern_time.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -98,7 +107,7 @@

    Modules

    -

    Module lib.pattern

    +

    Module lib.pattern_time

    timed pattern event recorder/player

    The norns script reference has examples for this module.

    @@ -377,7 +386,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.reflection.html b/doc/modules/lib.reflection.html index 29296a7b6..daff93a52 100644 --- a/doc/modules/lib.reflection.html +++ b/doc/modules/lib.reflection.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -467,7 +476,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.sequins.html b/doc/modules/lib.sequins.html index 90b3339f4..c2b2a181f 100644 --- a/doc/modules/lib.sequins.html +++ b/doc/modules/lib.sequins.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -153,7 +162,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.tabutil.html b/doc/modules/lib.tabutil.html index d9ab18d87..84960c062 100644 --- a/doc/modules/lib.tabutil.html +++ b/doc/modules/lib.tabutil.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -574,7 +583,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.test.luaunit.html b/doc/modules/lib.test.luaunit.html index 8d00802c4..c6d2e9a82 100644 --- a/doc/modules/lib.test.luaunit.html +++ b/doc/modules/lib.test.luaunit.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -309,7 +318,7 @@

    Fields:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.textentry.html b/doc/modules/lib.textentry.html index 73747cb3b..ee058b60c 100644 --- a/doc/modules/lib.textentry.html +++ b/doc/modules/lib.textentry.html @@ -52,7 +52,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -77,7 +86,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -111,7 +120,7 @@

    Module lib.textentry

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.textentry_kbd.html b/doc/modules/lib.textentry_kbd.html index e23249ede..bc3e0b15c 100644 --- a/doc/modules/lib.textentry_kbd.html +++ b/doc/modules/lib.textentry_kbd.html @@ -52,7 +52,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -77,7 +86,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -113,7 +122,7 @@

    Module lib.textentry_kbd

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.timeline.html b/doc/modules/lib.timeline.html index f88bf068b..1ac4c2e1d 100644 --- a/doc/modules/lib.timeline.html +++ b/doc/modules/lib.timeline.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -297,7 +306,7 @@

    Fields:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.ui.html b/doc/modules/lib.ui.html index 0c9b6426e..a1613a7f1 100644 --- a/doc/modules/lib.ui.html +++ b/doc/modules/lib.ui.html @@ -63,7 +63,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -88,7 +97,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -1249,7 +1258,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.util.html b/doc/modules/lib.util.html index 8c8e21789..b7a1ba274 100644 --- a/doc/modules/lib.util.html +++ b/doc/modules/lib.util.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -99,7 +108,7 @@

    Modules

    Module lib.util

    -

    db to amp.

    +

    Utility functions.

    @@ -107,6 +116,10 @@

    Module lib.util

    Functions

    + + + + @@ -200,6 +213,35 @@

    Functions

    Functions

    +
    + + dbamp (db) +
    +
    + db to amp. + + +

    Parameters:

    +
      +
    • db + number + + + +
      • +
    + +

    Returns:

    +
      + + number + amp +
    + + + + +
    time () @@ -884,7 +926,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/lib.voice.html b/doc/modules/lib.voice.html index b752099b4..c186d0d6a 100644 --- a/doc/modules/lib.voice.html +++ b/doc/modules/lib.voice.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -263,7 +272,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/metro.html b/doc/modules/metro.html index 709d5cb85..4e82798a5 100644 --- a/doc/modules/metro.html +++ b/doc/modules/metro.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -300,7 +309,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/midi.html b/doc/modules/midi.html index ce558cbbd..7b06aec31 100644 --- a/doc/modules/midi.html +++ b/doc/modules/midi.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -708,7 +717,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/norns.html b/doc/modules/norns.html index 5c1f83271..5c7d6314b 100644 --- a/doc/modules/norns.html +++ b/doc/modules/norns.html @@ -57,7 +57,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -82,7 +91,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -329,7 +338,7 @@

    Fields

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/osc.html b/doc/modules/osc.html index cdaab0963..6d9ae7b9f 100644 --- a/doc/modules/osc.html +++ b/doc/modules/osc.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -207,7 +216,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/params.binary.html b/doc/modules/params.binary.html new file mode 100644 index 000000000..cd6ab2779 --- /dev/null +++ b/doc/modules/params.binary.html @@ -0,0 +1,128 @@ + + + + + norns/docs + + + + + + + diff --git a/doc/modules/params.control.html b/doc/modules/params.control.html index cea0661f0..0716f1182 100644 --- a/doc/modules/params.control.html +++ b/doc/modules/params.control.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -99,10 +108,10 @@

    Modules

    Module params.control

    -

    Control class

    +

    Parameter with granular control

    See also the norns script reference which has - examples for using params.

    + examples for this module.

    Functions

    @@ -454,7 +463,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/params.file.html b/doc/modules/params.file.html new file mode 100644 index 000000000..dcca94373 --- /dev/null +++ b/doc/modules/params.file.html @@ -0,0 +1,128 @@ + + + + + norns/docs + + + + + + + diff --git a/doc/modules/params.group.html b/doc/modules/params.group.html new file mode 100644 index 000000000..cb2ef9c18 --- /dev/null +++ b/doc/modules/params.group.html @@ -0,0 +1,128 @@ + + + + + norns/docs + + + + + + + diff --git a/doc/modules/params.number.html b/doc/modules/params.number.html new file mode 100644 index 000000000..9291bed46 --- /dev/null +++ b/doc/modules/params.number.html @@ -0,0 +1,128 @@ + + + + + norns/docs + + + + + + + diff --git a/doc/modules/params.option.html b/doc/modules/params.option.html new file mode 100644 index 000000000..f56cbd9b6 --- /dev/null +++ b/doc/modules/params.option.html @@ -0,0 +1,128 @@ + + + + + norns/docs + + + + + + + diff --git a/doc/modules/params.separator.html b/doc/modules/params.separator.html new file mode 100644 index 000000000..8db9909bb --- /dev/null +++ b/doc/modules/params.separator.html @@ -0,0 +1,128 @@ + + + + + norns/docs + + + + + + + diff --git a/doc/modules/params.taper.html b/doc/modules/params.taper.html new file mode 100644 index 000000000..37948d1bf --- /dev/null +++ b/doc/modules/params.taper.html @@ -0,0 +1,128 @@ + + + + + norns/docs + + + + + + + diff --git a/doc/modules/params.text.html b/doc/modules/params.text.html new file mode 100644 index 000000000..12f430fb1 --- /dev/null +++ b/doc/modules/params.text.html @@ -0,0 +1,128 @@ + + + + + norns/docs + + + + + + + diff --git a/doc/modules/params.trigger.html b/doc/modules/params.trigger.html new file mode 100644 index 000000000..d7991a04a --- /dev/null +++ b/doc/modules/params.trigger.html @@ -0,0 +1,128 @@ + + + + + norns/docs + + + + + + + diff --git a/doc/modules/paramset.html b/doc/modules/paramset.html index 17b30e8c5..bf3b9a195 100644 --- a/doc/modules/paramset.html +++ b/doc/modules/paramset.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -99,7 +108,7 @@

    Modules

    Module paramset

    -

    ParamSet class

    +

    Sets of parameters, such as those in the PARAMETERS menu.

    See also the norns script reference which has examples for using params.

    @@ -1197,7 +1206,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/poll.html b/doc/modules/poll.html index 4c4f17c97..afc8aedf6 100644 --- a/doc/modules/poll.html +++ b/doc/modules/poll.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -244,7 +253,7 @@

    Parameters:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/screen.html b/doc/modules/screen.html index 9cd84d586..7bfcd8a2f 100644 --- a/doc/modules/screen.html +++ b/doc/modules/screen.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -1524,7 +1533,7 @@

    Usage:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/script.html b/doc/modules/script.html index 126d933f1..3474089e5 100644 --- a/doc/modules/script.html +++ b/doc/modules/script.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -216,7 +225,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/doc/modules/softcut.html b/doc/modules/softcut.html index c5a0b77f6..98c371536 100644 --- a/doc/modules/softcut.html +++ b/doc/modules/softcut.html @@ -56,7 +56,16 @@

    Modules

  • midi
  • norns
  • osc
    • +
  • params.binary
  • params.control
    • +
  • params.file
    • +
  • params.group
    • +
  • params.number
    • +
  • params.option
    • +
  • params.separator
    • +
  • params.taper
    • +
  • params.text
    • +
  • params.trigger
  • paramset
  • poll
  • screen
    • @@ -81,7 +90,7 @@

    Modules

  • lib.lfo
  • lib.listselect
  • lib.musicutil
    • -
  • lib.pattern
    • +
  • lib.pattern_time
  • lib.reflection
  • lib.sequins
  • lib.tabutil
    • @@ -99,14 +108,13 @@

    Modules

    Module softcut

    -

    Softcut module

    - +

    Softcut module.

    API for controlling the "softcut" buffer processor includes low-level setters and mid-level utilities

    IMPORTANT: all indices are 1-based, per lua convention! - this applies to indices for selecting voice, ADC/DAC channel, buffer, &c.

    -

    however, quantities (including units of time) can still start at zero.

    + this applies to indices for selecting voice, ADC/DAC channel, buffer, &c. + however, quantities (including units of time) can still start at zero.

    @@ -1979,7 +1987,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2024-10-06 20:11:00 +Last updated 2024-10-13 17:45:04
    diff --git a/lua/core/params/binary.lua b/lua/core/params/binary.lua index 1ce4f8036..69e2e0a8b 100755 --- a/lua/core/params/binary.lua +++ b/lua/core/params/binary.lua @@ -1,5 +1,10 @@ --- Binary class --- @module params.toggle +--- Binary (toggling) parameters +-- +-- See also the [norns script reference](https://monome.org/docs/norns/reference/) +-- which has +-- [examples for using params](https://monome.org/docs/norns/reference/params). +-- +-- @module params.binary local Binary = {} Binary.__index = Binary diff --git a/lua/core/params/control.lua b/lua/core/params/control.lua index ae0e8f248..46b5d1185 100755 --- a/lua/core/params/control.lua +++ b/lua/core/params/control.lua @@ -1,8 +1,8 @@ ---- Control class +--- Parameter with granular control -- -- See also the [norns script reference](https://monome.org/docs/norns/reference/) -- which has --- [examples for using params](https://monome.org/docs/norns/reference/params). +-- [examples for this module](https://monome.org/docs/norns/reference/parameters/control). -- -- @module params.control -- @alias Control diff --git a/lua/core/params/file.lua b/lua/core/params/file.lua index ef98608ca..e8c47f4d0 100644 --- a/lua/core/params/file.lua +++ b/lua/core/params/file.lua @@ -1,4 +1,9 @@ --- File class +--- An easy way to load files into scripts via parameters +-- +-- See also the [norns script reference](https://monome.org/docs/norns/reference/) +-- which has +-- [examples for this module](https://monome.org/docs/norns/reference/parameters/file). +-- -- @module params.file local File = {} diff --git a/lua/core/params/group.lua b/lua/core/params/group.lua index 39ac404ec..89e25e292 100644 --- a/lua/core/params/group.lua +++ b/lua/core/params/group.lua @@ -1,4 +1,9 @@ --- Group class +--- Groups of parameters +-- +-- See also the [norns script reference](https://monome.org/docs/norns/reference/) +-- which has +-- [examples for using params](https://monome.org/docs/norns/reference/params). +-- -- @module params.group local Group = {} diff --git a/lua/core/params/number.lua b/lua/core/params/number.lua index ac83cf234..c2d9ea2c7 100755 --- a/lua/core/params/number.lua +++ b/lua/core/params/number.lua @@ -1,4 +1,9 @@ --- Number class +--- Defines parameters which require discrete incrementing values +-- +-- See also the [norns script reference](https://monome.org/docs/norns/reference/) +-- which has +-- [examples for this module](https://monome.org/docs/norns/reference/parameters/number). +-- -- @module params.number local Number = {} diff --git a/lua/core/params/option.lua b/lua/core/params/option.lua index 97d1fb666..d9a09a5e3 100755 --- a/lua/core/params/option.lua +++ b/lua/core/params/option.lua @@ -1,4 +1,9 @@ --- Option class +--- Select a parameter from a list +-- +-- See also the [norns script reference](https://monome.org/docs/norns/reference/) +-- which has +-- [examples for this module](https://monome.org/docs/norns/reference/parameters/option). +-- -- @module params.option local tab = require 'tabutil' diff --git a/lua/core/params/separator.lua b/lua/core/params/separator.lua index 70cc03bf0..96e344901 100644 --- a/lua/core/params/separator.lua +++ b/lua/core/params/separator.lua @@ -1,4 +1,9 @@ --- Separator class +--- Separator between parameters +-- +-- See also the [norns script reference](https://monome.org/docs/norns/reference/) +-- which has +-- [examples for using params](https://monome.org/docs/norns/reference/params). +-- -- @module params.separator local Separator = {} diff --git a/lua/core/params/taper.lua b/lua/core/params/taper.lua index 6edffb4ab..36e17f3c1 100644 --- a/lua/core/params/taper.lua +++ b/lua/core/params/taper.lua @@ -1,5 +1,9 @@ --- Taper class --- non-linear parameter using @catfact's taper function +--- Non-linear parameter using @catfact's taper function +-- +-- See also the [norns script reference](https://monome.org/docs/norns/reference/) +-- which has +-- [examples for using params](https://monome.org/docs/norns/reference/params). +-- -- @module params.taper local util = require 'util' diff --git a/lua/core/params/text.lua b/lua/core/params/text.lua index 7ead2f966..be49677f8 100644 --- a/lua/core/params/text.lua +++ b/lua/core/params/text.lua @@ -1,4 +1,9 @@ --- Text class +--- Parameter for text entry +-- +-- See also the [norns script reference](https://monome.org/docs/norns/reference/) +-- which has +-- [examples for using params](https://monome.org/docs/norns/reference/params). +-- -- @module params.text local Text = {} diff --git a/lua/core/params/trigger.lua b/lua/core/params/trigger.lua index 72bb4104b..2b8fd0637 100755 --- a/lua/core/params/trigger.lua +++ b/lua/core/params/trigger.lua @@ -1,4 +1,9 @@ --- Trigger class +--- Parameter for an “on/off” action trigger +-- +-- See also the [norns script reference](https://monome.org/docs/norns/reference/) +-- which has +-- [examples for using params](https://monome.org/docs/norns/reference/params). +-- -- @module params.trigger local Trigger = {} diff --git a/lua/core/paramset.lua b/lua/core/paramset.lua index 999f5343f..a648ba725 100755 --- a/lua/core/paramset.lua +++ b/lua/core/paramset.lua @@ -1,4 +1,4 @@ ---- ParamSet class +--- Sets of parameters, such as those in the PARAMETERS menu. -- -- See also the [norns script reference](https://monome.org/docs/norns/reference/) -- which has diff --git a/lua/core/softcut.lua b/lua/core/softcut.lua index 749497c84..889acd328 100644 --- a/lua/core/softcut.lua +++ b/lua/core/softcut.lua @@ -1,4 +1,4 @@ ---- Softcut module +--- Softcut module. -- -- API for controlling the "softcut" buffer processor -- includes low-level setters and mid-level utilities diff --git a/lua/lib/beatclock.lua b/lua/lib/beatclock.lua index 2af747c87..eb42d74fc 100644 --- a/lua/lib/beatclock.lua +++ b/lua/lib/beatclock.lua @@ -1,4 +1,5 @@ ---- BeatClock +--- Older clock library - see @{clock} instead +-- -- @module lib.beatclock -- @alias BeatClock diff --git a/lua/lib/pattern_time.lua b/lua/lib/pattern_time.lua index 2c721c5f0..a67d3a174 100644 --- a/lua/lib/pattern_time.lua +++ b/lua/lib/pattern_time.lua @@ -3,7 +3,8 @@ -- The [norns script reference](https://monome.org/docs/norns/reference/) -- has [examples for this module](https://monome.org/docs/norns/reference/lib/pattern_time). -- --- @module lib.pattern +-- @module lib.pattern_time +-- @alias pattern local pattern = {} pattern.__index = pattern diff --git a/lua/lib/util.lua b/lua/lib/util.lua index ca46af089..c78558c3f 100644 --- a/lua/lib/util.lua +++ b/lua/lib/util.lua @@ -1,4 +1,4 @@ --- Utility module +--- Utility functions. -- @module lib.util util = {}
    dbamp (db)db to amp.
    time () get system time in fractional seconds