live.numbox Reference

Display and output a number

live.numbox

Description

The live.numbox object is a number box used to display, input, and output numbers.

Examples

Arguments

None.

Attributes

active [int] (default: 1)

Toggles the object's active mode. When the active attribute is set to 0, the mouse action does not cause output, and the inactive colors are used.

activebgcolor [4 floats]

Sets the background color off displayed when the active attribute is set to 1.

activeslidercolor [4 floats]

Sets the slider color displayed when the active attribute is set to 1.

activetricolor [4 floats]

Sets the triangle color displayed when the actual value is equal to the initial value.

activetricolor2 [4 floats]

Sets the triangle color displayed when the actual value is different from the initial value and the active attribute is set to 1.

annotation_name [symbol] (default: )

The string that is prepended to annotations. This shows up in the Info pane in Live, and the clue window in Max.

appearance [int] (default: 0)

Select different display modes:
mode 0 (default): Standard display
mode 1: Triangle display
mode 2: Slider display
mode 3: Bipolar display
mode 4: LCD display

Possible values:

0 = 'Default'
1 = 'Triangle'
2 = 'Slider'
3 = 'Bipolar'
4 = 'LCD'

bordercolor [4 floats]

Sets the display color for the live.numbox object's border in RGBA format.

focusbordercolor [4 floats]

Sets the border color in RGBA format to be used when the live.numbox has the focus.

inactivelcdcolor [4 floats]8.0.0

Sets the display color for the live.numbox object's text in RGBA format when the active attribute is set to 0.

lcdbgcolor [4 floats]8.0.0

Sets the background color in RGBA format when the appearance attribute is set to 'LCD'.

lcdcolor [4 floats]8.0.0

Sets the display color for the live.numbox object's text when the appearance attribute is set to 'LCD'.

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.

textcolor [4 floats]

Sets the display color for the live.numbox object's text in RGBA format when the active attribute is set to 1.

tricolor [4 floats]

Sets the triangle color displayed when the actual value is different from the initial value and the active attribute is set to 0.

tricolor2 [4 floats]

Sets the triangle color displayed when the actual value is different from the initial value and the active attribute is set to 0.

Common Box Attributes

Parameter Attributes

Messages

bang

Sends the current value out the outlet.

int

Arguments

input [int]
The number received in the inlet is stored and displayed by the live.numbox object and sent out the outlet.

float

Arguments

input [float]
The number received in the inlet is stored and displayed by the live.numbox object and sent out the outlet.

assign

Arguments

assign-input [float]
The word assign, followed by a floating point value, causes that value to be stored and displayed and sent out the live.numbox object's outlet. If the Parameter Visibility attribute is set to Stored Only, the assign message will not add the new value to the Live application’s undo chain.

init

Restores and outputs the initial value.

(mouse)

Click and drag the live.numbox display to change the value. Hold down the Shift key for more precise mouse control.
If the live.numbox object is set to store an initial value (set by checking the Initial Enable option in the object's Inspector), double-clicking in the triangle region will restore that value.

outputvalue

Sends the current value out the outlet.

rawfloat

Arguments

input [float]
A raw normalized value (between 0. and 1.) received in the inlet is converted to a real value, stored, displayed by live.numbox, and the current value is sent out the outlet.

set

Arguments

set-input [float]
Sets the current value without causing any output.

Output

float

Out right outlet: when an output is triggered, a raw normalized value (between 0. and 1.) is sent out this outlet.

int/float

Out left outlet: Numbers received in the inlet, or produced by clicking or dragging on live.numbox with the mouse, are sent out the outlet. The value sent is an integer if the Parameter Type is set to INT or ENUM.

See Also

Name Description
Max For Live Max For Live
live.dial
live.slider
number
flonum