suitePrefs

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

suitePrefs([applyToSuite=string], [installedAsSuite=boolean], [isCompleteSuite=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

suitePrefs is undoable, NOT queryable, and NOT editable.

Return value

None

Flags

Long name (short name)	Argument types	Properties
applyToSuite(ats)	string
Apply the mouse and keyboard interaction settings for the given application to all applications in the Suite (if Maya is part of a Suites install). Valid values are "Maya", "3dsMax", or "undefined", which signifies that each app is to use their own settings.
installedAsSuite(ias)	boolean
Returns true if Maya is part of a Suites install, false otherwise.
isCompleteSuite(ics)	boolean
Returns true if the Suites install contains all Entertainment Creation Suite products, false otherwise.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

import maya.cmds as cmds
# Check if Maya is part of a Suites install
isSuiteInstall = cmds.suitePrefs(q=True, installedAsSuite=True)
if isSuiteInstall:
#   Check whether Maya mouse and keyboard interaction
#   has been applied to the Suite.
    applyMayaToSuite = cmds.suitePrefs(q=True, applyToSuite=True)
    if applyMayaToSuite:
#       Apply Maya mouse and keyboard interaction to
#       the Suite.
        cmds.suitePrefs(applyToSuite=True)