Package Max

array.unshift

Add one or more elements to the beginning of an array

Description

The base array is sent to the right inlet, which clears any elements send to the left inlet. Additional elements are sent to the left inlet, and can be repeatedly placed at the front of the output array, without the user needing to update the array in the right inlet. Unlike the JavaScript implementation, the input array is not changed in place.

Arguments

None.

Attributes

wrapmode[int]: 0

When enabled, elements arriving at the left inlet will be wrapped in an array before being unshifted. By default, elements are unshifted unwrapped.

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 array and trigger output.

int

In the left inlet, the integer value will be added to the beginning of the base array and the result will be output. In the right inlet, convert an incoming integer to an array and replace the base array.

Arguments:
  • value [int]

float

In the left inlet, the floating-point value will be added to the beginning of the base array and the result will be output. In the right inlet, convert an incoming floating-point value to an array and replace the base array.

Arguments:
  • value [float]

list

In the left inlet, the list will be added to the beginning of the base array and the result will be output. In the right inlet, convert an incoming list to an array and replace the base array.

Arguments:
  • list-value [list]

anything

In the left inlet, the list will be added to the beginning of the base array and the result will be output. In the right inlet, convert an incoming list to an array and replace the base array.

Arguments:
  • list-value [list]

array

In the left inlet, the array will be added to the beginning of the base array and the result will be output. In the right inlet, replace the base array with the incoming array.

Arguments:
  • array-value [list]

clear

All internal arrays will be cleared.

Arguments:
  • clear [float]

dictionary

In the left inlet, the dictionary will be added to the beginning of the base array and the result will be output. In the right inlet, wrap the dictionary in an array, and replace the base array.

Arguments:
  • dictionary-value [dictionary]

string

In the left inlet, the string will be added to the beginning of the base array and the result will be output. In the right inlet, wrap the string in an array, and replace the base array.

Arguments:
  • string-value [string]

See Also

Name Description
array Create or duplicate an array object
array.concat Concatenate two array objects
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.shift Remove an element from the beginning of an array
zl.queue Output elements of a list in the order they are received
zl.stack Output elements of a list in reverse order