A newer version of Max is available. Click here to access the latest version of the documentation

spray Reference

Distribute a value to a numbered outlet

spray

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.

Examples

Used to break up a list and send the items out specific outlets

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

Messages

int

Arguments

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

list

Arguments

input [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.

offset

Arguments

shift [int]
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).

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
funnel
gate
listfunnel
route
unjoin
unpack