inlet
Receive messages from outside a patcher
Description
Receive messages from outside the patcher wherever it is embedded. Each inlet object in a patcher will show up as an inlet at the top of an object box when the patch is used inside another patcher (as an object or a subpatch). Messages sent into such an inlet will be received by the inlet object in the subpatch.
Discussion
A patcher can have a maximum of 250 signal inlets. The number of data inlets is a much bigger number than that.
Arguments
None.
Attributes
comment[object]
7.0.0
Sets the mouse-over Assistance message for the inlet. This value can only be set using the Comment setting in the inlet object's Inspector.
cool[int]: 0
8.0.2
Show as Cold
style[symbol]:
7.0.0
Sets the style to be applied to the object. Styles can be set using the Format Palette.
tricolor[4 floats]
7.0.0
Sets the triangle color in RGBA format.
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
(mouse)
Double-clicking on an inlet object will open the parent patch or bring it to front.
Output
anything
In a subpatch inlet sends out whatever messages it receives through patch cords from the patch that contains it.
See Also
| Name | Description |
|---|---|
| bpatcher | Embed a subpatch with a visible UI |
| outlet | Send messages out of a patcher |
| pcontrol | Open and close subwindows |
| receive | Receive messages without patch cords |
| send | Send messages without patch cords |