listfunnel
Index and output list elements
Description
Outputs the elements of an incoming list in the format:
[index] [element]
for each element of the list.
Arguments
offset[int]
optional
An integer argument is used to specify an offset for the first index value. If no argument is present, the list elements are numbered beginning with the default index of 0.
Attributes
Common Box Attributes
annotation[symbol]
Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.
background[int]: 0
Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.
color[4 floats]
Sets the color for the object box outline.
fontface[int]
Sets the type style used by the object. The options are:
plain
bold
italic
bold italic
Possible values:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
fontname[symbol]
Sets the object's font.
fontsize[float]
Sets the object's font size (in points).
Possible values:
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'
hint[symbol]
Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.
ignoreclick[int]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.
presentation[int]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 0. 0. 0. 0.
Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.
rect[4 floats]
write-only
Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).
size[2 floats]
write-only
Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.
textcolor[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
varname[symbol]
Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.
Messages
int
The low index value and the received number are sent out as a two-element list.
- input
[int]
float
The low index value and the received number are sent out as a two-element list.
- input
[float]
list
Each element of the list is indexed and this index is prepended to the list element and sent out the outlet as a two-element list. The input list may contain ints, floats, and symbols (provided that the first element of the list is not a symbol).
- input
[list]
anything
Performs the same as list .
- input
[list]
offset
The word offset followed by an integer argument is used to specify an offset for the first index value.
- offset
[int]
Output
list
When a list is received in the inlet, listfunnel outputs a two-element list for each element of the input list, consisting of the elements index followed the list element. listfunnel is designed for conveniently replacing a combination of unpack and funnel objects.
See Also
| Name | Description |
|---|---|
| funnel | Tag data with its inlet number |
| spray | Distribute a value to a numbered outlet |