A newer version of Max is available. Click here to access the latest version of the Max documentation

routepass

Route a complete incoming message based on input matching

Description

Tries to match a message's first argument to the route object's own arguments. Unlike the route object, routepass does not strip off the matched portion of the message. The rightmost outlet passes any message that matched no other choice, so you may gang route objects to get more choices

Examples

The routepass object matches inputs, but passes the whole message (unlike route)

Arguments

selectors [anything]

Optional

Arguments can be a mix of ints, floats, or symbols. The number of arguments determines the number of outlets, in addition to the rightmost outlet. Each argument assigns a name or a number to an outlet. If there is no argument, there is one other outlet, which is assigned the number 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

Sending a bang to the object will send a bang out any outlet that uses 'bang' as its argument. If bangs are not specified as arguments, a bant will be passed out the rightmost outlet.

int

Arguments

input [int]
If the first integer value in the message is the same as one of the arguments of routepass, the entire message is sent out the outlet that corresponds to that argument. If the first integer value does not match any of the arguments, the entire message is passed out the rightmost outlet.

float

Arguments

input [float]
If the first floating-point value in the message is the same as one of the arguments of routepass, the entire message is sent out the outlet that corresponds to that argument. If the first floating-point value does not match any of the arguments, the entire message is passed out the rightmost outlet.

list

Arguments

input [list]
If the first item of the message is the same as one of the arguments of routepass, the entire message is sent out the outlet that corresponds to that argument. If the first item does not match any of the arguments, the entire message is passed out the rightmost outlet.

anything

Arguments

input [list]
If the first item of the message is the same as one of the arguments of routepass, the entire message is sent out the outlet that corresponds to that argument. If the first item does not match any of the arguments, the entire message is passed out the rightmost outlet.

Output

anything

The first item of any message received in the inlet is compared with the arguments. If it matches one of the arguments, the full message is sent out the specified outlet. Otherwise, the message is passed out the rightmost outlet.

bang

If the first item of a message matches one of the arguments, but the message has no additional items, bang is sent out the specified outlet.

See Also

Name Description
bucket Pass numbers from outlet to outlet
forward Send messages to specified receive objects
gate Pass input to an outlet
join Combine items into a list
pack Create a list
receive Receive messages without patch cords
select Output bangs based on input matching
send Send messages without patch cords
sprintf Format a message of words and numbers
route Select outlet based on input matching
zl Process lists in many ways
Max Basic Tutorial 18: Data Collections Max Basic Tutorial 18: Data Collections