Package Max

spray

Distribute a value to a numbered outlet

Description

Accepts lists as input, where the first number is taken as the outlet number, and one or more values that follow are sent out that outlet and those to its right, in right-to-left order. The argument sets the number of outlets (there is no set limit). The default number of outlets is 2.

Arguments

outlets[int]
optional

The first argument sets the number of outlets. If there is no argument present, the object has two outlets.

offset[int]
optional

The second argument sets an offset for the numbering of the outlets. If the second argument is not present, the outlets are numbered beginning with 0.

listmode[int]
optional

The third argument, if set to '1', sets the object to "list mode." In "list mode," an entire list is output through the indicated outlet (with the optional offset provided by the second object argument), instead of unpacking the list and sending the individual elements out sequential outlets. This argument defaults to '0'.

Attributes

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]

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

int

Posts an error-message in the Max Console stating that spray requires a list.

Arguments:
  • input [int]

list

The first number in the list is a number that specifies the outlet number; the second is an int or float value to send out that outlet. If there are additional elements in the list, they are sent out the subsequent outlets to the right of the one specified by the first number in the list. The list may contain only ints or floats; symbols will be ignored.

Arguments:
  • input [list]

offset

The word offset followed by a number will offset the output of the object by the number of outlets given shifted to the left (a negative number will specify the number of outlets offset to the right).

Arguments:
  • shift [int]

Output

int

When a list of is received by spray, the first number is used to specify an outlet, and the second int or float is sent out that outlet. Any additional numbers in the list are sent out subsequent outlets to the right.

See Also

Name Description
cycle Round-robin messages to outlets
funnel Tag data with its inlet number
gate Pass input to an outlet
listfunnel Index and output list elements
route Select outlet based on input matching
unjoin Break a list into messages
unpack Break a list into individual messages