Package Max

array.indexof

Search for the index of an array element

Description

Output the position of an array element within a longer array as an integer index (0-based). Output -1 if the element cannot be found.

Arguments

None.

Attributes

all[int]: 0

All matching indices will be output as a list. If there are no matches, a single -1 will be output.

offset[int]: 0

Offsets are 0-based. If you want to sequentially search an array for an element, pass the (previous match + 1) as the offset and send a bang to get the next match. A -1 will be output when there are no more matches.

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.

Messages

bang

Reprocess previously received arrays and trigger output.

int

Convert an incoming integer to an array, then process as described for the array message.

Arguments:
  • value [int]

float

Convert an incoming floating-point number to an array, then process as described for the array message.

Arguments:
  • value [float]

list

Convert an incoming list to an array, then process as described for the array message.

Arguments:
  • list-value [list]

anything

Convert an incoming list to an array, then process as described for the array message.

Arguments:
  • list-value [list]

array

This search is case-sensitive. Will output the position of the provided element (left inlet) in the larger array (right inlet) if found, otherwise will output -1 .

A multiple-element input in the left inlet will match an array (e.g. a b c will find index 2 of [ 1, 2, [ a, b, c ], 4] ), but does not match a sequence of individual elements (that is, a b c will not find anything in [ 1, 2, a, b, c, 4 ] ).

dictionary

Wrap an incoming dictionary object in an array, then process as described for the array message.

Arguments:
  • dictionary-value [list]

string

Wrap a string object in an array, then process as described for the array message.

Arguments:
  • string-value [list]

See Also

Name Description
array Create or duplicate an array object
array.foreach Iterate the elements of an array
zl.sub Output position for each occurance of right list in left