textbox
Display and output numbers, lists, and messages
Description
The number object displays and outputs either integers, floats, lists of numbers, or any message, depending on its format. flonum is a synonym for number in Float format, listbox is a synonym for number in List format, and textbox is a synonym for number in Text format.
Arguments
None.
Attributes
annotation_name[symbol]:
Info View Title
bgcolor[4 floats]
Sets the color for the object's background
cantchange[int]: 0
When cantchange is enabled, the value of the number box cannot be changed by text or mouse input. The value can be changed via an incoming message however.
format[int]: 0
Sets characteristics of the appearance and behavior of the number box. All formats restrict text entry to the characters displayed. For example, in Binary format you can only type 0 or 1.
Possible values:
0 = 'Decimal (Integer)'
Display and output int values as decimal (base 10) numbers
1 = 'Hex'
Display and output int values as hex (base 16) numbers
2 = 'Roland Octal'
Display and output int values using a display format where digits range from 1 to 8, where 11 is zero 88 is 63 in decimal.
3 = 'Binary'
Display and output int values using a binary display format of 1s and 0s.
4 = 'MIDI'
Display and output int values using MIDI note names, where middle C (60) is C3.
5 = 'MIDI (C4)'
Display and output int values using MIDI note names, where middle C (60) is C4.
6 = 'Decimal (Floating-Point)'
Display and output float values
7 = 'List'
Display and output a list of int and float values
8 = 'Text'
Display and output any message
htricolor[4 floats]
Sets the highlight color for the triangle or other symbol indicating the object is highlighted for text entry by typing
maximum[atom]: <none>
Sets the maximum value that can be displayed or output
minimum[atom]: <none>
Sets the minimum value that can be displayed or output
mousefilter[int]: 0
>= 7.2.0
Alias: mouseup
When enabled, mousefilter only sends the value you change by scrolling the number up and down by dragging when you release the mouse button. When disabled, numbers are output as you scroll.
numdecimalplaces[int]: 0
Sets the number of decimal places displayed for a number box whose format is set to Float.
outputonclick[int]: 0
When outputonclick is enabled, the current value of the object will be sent out when you click on it
param_connect[symbol]:
Establishes a two-way connection between the object and a parameter of a compatible object with parameters such as gen~ or jit.gl.slab. The object can be used to change the value of the parameter and will update if the parameter value changes. The easiest way to set param_connect is with the attribute's menu in the inspector or the Connect submenu of the Object Action menu. The menu displays all available parameters of compatible objects.
Setting the param_connect attribute with a message requires the target parameter's path, which is the host object's scriping name followed by two colons and the parameter name. For example, for a gen~ object with scripting name gen~_AB , the path of the freq parameter would be gen~_AB::freq . You can set a value for the param_connect before the host object or parameter exists, and the object will connect to the parameter once it exists. Refer to the user guide entry for param_connect for more details.
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.
style[symbol]:
>= 7.0.0
Sets the style to be applied to the object. Styles can be set using the Format Palette.
textcolor[4 floats]
Sets the color for drawing the text
triangle[int]: 1
Toggles the drawing of the triangle or other symbol indicating the object is highlighted for text entry by typing
tricolor[4 floats]
Sets the color for the triangle or other symbol that indicates that the contents are editable.
triscale[float]: 1.
Scales the size of the triangle or other symbol drawn in the object
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]: 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'
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.
Aliases: patching_position, patching_size
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.
Aliases: presentation_position, presentation_size
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'
valuepopup[int]: 0
For objects with single values, enabling valuepopup will display the object's current value in a popup caption when the mouse is over the object or it is being changed with the mouse.
valuepopuplabel[int]: 0
Sets the source of a text label shown in a value popup caption.
Possible values:
0 = 'None'
1 = 'Hint'
2 = 'Scripting Name'
3 = 'Parameter Long Name'
4 = 'Parameter Short Name'
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.
Control Surface Button Modesymbol
The behavior of control surface buttons, when the parameter is assigned with the live.banks object. Currently available modes are:
Toggle : switches between minimum and maximum value (default)
Trigger : outputs the maximum value, immediately followed by the minimum value
Cycle : cycles through available enum values
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
bang
Sends the currently displayed value out the outlet
int
An int value received will be displayed and sent out the outlet. The value will be converted to a float if the number box's format attribute is set to Float.
- input
[int]
float
float value received will be displayed and sent out the outlet. The value will be converted to an int if the number box's format attribute is set to Int or another integer-based format.
- input
[float]
list
list received is displayed and sent out the outlet. If the format is set to List or Text, the entire list is stored and output. Otherwise only the first value in the list is stored and output.
anything
If any message is received and the number box's format is set to Text, the entire message is stored and output. If the format is set to Int or Float, an error message is posted to the Max console and no value is stored or output. If the format is set to List, no value is stored or output, but no error message is posted.
clear
When the format atrribute of number is set to List or Text, clear will clear the current list or message displayed.
max
The word max , followed by a number, sets the maximum value that can be displayed or sent out by the number box. The word max by itself sets the maximum to None, removing any previously set maximum value.
- maximum
[list]
min
The word min , followed by a number, sets the minimum value that can be displayed or sent out by the number box. The word min by itself sets the minimum to None, removing any previously set minimum value.
- minimum
[list]
(mouse)
Clicking and dragging up and down on a number box with the mouse (when the patcher window is locked) moves the displayed value up and down, and outputs the new values continuously.
In a float number box, dragging to the left of the decimal point changes the value in increments of 1. Dragging to the right of the decimal point changes the fractional part of the number in increments of 0.01.
When the active patcher window is locked, numbers can be entered into a number box by clicking on it with the mouse and typing in a number on the computer keyboard. Typing the Return or Enter keys on Macintosh or the Enter key on Windows, or clicking outside the number box, sends the number out the outlet. You can also click on the number box and use the up or down arrows on your keyboard to increase or decrease the number by one. Shift+arrow jumps by tens. For the float number box, alt/option+arrow jumps by tenths.
When the format of the number box is set to List, you can drag up or down on individual numbers within the list to change them.
When the format of the number box is set to List or Text, you can select individual items in a list or message to replace them by typing, or select the entire contents to replace everything by typing.
select
The word select will highlight the number box so you can type values into it. Clicking on any empty space in a locked patcher will deselect the object.
set
The word set , followed by a number, list or message, sets the stored and displayed value to that number without triggering output.
- input
[int]
See Also
| Name | Description |
|---|---|
| float | Store a decimal number |
| int | Store an integer value |