A newer version of Max is available. Click here to access the latest version of the Max documentation

dict.unpack Reference

Extract values from a dictionary

dict.unpack

Description

Use the dict.unpack object to return the values of specified keys through dedicated outlets.

Discussion

Note: The colon (:) is a reserved character and is not supported in keys or values.

Arguments

name [symbol]

Optional

Initial name of the dictionary to unpack when receiving a bang message. This will be replaced by the name of any dictionaries received at the object's inlet.

default-values [list]

Optional

Dictionary syntax specifying initial keys and values to be fetched. See the "Dictionaries" vignette for more information on dictionary syntax.

Attributes

keys [256 symbols]

List of keys from the incoming dictionary from which to fetch values and send to outlets

legacy [int]9.0.0

Legacy output mode for arrays

unmatched [int] (default: 1)

Add Unmatched Outlet

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]

g/s(set)

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]

g/s(set)

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]

g/s(set)

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

Re-fetch the values from the dictionary last received

array

TEXT_HERE

dictionary

Arguments

name [symbol]
Name of a dictionary from which to fetch values for output

See Also

Name Description
dict.compare Compare two dictionaries for equivalence.
dict.deserialize Create a dictionary from text
dict.group Build a dictionary iteratively
dict.iter Stream the content of a dictionary
dict.join Merge the content of two dictionaries
dict.pack Create a dictionary and set its values
dict.print Post a dictionary to the Max Console
dict.route Compare dictionaries
dict.serialize Convert a dictionary's content to text
dict.slice Split a dictionary into two dictionaries
dict.strip Remove keys from a dictionary
dict.view View the contents of a dictionary
dict Create and access dictionaries
Dictionaries Dictionaries