substitute
Max Reference
Open Help

substitute

Substitute symbols within a message

Description

Matches messages to its own arguments; whenever it finds a match, will make the appropriate substitution.

Examples

substitute can translate messages output by one object to what's expected by another object

Arguments

match [anything]

Optional

The first number or symbol specifies the match, which identifies what should be replaced in an incoming message. The default match value is 0.

replacement [anything]

Optional

The second number or symbol specifies the replacement for the match. The default replacement value is 0.

mode [anything]

Optional

Any third number or symbol sets the "replace first message only" mode of the substitute object. Only the first instance of the specified match will be replaced.

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.

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 [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

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

Same as anything .

int

Arguments

input [int]
Same as anything .

float

Arguments

input [float]
Same as anything .

list

Arguments

input [list]
Same as anything .

anything

Arguments

input [list]
In left inlet: The input is echoed to the output, but if the message received contains an element matching the match symbol or number, the element is replaced by the replacement symbol or number when the message is repeated to the output.

In right inlet: The substitute object accepts a message of two numbers or symbols in its right inlet. The first number or symbol specifies the match, which identifies what should be replaced in an incoming message.

set

Arguments

input [list]
In left inlet: Same as anything .
In right inlet: Same as anything , except that the word set is ignored.

Output

anything

Out left outlet: The input message is echoed to the output with elements matching the match symbol or number replaced by the replacement number or symbol.

bang

Out right outlet: If no substitution occurred when sending out the incoming message, the original input message is passed out the rightmost outlet.

See Also

Name Description
route Select outlet based on input matching
sprintf Format a message of words and numbers
zl Process lists in many ways