decode

Send 1 or 0 out a specific outlet

Description

Provides hierarchical switching. The right inlet is the master disable switch, while the middle inlet is a submaster enable. The left inlet can turn on a single outlet provided neither the submaster switch nor the master switch is active.

Examples

decode is a hierarchical on/off switch

Arguments

outlets [int]

Optional

Sets the number of outlets. The default is one outlet.

outlets [float]

Optional

Converted to int.

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

The message bang causes decode to output its current state.

int

Arguments

outlet [int]
In left inlet: The number specifies an outlet out to turn on, turning off all other outlets. (Whenever an outlet is turned on that was previously turned off, a 1 is sent out. Conversely, whenever an enabled outlet is disabled, a 0 is sent out.) The outlets are referred to by number, beginning with 0 on the left, and numbers received in the left inlet are automatically limited between 0 and the number of outlets minus 1.

  (inlet1)

Arguments

submaster [int]
In middle inlet: Any positive number other than 0 enables all disabled outlets (sends a 1 out them), unless all outlets are disabled. When 0 is received, decode turns off all outlets except the one that had previously been on.

  (inlet2)

Arguments

master [int]
In right inlet: Any positive number other than 0 disables all enabled outlets (sends a 0 out them). Once all outlets have been disabled in this manner, no outlet can be enabled until a 0 is received in the right inlet. When a 0 is received, decode re-enables all outlets that it had just disabled.

Output

int

When an outlet is enabled that was previously disabled, a 1 is sent out that outlet. When an outlet is disabled that was previously enabled, a 0 is sent out that outlet. The left outlet is initially enabled.

See Also

Name Description
bucket Pass numbers from outlet to outlet
gate Pass input to an outlet
toggle Switch between off and on (0/1)