模块 paramset
参数集,例如参数菜单中的那些参数。
另请参阅 norns 脚本参考 其中包含 使用参数的示例。
函数
函数
- new (id, name)
-
构造函数。
参数:
- add (args)
-
添加通用参数。
帮助函数,用于向参数集添加参数
两种用法:
- 传递带有可选"action"函数的"param"表
- 传递键值表以生成"param"表。必需的键是"type"和"id"
参数:
- args
- add_number (id, name, min, max, default, formatter, wrap)
-
添加数字参数。
参数:
- add_option (id, name, options, default)
-
添加选项参数。
参数:
- add_control (id, name, controlspec, formatter)
-
添加控制参数。
参数:
- add_file (id, name, path)
-
添加文件参数。
参数:
- add_text (id, name, txt)
-
添加文本参数。
参数:
- id
- name
- txt
- add_taper (id, name, min, max, default, k, units)
-
添加渐变参数。
参数:
- add_trigger (id, name)
-
添加触发器参数。
参数:
- add_binary (id, name, behavior, default)
-
添加二进制参数
参数:
- add_separator (id, name)
-
添加分隔符。
id和name是可选的。
如果既没有提供id也没有提供name,
分隔符将被命名为'separator'
并且不会有唯一的参数索引。
具有自己参数索引的分隔符
可以被隐藏/显示。
参数:
- add_group (id, name, n)
-
添加参数组。
组不能嵌套,
即不能在组内创建组。
id和name是可选的。
如果既没有提供id也没有提供name,
组将被命名为'group'
并且不会有唯一的参数索引。
具有自己参数索引的组
可以被隐藏/显示。
参数:
- print ()
- 打印。
- list ()
- 列表。 列出参数ID
- get_id (index)
-
获取ID。
参数:
- index number
- string (index)
-
字符串。
参数:
- index
- set (index, v, silent)
-
设置。
参数:
- index
- v 值
- silent boolean
- set_raw (index, v, silent)
-
设置原始值(仅适用于控制类型)。
参数:
- index
- v 值
- silent boolean
- get (index)
-
获取。
参数:
- index
- get_raw (index)
-
获取原始值(仅适用于控制类型)。
参数:
- index
- delta (index, d)
-
增量。
参数:
- index
- d number 增量
- set_action (index, func)
-
设置动作。
参数:
- index
- func function 为此索引设置动作
- set_save (index, state)
-
设置保存状态。
参数:
- index
- state 为此索引设置保存状态
- t (index)
-
获取类型。
参数:
- index
- get_range (index)
-
获取范围
参数:
- index
- get_allow_pmap (index)
-
获取参数是否应该可以被pmap映射
参数:
- index
- hide (index)
-
设置可见性为隐藏。
参数:
- index
- show (index)
-
设置可见性为显示。
参数:
- index
- visible (index)
-
获取可见性。
参数默认可见。
参数:
- index
- write (filename, name)
-
写入磁盘。
参数:
- filename 绝对路径、数字(写入本地数据文件夹中的[脚本名]-[数字].pset)或nil(写入本地数据文件夹中的默认[脚本名].pset)
- name string
- read (filename, silent)
-
从磁盘读取。
参数:
- filename string 绝对路径、数字(从本地数据文件夹读取[脚本名]-[数字].pset)或nil(读取数据文件夹中pset-last.txt指定的参数集编号)
- silent boolean 如果为true,不触发参数动作
- delete (filename, name, pset_number)
-
从磁盘删除。
参数:
- filename 绝对路径、数字(本地数据文件夹中的[脚本名]-[数字].pset)或nil(本地数据文件夹中的默认[脚本名].pset)
- name string
- pset_number
- default ()
- 如果存在则读取默认参数集。
- bang ()
- 触发所有参数。
- clear ()
- 清除。