spell
Max Reference
Open Help

spell

Convert input to UTF-8 (Unicode) codes

Description

Accepts a numeric stream and outputs and outputs ASCII characters. Options arguments provide for forced-length messages.

Examples

Using the spell object, a modem command string or a synthesizer patch name can be translated from human terms into computer terms, and sent out the serial port in ASCII representation

Discussion

spell takes two optional arguments. The first is a minimum output size. The second is the UTF-8 number of a fill character to put between words and at the end of a word if it is less than the minimum output. The default minimum is 0 (none), and the default fill character is space (32), to use 0 as a fill character, supply a negative number as a second argument.

Arguments

size [int]

Optional

Sets the minimum output size. Any input that doesn't "spell" to the minimum length is followed by enough fill characters (the default is the space character, 32 in ASCII) to satisfy the minimum requirement.

character [int]

Optional

Specifies the fill character to use instead of 32. If you want to use '0' as a fill character, use any negative number as a second argument to spell.

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

int

Arguments

input [int]
The ASCII value of each of the digits of the number is sent out the outlet, one digit at a time.

list

Arguments

input [list]
Each int in the list is converted to ASCII as described above, and a space character (32) is sent out between items in the list. Any float or symbol items in the list are ignored.

anything

Arguments

input [list]
If the message begins with a symbol, all int and symbol items in the message are converted to ASCII one character at a time, and a space character (32) is placed between them. Any float items in the list are ignored. If the message begins with a float, both floats and symbols are ignored.

symbol

Arguments

input [symbol]
The ASCII value of each letter, digit, or other character in the symbol is sent out the outlet, one character at a time.

Outputs

int

The ASCII representation of the input is sent out one character at a time.

See Also

Name Description
atoi Convert ASCII characters to integers
itoa Convert integers to UTF-8 (Unicode) characters
key Report keyboard presses
keyup Report key information on release
message Send any message
sprintf Format a message of words and numbers