array.shift
Remove an element from the beginning of an array
Description
Set the array to shift, then send bangs repeatedly to output the elements of the array one at a time. The remainder of the array is sent out the right outlet, and a bang is sent out the leftmost outlet when the array is empty.
Discussion
Send an array to the right inlet to set the array to shift. Then, as you send bangs to the first inlet, the object will output the first element of the array, removing the element each time, until the array is empty. Unlike the JavaScript implementation, the input array is not changed in place.
Arguments
None.
Attributes
wrapmode[int]: 0
Wrap elements in 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]: 0
Adds or removes the object from the patcher's background layer.
adds the object to the background layer, 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]
JS Painter File
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
Remove the first element from the stored array and output it, sending the remainder out the rightmost outlet.
int
Convert an incoming integer to an array, then process as described for the
message.- value
[int]
float
Convert an incoming floating-point number to an array, then process as described for the
message.- value
[float]
list
Convert an incoming list to an array, then process as described for the
message.- list-value
[list]
anything
Convert an incoming list to an array, then process as described for the
message.- list-value
[list]
array
TEXT_HERE
clear
TEXT_HERE
dictionary
Wrap an incoming dictionary object in an array, then process as described for the
message.- dictionary-value
[list]
string
Wrap a string object in an array, then process as described for the
message.- string-value
[list]
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.unshift | Add one or more elements to 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 |