array Reference

Create or duplicate an array object.

array

Description

Create or duplicate a named array object.

Arguments

value [atoms]

Optional

The initial contents of the array can be supplied as a Max list.

Attributes

name [symbol]

Like dictionary and string objects, or like Jitter matrices, array objects can have names. These can be used to reference them from Javascript or from another array object.

parameter_enable [int]

Parameter Mode Enable

parameter_mappable [int] (default: 1)

Visible to Mapping

size [int]

g/s(get)

The size refers to the number of elements in the array.

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.

Parameter Attributes

Order

Typeint

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

Typeint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name

Typeint

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

Long Name

Typesymbol

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

Short Name

Typesymbol

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.

Type

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/Enum

Typelist

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 Mode

Typeint

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

None
Unipolar
Bipolar
Additive
Absolute

Clip Modulation Range

Typelist

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

Initial Enable

Typeint

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

Initial

Typelist

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

Unit Style

Typeint

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 Units

Typesymbol

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").

Exponent

Typefloat

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.

Steps

Typeint

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 Visibility

Typeint

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)

Typeint

Speed limits values triggered by automation.

Defer Automation Output

Typeint

Defers values triggered by automation.

Messages

bang

Output the current array.

int

Arguments

value [int]
Convert an integer to an array. The integer will be placed inside of an array, which will be sent to the outlet.

float

Arguments

value [float]
Convert a floating-point number to an array. The floating-point number will be placed inside of an array, which will be sent to the outlet.

list

Arguments

list-value [list]
Convert a list to an array. The contents of the list will be placed inside the array, which will be sent to the outlet.

anything

Arguments

list-value [list]
Convert a list to an array. The contents of the list will be placed inside the array, which will be sent to the outlet.

append

Arguments

value [list]
Append a value to the end of the current array. The array will not be output in response to this message. Use bang to force output.

array

Make a copy of an array. The incoming array will be cloned and passed to the outlet.

atoms

Output the current array as a list. The elements of the array will be output as a Max list.

clear

Clear the current array. The (now empty) array will not be output in response to this message. Use bang to force output.

delete

Arguments

index [int]
Delete an entry in the array. The indexed element will be removed from the array (indices are 0-based). The array will not be output in response to this message. Use bang to force output.

dictionary

Arguments

dictionary-value [list]
Wrap a dictionary in an array. The dictionary will be placed inside of an array, which will be sent to the outlet.

get

Arguments

index [int]
Get an array element. The element will be passed to the rightmost outlet in the form get [index] [value].

insert

Arguments

index [int]
value [list]
Insert a value into the current array. A new array element will be created at the index provided, with the supplied value. Any existing array elements will be shifted to make room for the new element. The array will not be output in response to this message. Use bang to force output.

prepend

Arguments

value [list]
Place a new entry at the start of the current array. The array will not be output in response to this message. Use bang to force output.

replace

Arguments

index [int]
value [list]
Replace a value in the current array. A new array element will be created at the index provided, with the supplied value, replacing any element already stored in the array. The array will not be output in response to this message. Use bang to force output.

reserve

Arguments

number-of-entries [int]
Reserve memory for a provided number of entries (doesn't resize array). This is rarely needed, as the object manages its own memory and grows as necessary. If the desired array size is known, and re-allocation of the array needs to be avoided, this message can be used to ensure that the array object is pre-allocated to the desired size.

shrink

Reduce memory usage to the current array object length. This is rarely needed. The array object does not automatically shrink if its contents are removed or cleared, this message can be used to ensure that the object doesn't use more resources than necessary.

string

Arguments

string-value [list]
Wrap a string in an array. The string will be placed inside of an array, which will be sent to the outlet.

See Also

Name Description
dict Create and access dictionaries
string Create or duplicate a string object.
array.change Detect array changes.
array.compare Compare two arrays for equality.
array.concat Concatenate two array objects
array.every Tests all elements in the array.
array.filter Output elements of an array matching a condition.
array.flatten Flatten a multi-dimensional array object to a single dimension.
array.foreach Iterate the elements of an array.
array.frombuffer Read audio buffer values into an array object.
array.group Output an array when it reaches a certain size
array.index Output the indexed element of an array object.
array.indexmap Reorder the elements of an array object based on an indexed map.
array.indexof Search for the index of an array element.
array.iter Iterate every element of an array object.
array.join Convert an array object to a string object with an optional separator string.
array.length Determine the length of an array object.
array.map Perform an operation on every element of an array object, replacing elements in-place.
array.pop Remove an element from the end of an array.
array.push Add one or more elements to the end of an array.
array.reduce Combine array elements based on a custom function.
array.remove Remove a range of elements from an array object.
array.reverse Reverse the order of elements in an array object.
array.rotate Rotate the elements in any array object.
array.routepass Route a complete input array object based on input matching.
array.scramble Randomize the order of elements in an array object.
array.sect Return the elements of an array object which intersect with another array object.
array.shift Remove an element from the beginning of an array.
array.slice Output a range of elements of an array object as a new array object.
array.some Test the elements of an array object for a matching condition.
array.sort Sort the elements of an array object according to a test.
array.split Split an array object into two new array objects at a specified index.
array.stream Make an array of a certain size
array.subarray Output a range of elements of an array object as a new array object.
array.thin Remove duplicated entries from an array object.
array.tobuffer Write array object values to an audio buffer
array.tolist Convert an array object to a list.
array.tostring Convert an array object to a string object.
array.tosymbol Convert an array object to a symbol.
array.tuplewise Make an array of a certain size (counting iterations)
array.union Combine two arrays into a new array object containing non-duplicate entries of both arrays.
array.unique Filtering duplicates and subtract arrays.
array.unshift Add one or more elements to the beginning of an array.
array.wrap Wrap an array inside of an array