Retrieve the values of items in a chunk and store the results in a single array.
Name of the chunk.
In chunk modules, the chunk name is case sensitive. This means that MYCHUNK is not equivalent to mychunk or MyChunk.
Names of the items to retrieve or on which the operation is performed, expressed as a comma-text.
In chunk modules, the item names are case sensitive. This means that item1 is not equivalent to Item1 or ITEM1.
To avoid mismatch between names and RegEx ^, ., $, *, +, ?, (, ), [, ], {, }, \, | are not allowed in the names.
can be a RegEx (Regular Expression)
see regular expression.
^a.* match any string starting by "a" (?i)^a match any string starting by "a" or "A" (case insensitive).*a$ match any string ending by "a".*\d$ match any string ending by a number "1","2","3", etc..at matches any three-character string ending with "at", including "hat", "cat", "bat", "4at", "#at" and " at" (starting with a space).[hc]at matches "hat" and "cat".[^b]at matches all strings matched by .at except "bat".[^hc]at matches all strings matched by .at other than "hat" and "cat".^[hc]at matches "hat" and "cat", but only at the beginning of the string or line.[hc]at$ matches "hat" and "cat", but only at the end of the string or line.\[.\] matches any single character surrounded by "[" and "]" since the brackets are escaped, for example: "[a]", "[b]", "[7]", "[@]", "[]]", and "[ ]" (bracket space bracket).s.* matches s followed by zero or more characters, for example: "s", "saw", "seed", "s3w96.7", and "s6#h%(>>>m n mQ".[hc]?at matches "at", "hat", and "cat".[hc]*at matches "at", "hat", "cat", "hhat", "chat", "hcat", "cchchat", and so on.[hc]+at matches "hat", "cat", "hhat", "chat", "hcat", "cchchat", and so on, but not "at".cat|dog matches "cat" or "dog".\\ to search the \ char (backslash)can be a RegEx (Regular Expression)
see regular expression.
^a.* match any string starting by "a" (?i)^a match any string starting by "a" or "A" (case insensitive).*a$ match any string ending by "a".*\d$ match any string ending by a number "1","2","3", etc..at matches any three-character string ending with "at", including "hat", "cat", "bat", "4at", "#at" and " at" (starting with a space).[hc]at matches "hat" and "cat".[^b]at matches all strings matched by .at except "bat".[^hc]at matches all strings matched by .at other than "hat" and "cat".^[hc]at matches "hat" and "cat", but only at the beginning of the string or line.[hc]at$ matches "hat" and "cat", but only at the end of the string or line.\[.\] matches any single character surrounded by "[" and "]" since the brackets are escaped, for example: "[a]", "[b]", "[7]", "[@]", "[]]", and "[ ]" (bracket space bracket).s.* matches s followed by zero or more characters, for example: "s", "saw", "seed", "s3w96.7", and "s6#h%(>>>m n mQ".[hc]?at matches "at", "hat", and "cat".[hc]*at matches "at", "hat", "cat", "hhat", "chat", "hcat", "cchchat", and so on.[hc]+at matches "hat", "cat", "hhat", "chat", "hcat", "cchchat", and so on, but not "at".cat|dog matches "cat" or "dog".\\ to search the \ char (backslash)Outputs an array of 0 and 1 values indicating whether the get operation was performed correctly (1) or not (0, for example if the item is not found).
Forces the module to retrieve chunk items (normally the refresh is automatic...).
Index of the payload array on which the operation is performed. Set to -1 for the entire content of the payload.
For floats, integers, and colors, it is the nth element of the array. For strings, it is the nth element of the comma-text.
In chunk modules, the item names are case sensitive. This means that item1 is not equivalent to Item1 or ITEM1.
To avoid mismatch between names and RegEx ^, ., $, *, +, ?, (, ), [, ], {, }, \, | are not allowed in the names.
The content of the chunk item.
The content of the chunk items concatenated in an array.
Displays various errors that may occur during chunk operations.
Concatenation order follows item names order The concatenation array is built by appending each item's values in the order they appear in item names. If you reorder the item names, the array layout changes. Modules reading from specific offsets in the concatenated array will get wrong values.
Missing items produce gaps in the concatenation If one of the requested items does not exist, its contribution to the concatenation is empty (zero-length). This shifts the position of all subsequent items in the array. Check items valid to make sure all items were found.
Maximum 256 items per module Same as chunk-item-get: a single module can query up to 256 items. Extras beyond this limit are silently ignored.
Button. Opens the manual page of the selected object (or of its parent module for a control) in the web browser. If no page exists for this object, an error is traced in the trace panel.
For more details about information/help creation, see create-help-file.
Free multi-line text attached to the module, saved with the patch. It is only meant as an internal note for the patch designer: it is not displayed in the interface.
visible only in god mode, see setup-panel-tab-expert.
Read-only, not saved. Current private numeric ID of the object, used internally to identify it (for example as the target of a bind ID).
Read-only, not saved. Private ID used to store and recall the values of this control in presets.
Button. Generates a new unique ID, original ID and preset ID for the object. Use it if you experience difficulties in Polyphonic mode or if two objects share the same ID. Preset values and binds referring to the old IDs are lost.
Read-only, not saved. Absolute address of the object in the Usine objects tree, built from the workspace root. This is the address to use to reach the object from scripts, the objects panel or remote messages. Only shown for objects that are registered in the objects list. See objects-address.
Read-only, not saved. Address of the object relative to the current patch, valid inside that patch only. See objects-address.
Free user-defined address for the object (empty by default). When set, the object is also registered in the objects tree under this name, so it can be reached independently of its position in the workspace (the value is also reported in the mouse-over and mouse-down chunks). Changing it rebuilds the objects list. Only available on objects that support a user address. See objects-address.
version 7.0.250121
Edit All Pages