zl.scramble Reference

Scramble a list

zl.scramble

Description

zl.scramble accepts a list in either inlet. A list in the left inlet will cause the object to immediately output a scrambled version of the input-list (a list containing the same elements as the input-list but in a randomized order). A list in the right inlet will set the input-list without causing output (a subsequent bang received in the left inlet will cause a randomized version of the right-input list to be sent out the object's left outlet). On receiving a bang or list in the left inlet, a list of the reordered indexes will be sent out the objects' right outlet.

Arguments

initial-list [list]

Optional

Initial list

Attributes

zlmaxsize [atom_long]

Maximum List Length

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

A bang input to the left inlet will scramble the stored list and output it.

int

TEXT_HERE

float

TEXT_HERE

list

In left inlet:
Store, scramble and output list.

In right inlet:
Sets items to scramble (does not cause output).

anything

TEXT_HERE

mode

The word 'mode' followed by one of the following words will set the mode of the object:
change, compare, delace, ecils, group, indexmap, iter, join, lace, len, lookup, median, mth, nth, queue, reg, rev, rot, scramble, sect, slice, sort, stack, stream, sub, sum, swap, thin, union, or unique.

See the reference for the corresponding mode for more information.

zlclear

Clears the currently held list.

Output

anything

Out left outlet:
Scrambled list.

Out right outlet:
Reordered indexes of list.

See Also

Name Description
zl Process lists in many ways
zl.change Filter out list repetitions
zl.compare Compare two lists
zl.delace De-interleave a list
zl.ecils Slice a list in reverse order
zl.filter Remove items in a list
zl.group Store and output a list
zl.indexmap Create new list from list of indexes
zl.iter Successively output lists of specific size
zl.join Combine two lists
zl.lace Interleave two lists
zl.len Get list length
zl.lookup Output elements of a list
zl.median Get the median value of a list of numbers
zl.mth Extract item from list
zl.nth Extract item from list
zl.queue Output elements of a list in the order they are received
zl.reg Store and output a list
zl.rev Reverse a list
zl.rot Rotate a list
zl.sect Find common items between two lists
zl.slice Slice a list in two
zl.sort Arrange a list in alphanumeric order
zl.stack Output elements of a list in reverse order
zl.stream Make a list of a certain size
zl.sub Output position for each occurance of right list in left
zl.sum Sum a list of numbers
zl.swap Swap two list indexes
zl.thin Remove duplicates from list
zl.union Combine two lists without duplicating shared items
zl.unique Remove items from a list