Package Max

pvar

Connect to a named object in a patcher

Description

The pvar object lets you build user interfaces in one part of your patcher that are associated with the "process" part in another part of the patcher. Unlike the send and receive objects, pvar does not work globally; the pvar object and its associated object must be in the same patcher. To set an object's name, select the object, open the inspector, then enter a name under Name > Scripting Name. The name cannot be a number, although it can contain numbers.

Arguments

object-name[symbol]
optional

The first argument specifies the name of the object to which pvar will be associated with. If no name is supplied, the setname message can be used to connect later.

number-of-outlets[int]
optional

The second argument specifies the number of outlets pvar will have. pvar connects to as many outlets as its associated object has, unless it is more than the number you specify as an argument. The default number of outlets is 1.

Attributes

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]

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

Performs the same function as anything .

int

Performs the same function as anything .

Arguments:
  • input-message [int]

float

Performs the same function as anything .

Arguments:
  • input-message [float]

list

Performs the same function as anything .

Arguments:
  • input-message [list]

anything

The message is sent to the named object currently associated with pvar.

Arguments:
  • input-message [list]

loadbang

Performs the same function as anything .

setname

The word setname , followed by a symbol, specifies the name of the object to which pvar will be associated with. The named object must be in the same patcher as the pvar object.

Arguments:
  • object-name [symbol]

Output

any message

The outlets of pvar correspond to the outlets of its associated named object. When the named object sends anything out one of its outlets, the output also comes out of the corresponding outlets of the pvar object.

See Also

Name Description
receive Receive messages without patch cords
send Send messages without patch cords
thispatcher Send messages to a patcher
value Share data between other value objects