patcherargs
Max Reference
Open Help

patcherargs

Retrieve patcher arguments

Description

Retrieves patcher arguments and parses attribute style arguments. "normal" arguments are sent out the left outlet (first), and attribute style arguments are sent out the right outlet (second).

Examples

Discussion

This object is useful inside abstractions, bpatchers, and subpatchers. If there are arguments present to the patcherargs object, they are assumed to be the default arguments in the instance that the parent patcher has no arguments.

Arguments

defaults [int, float, symbol]

The patcherargs object permits access to more than 10 arguments for patchers which are typed into an object box, but those contained within a bpatcher object remain limited to 10 arguments.

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

Sends a list of the parent patcher's arguments out the left outlet.

If the parent patcher uses any attribute-style arguments (e.g. if any Jitter objects are used in the patcher), they are sent out the right outlet as a series of lists.

(mouse)

Double-clicking on the object will send the parent patcher's arguments out the left outlet.

If the parent patcher uses any attribute-style arguments (e.g. if any Jitter objects are used in the patcher), they are sent out the right outlet as a series of lists.

Output

Int, float, symbol

Out left outlet: A list of the parent patcher's arguments are sent out the left outlet when the patcher is loaded.

Out right outlet: A series of lists corresponding to the attribute-style arguments (if any Jitter objects are contained in the patcher) are sent out the right outlet when the patcher is loaded.

See Also

Name Description
bpatcher Embed a subpatch with a visible UI
thispatcher Send messages to a patcher