drunk
Max Reference
Open Help

drunk

Output random numbers within a step range

Description

Performs a "drunken" walk by outputting random numbers within a specified step range.

Examples

Numbers vary aimlessly in small steps taken within the total range

Arguments

maximum value [int]

Optional

Sets the maximum number produced. If this argument is not provided, the maximum value is set to 128.

step size [int]

Optional

Sets an initial limit on the size of random steps taken; the absolute value of the step size will always be less than the absolute value of this limit. If a negative value is specified as a step size, steps of size zero are never generated. If this argument is not provided, the step size is set to 2 (movement up or down by no more than 1).

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

Causes drunk to take a step of random size up or down from its currently stored value. It updates the stored value and outputs it.

int

Arguments

input [int]
The number replaces the stored value and is sent out the outlet.

  (inlet1)

Arguments

maximum [int]
In middle inlet: The number is stored as the maximum value that can be output by drunk. If the specified maximum is less than 0 it is set to 0 .

  (inlet2)

Arguments

step-size [int]
In right inlet: The number limits the step size taken in response to a bang in the left inlet. The step (up or down) will always be less than the absolute value of this number.

float

Arguments

input [float]
Converted to int .

seed

Arguments

random-seed [int]
Seeds the object's random generator, which causes a specific (reproducible) sequence of pseudo-random numbers to occur. The number 0 uses the time elapsed since system startup (an unpredictable value) as the seed, ensuring an unpredictable sequence of numbers.

set

Arguments

input [int]
The word set , followed by a number, sets the stored value to that number without triggering output. The stored value is initially set in the center of the total range (1/2 the maximum value).

Output

int

The number sent out the outlet is automatically limited between 0 and the specified maximum value, and differs from the previously stored number by less than the maximum step size.

See Also

Name Description
decide Choose randomly between 1 and 0
random Generate a random number
urn Generate random numbers without duplicates
Max Basic Tutorial 10: Random Drawing Max Basic Tutorial 10: Random Drawing