loadmess
Send a message when a patch is loaded
Description
Outputs a message automatically when the file is opened, or when the patch is part of another file that is opened.
Arguments
message[symbol]
optional
Any arguments you type into a loadmess object are treated as a message to be sent when output is triggered.
Attributes
defer[int]: 0
When enabled, the output of loadmess is deferred through the lower priority main thread.
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]
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
bang
Sending a bang message to a loadmess object causes it to output its typed message.
(mouse)
Double-clicking on a loadmess object causes it to output its typed message.
set
The word set followed by any message will set the message held by loadmess without any output. (Can be used for output in conjunction with bang .)
- message
[list]
Output
symbol
The loadmess object's typed message is sent automatically when the patch is loaded. As with the loadbang object, you can also cause loadmess to send out its message by double-clicking on it in a locked patcher, or by sending a loadbang message to a thispatcher object in the same patcher. Holding down the Shift and Command keys on Macintosh or Shift and Control keys on Windows while a patch is loading prevents loadmess objects in that patch from sending any output.
See Also
| Name | Description |
|---|---|
| active | Send 1 when patcher window is active, 0 when inactive |
| button | Blink and send a bang |
| closebang | Send a bang on close |
| defer | Defer execution of a message |
| freebang | Send a bang when a patcher is freed |
| loadbang | Send a bang when a patcher is loaded |
| thispatcher | Send messages to a patcher |
| savebang | Send a bang on save |