pymel.core.system.pluginInfo

pluginInfo(*args, **kwargs)

This command provides access to the plugin registry of the application. It is used mainly to query the characteristics of registered plugins. Plugins automatically become registered the first time that they are loaded. The argument is either the internal name of the plug-in or the path to access it.

Flags:
Long name (short name) Argument Types Properties
activeFile (af) bool ../../../_images/query.gif
 
Specifies that the -pluginsInUse/-pu flag should return the plugins used by the active file only, not the entire scene. For use during export selected.
apiVersion (av) bool ../../../_images/query.gif
 

returns a string containing the version of the API that this plugin was complied with. See the comments in MTypes.h for the details on how to interpret this value.

autoload (a) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
sets whether or not this plugin should be loaded every time the application starts up. Returns a boolean in query mode.
cacheFormat (cf) bool ../../../_images/query.gif
 
returns a string array containing the names of all of the registered geometry cache formats
changedCommand (cc) script ../../../_images/create.gif
 
adds a callback that will get executed every time the plugin registry changes. Any other previously registered callbacks will also get called.
command (c) unicode ../../../_images/query.gif
 

returns a string array containing the names of all of the normal commands registered by this plugin. Constraint, control, context and model editor commands are not included.

constraintCommand (cnc) unicode ../../../_images/query.gif
 

Returns a string array containing the names of all of the constraint commands registered by this plugin.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

controlCommand (ctc) unicode ../../../_images/query.gif
 
Returns a string array containing the names of all of the control commands registered by this plugin.
data (d) unicode, unicode ../../../_images/query.gif
 
returns a string array containing the names of all of the data types registered by this plugin.
dependNode (dn) bool ../../../_images/query.gif
 
returns a string array containing the names of all of the custom nodes types registered by this plugin.
dependNodeByType (dnt) unicode ../../../_images/query.gif
 

returns a string array of all registered node types within a specified class of nodes. Each custom node type registered by a plug-in belongs to a more general class of node types as specified by its MPxNode::Type. The flag’s argument is an MPxNode::Type as a string. For example, if you want to list all registered Locator nodes, you should specify kLocatorNode as a argument to this flag.

dependNodeId (dni) unicode ../../../_images/query.gif
 
returns a integer array containing the ids of all of the custom node types registered by this plugin.
device (dv) bool ../../../_images/query.gif
 
returns a string array containing the names of all of the devices registered by this plugin.
dragAndDropBehavior (ddb) bool ../../../_images/query.gif
 
returns a string array containing the names of all of the drag and drop behaviors registered by this plugin.
iksolver (ik) bool ../../../_images/query.gif
 
returns a string array containing the names of all of the ik solvers registered by this plugin.
listPlugins (ls) bool ../../../_images/query.gif
 
returns a string array containing all the plugins that are currently loaded.
listPluginsPath (lsp) bool  
   
loadPluginPrefs (lpp) bool ../../../_images/create.gif
 
loads the plugin preferences (ie. autoload) from pluginPrefs.mel into Maya.
loaded (l) bool ../../../_images/query.gif
 
returns a boolean specifying whether or not the plugin is loaded.
modelEditorCommand (mec) unicode ../../../_images/query.gif
 
Returns a string array containing the names of all of the model editor commands registered by this plugin.
name (n) unicode ../../../_images/query.gif
 
returns a string containing the internal name by which the plugin is registered.
path (p) unicode ../../../_images/query.gif
 
returns a string containing the absolute path name to the plugin.
pluginsInUse (pu) bool ../../../_images/query.gif
 
returns a string array containing all the plugins that are currently being used in the scene.
registered (r) bool ../../../_images/query.gif
 
returns a boolean specifying whether or not plugin is currently registered with the system.
remove (rm) bool ../../../_images/edit.gif
 
removes the given plugin’s record from the registry. There is no return value.
savePluginPrefs (spp) bool ../../../_images/create.gif
 
saves the plugin preferences (ie. autoload) out to pluginPrefs.mel
serviceDescriptions (sd) bool ../../../_images/query.gif
 
if there are services in use, then this flag will return a string array containing short descriptions saying what those services are.
settings (set) bool ../../../_images/query.gif
 
Returns an array of values with the loaded, autoload, registered flags
tool (t) unicode ../../../_images/query.gif
 
returns a string array containing the names of all of the tool contexts registered by this plugin.
translator (tr) bool ../../../_images/query.gif
 
returns a string array containing the names of all of the file translators registered by this plugin.
unloadOk (uo) bool ../../../_images/query.gif
 

returns a boolean that specifies whether or not the plugin can be safely unloaded. It will return false if the plugin is currently in use. For example, if the plugin adds a new dependency node type, and an instance of that node type is present in the scene, then this query will return false.

userNamed (u) bool ../../../_images/query.gif
 
returns a boolean specifying whether or not the plugin has been assigned a name by the user.
vendor (vd) unicode ../../../_images/query.gif
 
returns a string containing the vendor of the plugin.
version (v) bool ../../../_images/query.gif
 
returns a string containing the version the plugin.

Derived from mel command maya.cmds.pluginInfo

Example:

import pymel.core as pm

# List the plugins that are currently loaded
pm.pluginInfo( query=True, listPlugins=True )
# Result: [u'OpenEXRLoader', u'DirectConnect', u'AbcImport', u'mayaHIK', u'Mayatomr', u'ikSpringSolver', u'tiffFloatReader', u'AbcExport', u'VectorRender', u'ArubaTessellator', u'quatNodes', u'mayaCharacterization', u'gpuCache', u'rotateHelper', u'Substance', u'MayaMuscle', u'OneClick', u'AutodeskPacketFile', u'retargeterNodes', u'fbxmaya', u'matrixNodes', u'stereoCamera', u'sceneAssembly', u'ik2Bsolver'] #

# Find the vendor of a plugin
pm.pluginInfo( 'newNode.py', query=True, vendor=True )

# Find the commands provided by a given plug-in
pm.pluginInfo( 'helloCmd.py', query=True, command=True )

# Turn on autoloading for a plug-in
pm.pluginInfo( 'newNode.py', edit=True, autoload=True )

# Return all custom locators registered by plug-ins.
pm.pluginInfo( query=True, dependNodeByType="kLocatorNode" )

Previous topic

pymel.core.system.pluginDisplayFilter

Next topic

pymel.core.system.preloadRefEd

Core

Core Modules

Other Modules

This Page