forward

Send messages to specified receive objects

Description

Relays messages to other objects remotely. Unlike the send object, the destination receive object of forward can be changed with each message.

Examples

Using forward to send messages to multiple objects at once... The same thing, with two send objects... The message box can perform the same function

Arguments

receiver [symbol]

Optional

Sets the name for the receive object which will receive messages. This name can later be changed with the send message.

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]

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

See the anything entry.

int

Arguments

input [int]
See the anything entry.

float

Arguments

input [float]
See the anything entry.

list

Arguments

input [list]
See the anything entry.

anything

Arguments

any message [list]
Sends any message to all receive objects which share the name currently referred to by forward.

send

Arguments

arguments [list]
The word send, followed by the name of a receive object, sets the destination for any subsequent messages received by the forward object. This ability to change the destination of messages on the fly distinguishes forward from the send object.

Output

anything

There are no outlets. A message (other than send) received in the inlet of forward is sent out the outlet of each receive object of the same name, even if the receive is in another patch.

See Also

Name Description
message Send any message
pattrforward Send any message to a named object
receive Receive messages without patch cords
route Select outlet based on input matching
send Send messages without patch cords
value Share data between other value objects