Flow Collection List

A list is an ordered collection of elements where each item has a specific position, and duplicates are allowed. You can insert, remove, and access elements by their position (index), making it useful for sequences of data.

Settings

in

Input flow(s).

out

Output flow(s).

add

Adds a new element to the list.

delete

Deletes the element in the list at the delete index position.

delete index

Index of the element to delete.

insert

Inserts an element into the list at the insert index position.

insert index

Index at which the element is inserted.

get

Gets the element in the list at the get index position and copies it to out.

get index

Index of the element to get.

delete last

Deletes the last element of the list.

delete first

Deletes the first element of the list.

collection size

Number of elements in the collection.

capacity

Capacity of the collection (max number of elements).

size

Size of the collection (number of elements).

clear

Clears (empties) the collection.

push mode

  • manual: elements are pushed into the collection manually when the push (or add) button is triggered.
  • automatic: elements are pushed into the collection automatically if the in has changed.

display errors

Displays a warning when there is an attempt to push a flow on a full collection (the size = capacity) or when there is an attempt to pop an empty collection.

Common Settings

info

show manual

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.

description

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.

ID's

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

unique ID

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

preset ID

Read-only, not saved. Private ID used to store and recall the values of this control in presets.

recreate ID

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.

Object Remote Address

absolute

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.

local

Read-only, not saved. Address of the object relative to the current patch, valid inside that patch only. See objects-address.

user addr

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.

See also

version 7.0.250121

Edit All Pages