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

gate Reference

Pass input to an outlet

gate

Examples

Message is passed out the specified outlet.... This one closes the door behind itself

Arguments

outlets [int]

Optional

Specifies the number of outlets. If there is no argument, there is only one outlet.

initial-state [int]

Optional

Specifies which outlet is initially open. The default is 0 (none).

Attributes

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] (default: 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] (default: 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] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

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] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 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]

g/s(set)

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]

g/s(set)

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

Reports the current open outlet (0 if closed) out the left outlet.

int

Arguments

outlet-number [int]
The number specifies an open outlet through which to pass all messages received in the right inlet. A number in the left inlet does not trigger any output.

float

Arguments

outlet-number [float]
Converted to int.

next

Sending the next message to the left inlet will close the current outlet and open the next one, wrapping accross all outlets. If currently closed (set to 0) or set to the rightmost outlet, outlet 1 will be opened.

Output

anything

Messages received in the right inlet are passed out the outlet specified by the number in the left inlet. If the number in the left inlet is 0, or if no outlet number has been received yet, all messages are ignored. If the number in the left inlet is less than 0, messages are sent out the leftmost outlet. If it is greater than the number of existing outlets, messages are sent out the rightmost outlet.

See Also

Name Description
ggate Send input to one of two outlets
crosspatch Patching Editor for Matrix Objects
gswitch Select output from two inlets
route Select outlet based on input matching
router Route messages to multiple locations
send Send messages without patch cords
switch Accept messages from a specific inlet
Max Basic Tutorial 9: Mouse Drawing Max Basic Tutorial 9: Mouse Drawing
Max Basic Tutorial 21: Controlling Data Flow Max Basic Tutorial 21: Controlling Data Flow