pluginInfo

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

Synopsis

pluginInfo( [string] , [activeFile=boolean], [apiVersion=boolean], [autoload=boolean], [cacheFormat=string], [changedCommand=string], [command=string], [data=[string, string]], [dependNode=[string, string]], [dependNodeId=string], [device=string], [dragAndDropBehavior=string], [iksolver=string], [listPlugins=boolean], [loadPluginPrefs=boolean], [loaded=boolean], [name=string], [path=string], [pluginsInUse=boolean], [registered=boolean], [remove=boolean], [savePluginPrefs=boolean], [serviceDescriptions=boolean], [settings=boolean], [tool=string], [translator=string], [unloadOk=boolean], [userNamed=boolean], [vendor=string], [version=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
name(n)	string
returns a string containing the internal name by which the plugin is registered.
path(p)	string
returns a string containing the absolute path name to the plugin.
vendor(vd)	string
returns a string containing the vendor of the plugin.
version(v)	boolean
returns a string containing the version the plugin.
apiVersion(av)	boolean
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.
listPlugins(ls)	boolean
returns a string array containing all the plugins that are currently loaded.
pluginsInUse(pu)	boolean
returns a string array containing all the plugins that are currently being used in the scene.
loaded(l)	boolean
returns a boolean specifying whether or not the plugin is loaded.
unloadOk(uo)	boolean
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.
autoload(a)	boolean
sets whether or not this plugin should be loaded every time the application starts up. Returns a boolean in query mode.
savePluginPrefs(spp)	boolean
saves the plugin preferences (ie. autoload) out to pluginPrefs.mel
loadPluginPrefs(lpp)	boolean
loads the plugin preferences (ie. autoload) from pluginPrefs.mel into Maya.
command(c)	string
returns a string array containing the names of all of the commands registered by this plugin.
tool(t)	string
returns a string array containing the names of all of the tool contexts registered by this plugin.
dependNode(dn)	[string, string]
returns a string array containing the names of all of the nodes registered by this plugin.
dependNodeId(dni)	string
returns a integer array containing the ids of all of the nodes registered by this plugin.
data(d)	[string, string]
returns a string array containing the names of all of the data types registered by this plugin.
translator(tr)	string
returns a string array containing the names of all of the file translators registered by this plugin.
iksolver(ik)	string
returns a string array containing the names of all of the ik solvers registered by this plugin.
device(dv)	string
returns a string array containing the names of all of the devices registered by this plugin.
dragAndDropBehavior(ddb)	string
returns a string array containing the names of all of the drag and drop behaviors registered by this plugin.
userNamed(u)	boolean
returns a boolean specifying whether or not the plugin has been assigned a name by the user.
registered(r)	boolean
returns a boolean specifying whether or not plugin is currently registered with the system.
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.
remove(rm)	boolean
removes the given plugin's record from the registry. There is no return value.
changedCommand(cc)	string
adds a callback that will get executed every time the plugin registry changes. Any other previously registered callbacks will also get called.
settings(set)	boolean
Returns an array of values with the loaded, autoload, registered flags
cacheFormat(cf)	string
returns a string array containing the names of all of the registered geometry cache formats
activeFile(af)	boolean
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.

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 plugins that are currently loaded
cmds.pluginInfo( query=True, listPlugins=True )

# Find the vendor of a plugin
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 )