pv
Description
Creates a value that is shared between objects, but only within a single patcher. Unlike the value object, pv objects that share the same name only share the same value if they are in the same patcher, or one of its subpatches.
Examples
Discussion
The pv also object cannot be the receiver of a message sent remotely by a message box (the first symbol after a semicolon).
Arguments
name [symbol]
Obligatory. The first argument provides an identifying name. All pv objects with that name within the patcher will share the same value.
message [anything]
Any message typed in after the first argument initializes the stored contents of the pv object. Note that when two or more pv objects in a patcher file that share the same name are initialized to different values, the one which is initialized last determines the value. Since the order in which pv objects will be initialized cannot be precisely determined, the best practice is to initialize only one of the related pv objects.
Attributes
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]
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]
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]
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
Arguments
float
Arguments
list
Arguments
anything
Arguments
status
symbol
Arguments
Output
any message
When bang is received in the inlet, the stored message is sent out.
See Also
| Name | Description |
|---|---|
| Organizing Your Patch | Organizing Your Patch |
| float | Store a decimal number |
| int | Store an integer value |
| pvar | Connect to a named object in a patcher |
| receive | Receive messages without patch cords |
| send | Send messages without patch cords |
| value | Share data between other value objects |