message
Send any message
Description
message displays and sends any given message with the capability to handle specified arguments.
Arguments
message[list]
optional
changeable-arg[symbol]
optional
A dollar sign ( $ ), followed immediately by a number in the range 1-9, is a changeable argument. This argument's value can be replaced by the corresponding item in a list received in the inlet. (Example: $2 stores the second item in a list as its value before sending out the contents of the message box .) The value of a changeable argument is initially 0 .
comma[symbol]
optional
A comma (, ) divides a message into separate messages which will be sent out in order. (Example: 3, 4, 5 sends out 3 , then 4 , then 5 .)
backslash[symbol]
optional
A backslash ( \ ) is used to negate (escape) the traits of a special character. When a backslash immediately precedes a dollar sign, comma, or semicolon, the character is treated as a normal character. (Example: Notes played were C\, E\, and G .)
Attributes
bgfillcolor[4 floats]
7.0.0
Sets the background color of the message box in RGBA format. The message box can be configured to display a gradient background color using the format palette.
convertobj[int]: 0
When convertobj is enabled, messages containing dictionaries, arrays or strings sent to the right inlet of message will be converted to text representations rather than object references. As an example, an array consisting of the values 1, 2, and 3 will set the message contents to 1 2 3 when convertobj is enabled and something like array u821001852 (the exact number will vary) when convertobj is disabled.
dontreplace[int]: 0
7.0.4
When dontreplace is enabled, the message box will not have any text in it when loading a file or pasting from the clipboard. This can be useful if you want to use the object to display incoming messages or data.
style[symbol]:
7.0.0
Sets the style to be applied to the object. Styles can be set using the Format Palette.
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]: 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'
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]
JS Painter File
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
bang
int
float
list
anything
See the list listing
- message
[list]
append
The word append followed by any message will set the message box to display that message after any text which it already contains without triggering output.
- message
[list]
(mouse)
A mouse click on a message box sends its contents out the object's outlet.
prepend
The word prepend followed by any message will set the message box to display that message before any text which it already contains without triggering output.
- message
[list]
set
setargs
The word setargs , followed by a message, sets the changeable argument(s) (e.g. $1) of the receiving message box, without triggering output.
- message
[list]
Output
See Also
| Name | Description |
|---|---|
| append | Append arguments to the end of a message |
| atoi | Convert ASCII characters to integers |
| comment | Explanatory note or label |
| itoa | Convert integers to UTF-8 (Unicode) characters |
| jit.cellblock | Edit rows and columns of data |
| prepend | Add a message in front of input |
| receive | Receive messages without patch cords |