pymel.core.system.pluginInfo¶
- pluginInfo(*args, **kwargs)¶
This command provides access to the plug-in registry of the application. It is used mainly to query the characteristics of registered plug-ins. 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 Restricts the command to the active file only, not the entire scene. This only affects the -dependNode/-dn and -pluginsInUse/-pu flags. For use during export selected. animCurveInterp / aci unicode Returns a string array containing the names of all of the animation curve interpolators registered by this plug-in. apiVersion / av bool Returns a string containing the version of the API that this plug-in was compiled with. See the comments in MTypes.h for the details on how to interpret this value. autoload / a bool Sets whether or not this plug-in should be loaded every time the application starts up. Returns a boolean in query mode. cacheFormat / cf bool Returns a string array containing the names of all of the registered geometry cache formats changedCommand / cc script Adds a callback that will get executed every time the plug-in registry changes. Any other previously registered callbacks will also get called. command / c unicode Returns a string array containing the names of all of the normal commands registered by this plug-in. Constraint, control, context and model editor commands are not included. constraintCommand / cnc unicode Returns a string array containing the names of all of the constraint commands registered by this plug-in. controlCommand / ctc unicode Returns a string array containing the names of all of the control commands registered by this plug-in. data / d unicode, unicode Returns a string array containing the names of all of the data types registered by this plug-in. dependNode / dn bool Returns a string array containing the names of all of the custom nodes types registered by this plug-in. dependNodeByType / dnt unicode 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 Returns an integer array containing the ids of all of the custom node types registered by this plug-in. device / dv bool Returns a string array containing the names of all of the devices registered by this plug-in. dragAndDropBehavior / ddb bool Returns a string array containing the names of all of the drag and drop behaviors registered by this plug-in. iksolver / ik bool Returns a string array containing the names of all of the ik solvers registered by this plug-in. listPlugins / ls bool Returns a string array containing all the plug-ins that are currently loaded. listPluginsPath / lsp bool Returns a string array containing the full paths of all the plug-ins that are currently loaded. loadPluginPrefs / lpp bool Loads the plug-in preferences (ie. autoload) from pluginPrefs.mel into Maya. loaded / l bool Returns a boolean specifying whether or not the plug-in is loaded. modelEditorCommand / mec unicode Returns a string array containing the names of all of the model editor commands registered by this plug-in. name / n unicode Returns a string containing the internal name by which the plug-in is registered. path / p unicode Returns a string containing the absolute path name to the plug-in. pluginsInUse / pu bool Returns a string array containing all the plug-ins that are currently being used in the scene. registered / r bool Returns a boolean specifying whether or not plug-in is currently registered with the system. remove / rm bool Removes the given plug-in’s record from the registry. There is no return value. renderer / rdr bool Returns a string array containing the names of all of the renderers registered by this plug-in. savePluginPrefs / spp bool Saves the plug-in preferences (ie. autoload) out to pluginPrefs.mel serviceDescriptions / sd bool 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 Returns an array of values with the loaded, autoload, registered flags tool / t unicode Returns a string array containing the names of all of the tool contexts registered by this plug-in. translator / tr bool Returns a string array containing the names of all of the file translators registered by this plug-in. unloadOk / uo bool Returns a boolean that specifies whether or not the plug-in can be safely unloaded. It will return false if the plug-in is currently in use. For example, if the plug-in 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 Returns a boolean specifying whether or not the plug-in has been assigned a name by the user. vendor / vd unicode Returns a string containing the vendor of the plug-in. version / v bool Returns a string containing the version the plug-in. writeRequires / wr bool Sets whether or not this plug-in should write requirescommand into the saved file. requirescommand could autoload the plug-in when you open or import that saved file. This way, Maya will load the plug-in when a file is being loaded for some specified reason, such as to create a customized UI or to load some plug-in data that is not saved in any node or attributes. For example, stereoCamerais using this flag for its customized UI. Flag can have multiple arguments, passed either as a tuple or a list. 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" )