A newer version of Max is available. Click here to access the latest version of the documentation

filepath Reference

Manage and report on the Max search path

filepath

Description

Provides access to the Max search path, and allows modification to the search path used by a patch.

Examples

Use filepath to check your search path or temporarily set search path slots for a patch

Discussion

The filepath object is used in the File Preferences patcher to report and change the various folders Max uses to look for files at certain times. It can assist with managing search paths in the File Preferences patcher or manage paths specific to a single patch.

Arguments

path-type [symbol]

Specifies one of the Max search path types (search, startup, help, action, or default)

preference [int]

Optional

A number greater than zero specifies a slot in the Preferences file. If the argument is 0 or no number is supplied, the path will not be saved in the Preferences file.

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.

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

bang causes the currently saved path name(s) to be output as a list.

append

Arguments

folder [list]
subfolder-flag [int]
The word append, followed by a symbol which specifies a folder, adds the folder to the list of paths (but does not save it in the Preferences file). An optional integer subfolder flag will also add any subfolders when set to 1.

clear

Arguments

input [int]
This method is obsolete. Currently, it has no effect.

revert

Causes the pathnames to be reset to the last set of Max file preferences to be saved.

set

Arguments

pathtype [list]
subfolder-flag [int]
The word set, followed by the name of a Max search path type (search, startup, help, action, or default), sets the current search path to the type specified. An optional integer subfolder flag will also add any subfolders when set to 1.

Output

symbol

The currently stored path name in response to a bang.

See Also

Name Description
Search Paths Search Paths
conformpath Convert file paths styles
filedate Report the modification date of a file
folder List the files in a folder
opendialog Open a dialog to ask for a file or folder