pluginInfo

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

Synopsis

pluginInfo( [string] , [activeFile=boolean], [animCurveInterp=string], [apiVersion=boolean], [autoload=boolean], [cacheFormat=boolean], [changedCommand=script], [command=string], [constraintCommand=string], [controlCommand=string], [data=[string, string]], [dependNode=boolean], [dependNodeByType=string], [dependNodeId=string], [device=boolean], [dragAndDropBehavior=boolean], [iksolver=boolean], [listPlugins=boolean], [listPluginsPath=boolean], [loadPluginPrefs=boolean], [loaded=boolean], [modelEditorCommand=string], [name=string], [path=string], [pluginsInUse=boolean], [registered=boolean], [remove=boolean], [renderer=boolean], [savePluginPrefs=boolean], [serviceDescriptions=boolean], [settings=boolean], [tool=string], [translator=boolean], [unloadOk=boolean], [userNamed=boolean], [vendor=string], [version=boolean], [writeRequires=boolean])

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

pluginInfo is undoable, queryable, and editable.

The argument is either the internal name of the plug-in or the path to access it.

Return value

In query mode, return type is based on queried flag.

Related

Flags

Long name (short name)	Argument types	Properties
activeFile(af)	boolean
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)	string
Returns a string array containing the names of all of the animation curve interpolators registered by this plug-in.
apiVersion(av)	boolean
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)	boolean
Sets whether or not this plug-in should be loaded every time the application starts up. Returns a boolean in query mode.
cacheFormat(cf)	boolean
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)	string
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)	string
Returns a string array containing the names of all of the constraint commands registered by this plug-in.
controlCommand(ctc)	string
Returns a string array containing the names of all of the control commands registered by this plug-in.
data(d)	[string, string]
Returns a string array containing the names of all of the data types registered by this plug-in.
dependNode(dn)	boolean
Returns a string array containing the names of all of the custom nodes types registered by this plug-in.
dependNodeByType(dnt)	string
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)	string
Returns an integer array containing the ids of all of the custom node types registered by this plug-in.
device(dv)	boolean
Returns a string array containing the names of all of the devices registered by this plug-in.
dragAndDropBehavior(ddb)	boolean
Returns a string array containing the names of all of the drag and drop behaviors registered by this plug-in.
iksolver(ik)	boolean
Returns a string array containing the names of all of the ik solvers registered by this plug-in.
listPlugins(ls)	boolean
Returns a string array containing all the plug-ins that are currently loaded.
listPluginsPath(lsp)	boolean
Returns a string array containing the full paths of all the plug-ins that are currently loaded.
loadPluginPrefs(lpp)	boolean
Loads the plug-in preferences (ie. autoload) from pluginPrefs.mel into Maya.
loaded(l)	boolean
Returns a boolean specifying whether or not the plug-in is loaded.
modelEditorCommand(mec)	string
Returns a string array containing the names of all of the model editor commands registered by this plug-in.
name(n)	string
Returns a string containing the internal name by which the plug-in is registered.
path(p)	string
Returns a string containing the absolute path name to the plug-in.
pluginsInUse(pu)	boolean
Returns a string array containing all the plug-ins that are currently being used in the scene.
registered(r)	boolean
Returns a boolean specifying whether or not plug-in is currently registered with the system.
remove(rm)	boolean
Removes the given plug-in's record from the registry. There is no return value.
renderer(rdr)	boolean
Returns a string array containing the names of all of the renderers registered by this plug-in.
savePluginPrefs(spp)	boolean
Saves the plug-in preferences (ie. autoload) out to pluginPrefs.mel
serviceDescriptions(sd)	boolean
If there are services in use, then this flag will return a string array containing short descriptions saying what those services are.
settings(set)	boolean
Returns an array of values with the loaded, autoload, registered flags
tool(t)	string
Returns a string array containing the names of all of the tool contexts registered by this plug-in.
translator(tr)	boolean
Returns a string array containing the names of all of the file translators registered by this plug-in.
unloadOk(uo)	boolean
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)	boolean
Returns a boolean specifying whether or not the plug-in has been assigned a name by the user.
vendor(vd)	string
Returns a string containing the vendor of the plug-in.
version(v)	boolean
Returns a string containing the version the plug-in.
writeRequires(wr)	boolean
Sets whether or not this plug-in should write "requires" command into the saved file. "requires" command 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, "stereoCamera" is using this flag for its customized UI.

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

# List the plug-ins that are currently loaded
cmds.pluginInfo( query=True, listPlugins=True )

# Find the vendor of a plug-in
cmds.pluginInfo( 'newNode.py', query=True, vendor=True )

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

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

# Make maya write requires command in the saved file for a plug-in
cmds.pluginInfo( 'pluginName', edit=True, writeRequires=True )

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