sprintf
Format a message of words and numbers
Description
Uses the common C-language "printf" function inside Max. You can combine symbols, organize lists of numbers, or format messages or menu items. For complete documentation, refer to a standard C library reference manual.
Arguments
symout[symbol]
optional
If the first argument is the word sprintf object outputs the string it generates as a single symbol. Otherwise the output is a list of symbols and/or numbers. The word itself is not included in the output of sprintf.
, the
format[symbol]
optional
The arguments form a message to be sent out, in a format resembling the C programming language. The arguments may be words, numbers, or changeable arguments for incoming symbols (
( ), floats ( ), and ints that are to be formatted as ASCII characters ( ). The number of inlets is determined by the number of changeable arguments, with each inlet corresponding to a changeable argument, in order.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]: 0
Adds or removes the object from the patcher's background layer.
adds the object to the background layer, 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'
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]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
JS Painter File
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
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]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 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]
write-only
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]
write-only
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: Formats the message using the values currently stored.
Any of the above messages in the left inlet will format the message and send it out. If no value has been received for a changeable number argument ( or ), 0 will be substituted for that argument. If no value has been received for a or argument, that argument will be left blank.
int
May be received in any inlet that corresponds to a
or argument. The number will be stored in place of that argument. A argument will convert the int to its ASCII character equivalent.- input
[int]
float
May be received in any inlet that corresponds to a
argument. The number will be stored in place of that argument.- input
[float]
list
In left inlet: Each item in the list is treated as if it had been received in a separate inlet, up to the number of inlets.
- input
[list]
anything
Performs the same function as a
.- input
[list]
symbol
May be received in any inlet that corresponds to a
argument. The symbol will be stored in place of that argument.- input
[symbol]
Output
anything
The message specified by the typed-in argument(s) is formatted and sent out with substitutions made for the changeable arguments.
See Also
Name | Description |
---|---|
atoi | Convert ASCII characters to integers |
combine | Combine multiple items into a single symbol |
fromsymbol | Convert a symbol into numbers/messages |
itoa | Convert integers to UTF-8 (Unicode) characters |
key | Report keyboard presses |
keyup | Report key information on release |
message | Send any message |
regexp | Use regular expressions to process input |
spell | Convert input to UTF-8 (Unicode) codes |
tosymbol | Convert messages, numbers, or lists to a single symbol |