funnel
Max Reference
Open Help

funnel

Tag data with its inlet number

Description

Identifies the inlet of incoming data. It can be used to store values into a table or coll based on their source, or used to set a destination with an object such as spray.

Examples

Use funnel to tag incoming data, or to store data into a coll object

Arguments

inlets [int]

Optional

The first argument sets the number of inlets in the funnel. If there is no argument there will be two inlets.

offset [int]

Optional

The second argument specifies an offset for the first inlet number. If no second argument is present, the inlets are numbered beginning with 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] (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 any inlet: The number of the inlet and the stored (most recently received) number in that inlet are sent out as a two-item list.

int

Arguments

input [int]
In any inlet: The number of the inlet and the received number are sent out as a list.

float

Arguments

input [float]
In any inlet: The number of the inlet and the received number are sent out as a list.

list

Arguments

inputs [list]
In any inlet: The number of the inlet is prepended to the list, and the new list is sent out. In a list floats are not converted to ints. The list may contain ints, floats, and symbols (provided that the first element of the list is not a symbol).

anything

Arguments

inputs [list]
Functions the same as list .

offset

Arguments

offset [int]
The word offset followed by a number will offset the numbering of inlets by the number given.

set

Arguments

inputs [list]
In any inlet: The word set followed by a list of numbers which correspond with the number of inlets, will set the input list of numbers without sending them through the outputs.

Output

list

When a number or list is received in any inlet, funnel outputs a list consisting of the inlet number followed the input. funnel can be useful in conjunction with other objects such as coll, funbuff and table.

See Also

Name Description
listfunnel Index and output list elements
spray Distribute a value to a numbered outlet