console Reference

Console Output in Patcher

console

Description

Mirror and filter messages to the Max window in your patcher.

Discussion

Conceptually it’s helpful to remember that there is a global list of all messages to the Max window. When you click the X in the Max window it clears everything. This is also what the clear message to console does. Similarly, the write message will write all the data regardless of the filter settings.

Arguments

None.

Attributes

classfilter [atom]

Setting the classfilter causes the console object to only report messages from the object class specified. For example, @classfilter print will output anything reveived by print objects, but nothing else.

patcherfilter [atom]

The patcherfilter attribute can be set to the name of any patcher to restrict output to console messages generated by that patch. You can set the patcherfilter to "thispatcher" to restrict output to messages generated by the patcher containing the console object.

showonlyerrors [int]

Restrict output of the console object to error type essages only.

textfilter [atom]

The textfilter attribute requires a single word or string of words. When set, it filters by message contents, passing messages that match the entire filter string. Filter strings can be multi-element and do not require quotations. For example, textfilter foo bar will not find things with foo OR bar, it will find things with “foo bar”. Filtering includes the name of the object reporting the message.

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.

jspainterfile [symbol]

JS Painter File

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

clear

Sending the clear message to any console object will clear the entire contents of the Max console window.

write

Arguments

filepath [symbol]
Sending the message write to any console object will write the entire contents of the Max console to a text file, ignoring any filters. An optional argument allows you to specify the filepath. If no filepath is provided, a file browser window will open allowing you to specify the write location.

See Also

Name Description
print Print any message in the Max Console
Max Console Max Console
Max Console Settings Max Console Settings