mappings

Utility object for Mappings

Description

The mappings object allows you to enable and disable keyboard and MIDI mapping from your Max patcher, as well as some other useful utilities.

Arguments

None.

Attributes

file [symbol] (default: )

The file attribute can be used to specify the current .maxmap file.

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

(mouse)

Double-click on the mappings object to open the Mappings Window for the current patcher.

key

Arguments

on/off [int]
A non-zero value for on/off will enable Keyboard Mapping mode. A zero value will disable it.

midi

Arguments

on/off [int]
A non-zero value for on/off will enable MIDI Mapping mode. A zero value will disable it.

open

Open the Mappings Window for the current patcher.

read

Arguments

filename [symbol]
The message read followed by a filename argument will attempt to read the specified .maxmap file and apply the contained mappings to the current patcher. Without an argument, an Open File dialog will be presented.

write

Arguments

filename [symbol]
The message write followed by a filename argument will attempt to write the current mappings to the specified .maxmap file. Without an argument, a Save File dialog will be presented.

See Also

Name Description
midiin Output raw MIDI data
notein Receive MIDI note messages
ctlin Output received MIDI control values
bendin Output MIDI pitch bend values
xbendin Interpret extra precision MIDI pitch bend values
key Report keyboard presses