pymel.core.windows.menuSetPref¶

menuSetPref(*args, **kwargs)¶

Provides the functionality to save and load menuSets between sessions of Maya. For Internal Use Only! In query mode, return type is based on queried flag.

Flags:

Long Name / Short Name		Argument Types	Properties
exists / e		bool
	Returns whether the menuSet preferences file exists or not.
force / f		bool
	Forces a specified operation to continue even if errors are encountered (such as invalid preferences).
loadAll / la		bool
	Loads all the menuSets from the preferences file only if the preferences version matches, or the -force flag is enabled. On successful load, of a prefs file, an empty string is returned, otherwise, a description of the problem encountered is returned.
removeAll / ra		bool
	Removes all the menuSets from the preferences file (removes the whole file).
saveAll / sa		bool
	Saves all the current menuSets into the preferences file.
saveBackup / sb		bool
	Saves a backup of the current menu set preferences file if one exists. This backup will be saved in the same location as the current preferences file.
version / v		bool
	The base version string which is saved out to file. It is also checked upon loading in order to indicate changes in the default prefs since the prefs were last saved out. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.menuSetPref

Example:

import pymel.core as pm

# saving the current menuSets
pm.menuSetPref( saveAll=True )

# loading to the current menuSets if they exist
if pm.menuSetPref(exists=True) :
        pm.menuSetPref(loadAll=True)

# in certain cases, you may wish to remove previous preferences before saving
pm.menuSetPref( removeAll=True )