bag

Store a collection of numbers

Description

Stores and manages a collection of numbers. You can add to or delete an integer from a bag as report its contents. bag with any argument maintains multiple entries with the same item; otherwise it holds only one of each.

Examples

Store a collection of numbers........ Used here to detect held notes

Arguments

duplicate-flag [symbol]

Optional

The presence of any symbol argument causes the bag to store duplicate values. If there is no argument, bag will store only one of each number at a time.

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

In left inlet: Causes bag to send all its collected numbers out the outlet.

int

Arguments

input [int]
In left inlet: The number is either added to or deleted from the collection of numbers stored in the bag object, depending on the number in the right inlet.

In right inlet: The number is stored as an indicator of whether to include or delete the next number received in the left inlet. If non-zero, the number received in the left inlet is added to the bag. If 0, the number is deleted from the collection.

No output is triggered by a number received in either inlet.

  (inlet1)

Arguments

function [int]
In right inlet: The number is stored as an indicator of whether to include or delete the next number received in the left inlet. If non-zero, the number received in the left inlet is added to the bag. If 0, the number is deleted from the bag.

No output is triggered by a number received in either inlet.

float

Arguments

input [float]
Converted to int.

clear

In left inlet: Deletes the entire contents of the bag.

cut

In left inlet: Sends out the oldest (earliest received) number stored in the bag object, and deletes it from the bag.

length

In left inlet: Reports how many numbers are currently stored in the bag.

send

Arguments

receive-name [list]
In left inlet: The word send, followed by the name of a receive object, sends the result of a bang message to all receive objects with that name, instead of out the bag object's outlet.

list

Arguments

input [int]
function [int]
Any list composed of two numbers behaves as though the first list item was sent to the left inlet and the second list item was sent to the right inlet. If the second element of the list is a non-zero number, the number is added to the collection.

Output

int

When bang is received in the left inlet, all the numbers stored in bag are sent out one at a time, in reverse order from that in which they were stored.

When cut is received in the left inlet, the oldest stored number is sent out.

When length is received in the left inlet, the number of items in the bag object is sent out.

See Also

Name Description
coll Store and edit a collection of data
funbuff Store pairs of numbers
offer Store one-time number pairs