combine
Combine multiple items into a single symbol
Description
Combines a list of items into a single symbol. It works similar to pack and sprintf. The behavior can be modified with attributes that provide number padding and triggered output.
Arguments
inlets[anything]
optional
The number of inlets is determined by the number of arguments. Each argument sets an initial type and value for an item in the list stored by the combine object. If a number argument contains a decimal point, that item will be stored as a float. If the argument is a symbol, that item will be stored as a symbol.
Attributes
padding[256 ints]
A list that determines the number of zeros to add to a number if appropriate.
triggers[256 ints]
Define a list of inputs that will automatically trigger output (i.e. adding an input to this list will make the inlet "hot"). Setting the attribute value to -1 will cause the object to trigger output for any inlet (all inlets will be "hot").
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
bang
Causes combine to send out a list of the items currently stored.
int
The number is stored in combine as an item in a list, with its position in the list corresponding to the inlet in which it was received. The combined output is then generated from this list and sent out the outlet.
- input
[int]
float
The number is stored in combine as an item in a list, with its position in the list corresponding to the inlet in which it was received. The combined output is then generated from this list and sent out the outlet.
- input
[float]
list
When a list is sent into any inlet of the combine object, each item in the list is converted to symbols and stored. Its position in the list corresponds to the inlet in which it was received. If the list is sent to the left inlet, the combined output is then generated and sent out the outlet.
- input
[list]
anything
The symbol is stored in combine as an item in a list, with its position in the list corresponding to the inlet in which it was received. The combined output is then generated from this list and sent out the outlet.
- input
[list]
See Also
| Name | Description |
|---|---|
| join | Combine items into a list |
| pack | Create a list |
| pak | Output a list when any element changes |
| sprintf | Format a message of words and numbers |
| transport | Control a clock |