if

Conditional statement in if/then/else form

Description

Evaluates input according to a conditional statement specified in an if-then-else form.

Examples

Complex comparisons and results can be described in a single object

Arguments

if [symbol]

The arguments for the if object start with a conditional statement that uses the same syntax as expr. The word then follows the conditional statement, which is then followed by a message expression. After the message expression, there is an optional else and a second message expression.
if evaluates the conditional expression, and if the result is non-zero, evaluates the message expression after the word then. Otherwise, it evaluates the second message expression after the word else if an else message is provided.

then, else [symbol]

Message expressions are similar to what you type into a message box.

$i1, $f1, $s1 [symbol]

You use $i1, $f1, or $s1 instead of $1 for replaceable arguments. The number of inlets is determined by how many different changeable arguments are typed in. The maximum number of inlets is 9.

send [symbol]

No commas or semicolons are allowed. Messages can be sent to remote receive objects by preceding the message expression with send, followed by the name of the receive object.

out2 [symbol]

The keyword out2 in a message expression creates a second, right outlet for the if object. If out2 precedes a message expression, the result of the expression is sent out the right outlet instead of the left outlet.

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

In left inlet: Evaluates the conditional statement using the values currently stored.

int

Arguments

input [int]
The number in each inlet will be stored in place of the $i or $f argument associated with it, and the expression will be evaluated.

  (inlet1)

Arguments

input [int]
Replace the $i1 value

  (inlet2)

Arguments

input [int]
Replace the $i2 value

  (inlet3)

Arguments

input [int]
Replace the $i3 value

  (inlet4)

Arguments

input [int]
Replace the $i4 value

  (inlet5)

Arguments

input [int]
Replace the $i5 value

  (inlet6)

Arguments

input [int]
Replace the $i6 value

  (inlet7)

Arguments

input [int]
Replace the $i7 value

  (inlet8)

Arguments

input [int]
Replace the $i8 value

  (inlet9)

Arguments

input [int]
Replace the $i9 value

float

Arguments

input [float]
The number in each inlet will be stored in place of the $i or $f argument associated with it, and the expression will be evaluated.

  (inlet1)

Arguments

input [float]
Replace the $f1 value

  (inlet2)

Arguments

input [float]
Replace the $f2 value

  (inlet3)

Arguments

input [float]
Replace the $f3 value

  (inlet4)

Arguments

input [float]
Replace the $f4 value

  (inlet5)

Arguments

input [float]
Replace the $f5 value

  (inlet6)

Arguments

input [float]
Replace the $f6 value

  (inlet7)

Arguments

input [float]
Replace the $f7 value

  (inlet8)

Arguments

input [float]
Replace the $f8 value

  (inlet9)

Arguments

input [float]
Replace the $f9 value

set

Arguments

set-input [list]
The word set, followed by one or more numbers, treats those numbers as if each had come in a different inlet, replacing the stored value with the new value, but the conditional statement is not evaluated and nothing is sent out the outlet. If there are fewer numbers in the message than there are inlets, the stored value in each remaining inlet is left unchanged.

symbol

Arguments

input [symbol]
Symbols can only be received in the first inlet. If received in the first inlet, a symbol will be stored in place of the $s argument associated with it, and the expression will be evaluated, with the exception that you cannot do comparisons or use other operators with symbols. If the symbol shares the name of a table object, you can specify a position in the table to be evaluated.

Output

anything

The message after the then or else portion of the arguments is sent out the outlet. If the word out2 is present as an argument, there will be two outlets, and messages following out2 will be sent out the right outlet. If the word send is present as an argument, the word that follows it is the name of a receive object, and the message that follows it will be sent to receive objects with that name.

See Also

Name Description
!= Compare numbers for not-equal-to condition
< Compare numbers for less than condition
<= Compare numbers as less than or equal to
== Compare numbers for equal-to condition
> Compare numbers for greater than condition
>= Compare numbers for greater than or equal to condition
expr Evaluate a mathematical expression
select Output bangs based on input matching
Max Basic Tutorial 22: Designing Equations Max Basic Tutorial 22: Designing Equations