join

Combine items into a list

Description

Takes separate untyped items and combines them into an output list.

Examples

Arguments

inlets [int]

Specifies the number of inlets. If there is no argument, there will be two inlets, and the two list items will be set to (int) 0 initially.

Attributes

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] (default: 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'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

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] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

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] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 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]

g/s(set)

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]

g/s(set)

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 [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

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

In left inlet: Causes join to send out a list composed of the currently stored items.

int

Arguments

input [int]
The number is stored in the join object as an item in a list with its position in the list corresponding to the inlet in which it was received. If the inlet is a 'trigger' input, the entire list is sent out the outlet.

float

Arguments

input [float]
The number is stored in the join object as an item in a list with its position in the list corresponding to the inlet in which it was received. If the inlet is a 'trigger' input, the entire list is sent out the outlet.

list

Arguments

values [list]
The list is stored in the join object as an array of items in a list with its position in the list corresponding to the inlet in which it was received. If the inlet is a 'trigger' input, the entire list is sent out the outlet.

anything

Arguments

values [list]
The message with its arguments is stored in the join object as an array of items in a list with its position in the list corresponding to the inlet in which it was received. If the inlet is a 'trigger' input, the entire list is sent out the outlet.

set

Arguments

values [list]
The list is stored in the join object as an array of items in a list with its position in the list corresponding to the inlet in which it was received.

See Also

Name Description
pack Create a list
pak Output a list when any element changes
unjoin Break a list into messages
unpack Break a list into individual messages