Package Max

attrui

Inspect attributes

Description

Use attrui object to inspect the attribute values of the object(s) it is connected to.

Arguments

None.

Attributes

align[atom]
!

attr[symbol]: nothing

Sets the name of the inspected attribute

attr_display[int]: 0

Sets whether the attribute name or its label is displayed on the left side of the object Possible values:

0 = 'Name'
1 = 'Label'

attrfilter[64 symbols]: none

The attrfilter attribute can contain one or more attribute names that determine the contents of the object's attribute selection popup menu. For example, if attrfilter is set to bgcolor elementcolor only those two attributes will appear in the menu. Send the message attrfilter with no arguments to show all attributes in the menu.

bgcolor[4 floats]

Sets the background color

displaymode[int]: 0

Configures the attribute value display Possible values:

0 = 'Automatic' ( Display is based on the attribute style )
In Automatic mode, attrui configures the display based on the style of the attribute. For example, a color attribute shows a color editor or a toggle attribute shows a checkbox.

1 = 'Single Number (int)' ( Display is always a single number )
In Single Number (int) mode, the attribute is always shown as a single number in a number-box style. This is appropriate for showing only one attribute whose type is int . You can restrict attrui to show a single attribute using the lock attribute.

2 = 'Single Number (float)' ( Display is always a single number )
In Single Number (float) mode, the attribute is always shown as a single number in a number-box style. This is appropriate for showing only one attribute whose type is int . You can restrict attrui to show a single attribute using the lock attribute.

3 = 'Multi Number (int)' ( Display is always multiple numbers )
In Multi Number (int) mode, the attribute is always represented with multiple int number boxes.

4 = 'Multi Number (float)' ( Display is always multiple numbers )
In Multi Number (float) mode, the attribute is always represented with multiple float number boxes.

5 = 'List' ( Display is always a list text field )
In List mode, the attribute is always shown in a textfield you can change by typing.

6 = 'Color (RGBA)' ( Display is always a color picker )
7 = 'Color (ARGB)' ( Display is always a color picker )
8 = 'Checkbox' ( Display is always a checkbox )

htricolor[4 floats]

Set the highlighted triangle color (when the numbers are focused)

lock[int]: 0

When enabled, the selected attribute cannot be changed

menu_display[int]: 0

Sets whether the attribute menu shows attribute names, labels, or both Possible values:

0 = 'Label'
1 = 'Name'
2 = 'Label & Attribute'

orientation[atom_long]: 0

Display attrui horizontally or vertically Possible values:

0 = 'Horizontal'
1 = 'Vertical'

parameter_enable[int]

Enables use of this object with Max for Live Parameters and setting initial parameter values in Max.

parameter_mappable[int]: 1

When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature. (default = 1).

paramonly[int]: 0

When paramonly is enabled, only attributes of objects such as gen~ and rnbo~ that are defined with param objects are included in the attribute popup menu.

showcaption[int]

Display attribute label on mouse over

showgetonly[int]: 0

When enabled, attributes that cannot be changed are included in the object's popup menu and can be selected for display

storeinpreset[int]: 1

Toggles on/off the ability to store an attrui 's data with the preset object or pattrstorage. The default is 1 (on).

style[symbol]:
7.0.0

Sets the style to be applied to the object. Styles can be set using the Format Palette.

text_width[float]: 100.

Set the with of the attribute name in horizontal mode. You can also click and drag in the middle line to change it.

textcolor[4 floats]

Set the text color

textjustification[int]: 0
7.0.0

Sets the attribute name text justification Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

tricolor[4 floats]

Sets the color of the number box triangle

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]

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.

Parameter Attributes

Orderint

Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enableint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Nameint

When checked, the Scripting Name is linked to the Long Name attribute.

Long Namesymbol

The long name of the parameter. This name must be unique per patcher hierarchy.

Short Namesymbol

Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.

Typeint

Specifies the data type. The data types used in Max for Live are:

Float
Int
Enum (enumerated list)
Blob

Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to 256 values, with a default range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values will exceed this range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.

Range/Enumlist

When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Clip Modulation Modeint

Sets the Clip Modulation Mode used by the Live application. The modulation modes are:

None
Unipolar
Bipolar
Additive
Absolute

Clip Modulation Rangelist

This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.

Initial Enableint

When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).

Initiallist

Sets the initial value to be stored and used when the Initial Enable attribute is checked.

Unit Styleint

Sets the unit style to be used when displaying values. The unit style values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values

Custom Unitssymbol

Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").

Exponentfloat

When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.

Stepsint

The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibilityint

For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)int

Speed limits values triggered by automation.

Defer Automation Outputint

Defers values triggered by automation.

Messages

int

The currently selected attribute of all connected objects will be set to the int value.

Arguments:
  • input [int]

float

The currently selected attribute of all connected objects will be set to the float value.

Arguments:
  • input [float]

list

The currently selected attribute of all connected objects will be set to the list value.

Arguments:
  • input [any]

anything

The currently selected attribute of all connected objects will be set to the incoming value.

Arguments:
  • input [any]

(mouse)

Choose an attribute from the popup menu on the left half of attrui to inspect. Use the controls on the right half to view or change the attribute's value.

See Also

Name Description
Dynamic Colors Dynamic Colors
getattr Query object attributes
pattr Provide an alias with a named data wrapper