Chunk Item Get

Retrieve the values of items in a chunk.

Settings

chunk name

Name of the chunk.

In chunk modules, the chunk name is case sensitive. This means that MYCHUNK is not equivalent to mychunk or MyChunk.

item names

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)

items valid

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).

refresh

Forces the module to retrieve chunk items (normally the refresh is automatic...).

index

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.

payload

The content of the chunk item.

display errors

Displays various errors that may occur during chunk operations.

Common errors

Item not found: silent empty output If the requested item name does not exist in the chunk, the corresponding payload outlet outputs nothing and the items valid array shows 0 for that item. No error is displayed unless display errors is enabled. Always check items valid if the item may not exist yet.

Maximum 256 items per module A single module can query up to 256 items. If item names contains more than 256 entries, extras are silently ignored. Use multiple modules if you need more.

Index out of bounds If the index exceeds the array length stored in the chunk item, the output is reset to an empty state. No error is raised. Verify the item's array size if your index is dynamic.

Changing chunk name or item names at runtime After changing chunk name or item names via an inlet, send a trigger to refresh — the module does not automatically re-subscribe to the new chunk/items.

Common Settings

info

show manual

Opens the web browser to display information or help about the selected object, if it exists.

For more details about information/help creation, see create-help-file.

description

Description of the module for internal help purposes only. The description is not displayed in the interface.

ID's

visible only in god mode, see setup-panel-tab-expert.

unique ID

Current private ID for this control used to identify the object.

preset ID

Current private preset ID for this control used for presets.

recreate ID

If you experience difficulties in Polyphonic mode, try to recreate new id(s) with this button.

repair ID s

Each Patch shared on the local network uses its own ID (identification number). If you experience issues of Patches that don't send information to the good target, this button will rebuild all these id's.

Object Remote Address

absolute

Absolute remote address. see objects-address.

local

Local to the current patch remote address. see objects-address.

user addr

User defined remote address. see objects-address.

See also

version 7.0.250121

Edit All Pages