Package Max

comment

Explanatory note or label

Description

comment displays text which is typed into it in order to serve as a label or explanatory text.

Arguments

None.

Attributes

bgcolor[4 floats]

Sets the background color of the comment box in RGBA format. The bgcolor attribute is mapped to the clearcolor style color.

bubble[int]: 0

Enable bubble comments

bubble_bgcolor[4 floats]

Bubble Background Color

bubble_outlinecolor[4 floats]

Bubble Outline Color

bubblepoint[float]: 0.5

Bubble Arrow Point (0-1)

bubbleside[int]: 1

Sets the side from which the arrow will originate on bubble comments. Possible values:

0 = 'Top'
1 = 'Left'
2 = 'Bottom'
3 = 'Right'

bubbletextmargin[int]: 5

Bubble Text Margin

bubbleusescolors[int]: 0
8.0.0

Turns on drawing the bubble outline and background in the comment's textcolor and bgcolor.

style[symbol]:
7.0.0

Sets the style to be applied to the object. Styles can be set using the Format Palette.

suppressinlet[int]: 0
7.1.0

Suppress the display of an inlet.

underline[int]: 0

Toggles underlining the comment's text. This value can only be set using the Underline setting in the comment object's Inspector.

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background[int]: 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]: 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]: 0

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

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

patching_rect[4 floats]: 0. 0. 100. 0.

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

position[2 floats]
write-only

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]: 0

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

presentation_rect[4 floats]: 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]
write-only

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]
write-only

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

append

The word append followed by any message will set the comment object to display that message after any text which it already contains.

Arguments:
  • message [list]

prepend

The word prepend followed by any message will set the comment object to display that message before any text which it already contains.

Arguments:
  • message [list]

set

The word set followed by any message will set the comment object to display that message.

Arguments:
  • message [list]

setwithtruncation

The word set followed by a symbol and a width (in pixels) will truncate the symbol to the given width. An optional third symbol will be appended onto the truncated text.

Arguments:
  • message [symbol]
  • width [int]
  • suffix [symbol]

string

TEXT_HERE

Output

(visual)

comment has no outlets, sends no output, and does not affect patch functionality.

See Also

Name Description
ubutton Transparent button
textedit Enter text
message Send any message
textbutton Button with text
live.comment Explanatory note or label (Max for Live)