accum Reference

Store, add to, and multiply a number

accum

Description

Stores a value (int or float), then adds or multiplies into it. If the argument is an integer, the multiplication is done in floating-point then converted to integer.

Examples

Add to and/or multiply a stored value....... Used here to increment by different amounts

Arguments

initial [int or float]

Optional

Sets the initial value stored in accum. An argument with a decimal point causes the value to be stored as a float.

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

In left inlet: Outputs the value currently stored in accum.

int

Arguments

input [int]
In left inlet: Replaces the value stored in accum, and sends the new value out the outlet.

  (inlet1)

Arguments

input [int]
In middle inlet: The number is added to the stored value, without triggering output.

  (inlet2)

Arguments

input [float]
In right inlet: The stored value is multiplied by the input, without triggering output.

float

Arguments

input [float]
In left and middle inlet: Converted to int, unless accum has a float argument.

In right inlet: Multiplication is done with floats, even if the value is stored as an int.

  (inlet1)

Arguments

input [float]
In left inlet: The message ft1, followed by a number, adds the number to the stored value without triggering output.

set

Arguments

input [int]
In left inlet: The word set, followed by a number, sets the stored value to that number, without triggering output.

Output

float

Floats are output only if there is an argument with a decimal point.

int

The value currently held by accum.

See Also

Name Description
counter Keep count based on bang messages
float Store a decimal number
int Store an integer value