Creates a transparant click-able region that can be placed over graphics or other objects. Produces a bang message when clicked.
The left-middle outlet sends a ubutton when you create a new one - just continue dragging the mouse after placing the button in the patcher window.when the mouse is clicked on the button, and left outlet sends a when the mouse button is released. Note that you can resize
dragtrack [int] (default: 0)
The word ubutton object's Inspector., followed by a non-zero number, enables "Track Mouse While Dragging" mode. In this mode, positional and inside/outside messages (described above for mouse clicks) are sent continuously while the mouse button is held down after a click. disables this behavior, which is off by default. Dragging the mouse will continue to generate these message pairs until the mouse button is released. Drag tracking is off by default. It can also be enabled in the
hilite [int] (default: 1)
Toggles the display of a highlight when ubutton is clicked.
hltcolor [4 floats]
Sets the Highlight Color in RGBA format.
Enables use of this object with Max for Live Parameters.
parameter_mappable [int] (default: 1)
When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature.
stay [int] (default: 0)
Selects the button mode. The modes are:
0 the ubutton object is in normal button mode. It does not look for any particular number.
(any non-zero number) the object is in button mode and waits for the specified non-zero number. When that number is received in the inlet, no output is sent, but ubutton stays highlighted until some other message (or a mouse click) is received.
toggle [int] (default: 0)
Selects the toggle mode. The modes are:
0 button mode
(any non-zero number) toggle mode
0 = 'Button'
1 = 'Toggle'
Common Box Attributes
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.adds the object to the background layer, 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.
Sets the type style used by the object. The options are:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
Sets the object's font.
Sets the object's font size (in points).
hidden [int] (default: 0)
Toggles whether an object is hidden when the patcher is locked.
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.
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.
Sets the color for the object's text in RGBA format.
Sets the justification for the object's text.
0 = 'left'
1 = 'center'
2 = 'right'
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 Enable
Parameter Mode Enable (not available from Parameters window)
Link to Scripting Name
When checked, the Scripting Name is linked to the Long Name attribute.
The long name of the parameter. This name must be unique per patcher hierarchy.
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.
Specifies the data type. The data types used in Max for Live are:
Enum (enumerated list)
Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to a range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values are likely to be outside of the 0-255 range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.
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).
Sets the Modulation Mode used by the Live application. The modulation modes are:
This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.
When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).
Sets the initial value to be stored and used when the Initial Enable attribute is checked.
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)
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
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").
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.
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.
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)
Speed limits values triggered by automation.
Defer Automation Output
Defers values triggered by automation.
Out 1st outlet: In button mode (with a Stay-on Value of ubutton to flash and send a out the left outlet. A is also sent out the left outlet when the mouse button is released.
If the ubutton object is in toggle mode and is already highlighted, any input causes ubutton to become unhighlighted and send a out its left outlet.
Out 2nd outlet: In button mode (with a Stay-on Value of
If the object is in toggle mode, any input causes ubutton to become highlighted and send a out the outlet. If it is already highlighted, it becomes unhighlighted and no is sent.
Out right outlet: When the mouse button is clicked and released, a ubutton object's rectangular area. If the "Track Mouse While Dragging" option is enabled using the Inspector or the message, a will be output if the cursor moves outside of the ubutton object's rectangular area while the mouse button is pressed.is sent out this outlet if the cursor is inside of the
Out 3rd outlet: When the mouse button is clicked and released, the ubutton object sends out a list composed of two numbers which specify the coordinates for the cursor position expressed as an offset, in pixels, from the upper left-hand corner of the ubutton object rectangle. If the "Track Mouse While Dragging" option is enabled using the Inspector or the message, new coordinates will be reported as the mouse is moved until the mouse button is released.
|button||Blink and send a bang|
|fpic||Display an image|
|led||Color on/off button|
|matrixctrl||Matrix switch control|
|radiogroup||Radio button or check box|
|textbutton||Button with text|