pluginInfo

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

Synopsis

pluginInfo( [pluginName | plugin path] , [apiVersion=boolean], [autoload=boolean], [changedCommand=string], [command=string], [data=[string, string]], [dependNode=[string, string]], [dependNodeInfo=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.

Flags

Long name (short name)	[argument types]	Properties
name(n)	string
returns a string containing the internal name by which the plugin is registered. In query mode, this flag needs a value.
path(p)	string
returns a string containing the absolute path name to the plugin. In query mode, this flag needs a value.
vendor(vd)	string
returns a string containing the vendor of the plugin. In query mode, this flag needs a value.
version(v)	boolean
returns a string containing the version the plugin. In query mode, this flag needs a value.
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. In query mode, this flag needs a value.
listPlugins(ls)	boolean
returns a string array containing all the plugins that are currently loaded. In query mode, this flag needs a value.
pluginsInUse(pu)	boolean
returns a string array containing all the plugins that are currently being used in the scene. In query mode, this flag needs a value.
loaded(l)	boolean
returns a boolean specifying whether or not the plugin is loaded. In query mode, this flag needs a value.
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. In query mode, this flag needs a value.
autoload(a)	boolean
sets whether or not this plugin should be loaded every time the application starts up. Returns a boolean in query mode. In query mode, this flag needs a value.
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. In query mode, this flag needs a value.
tool(t)	string
returns a string array containing the names of all of the tool contexts registered by this plugin. In query mode, this flag needs a value.
dependNode(dn)	[string, string]
returns a string array containing the names of all of the nodes registered by this plugin. In query mode, this flag needs a value.
dependNodeInfo(dni)	string
returns a integer array containing the ids of all of the nodes registered by this plugin. In query mode, this flag needs a value.
data(d)	[string, string]
returns a string array containing the names of all of the data types registered by this plugin. In query mode, this flag needs a value.
translator(tr)	string
returns a string array containing the names of all of the file translators registered by this plugin. In query mode, this flag needs a value.
iksolver(ik)	string
returns a string array containing the names of all of the ik solvers registered by this plugin. In query mode, this flag needs a value.
device(dv)	string
returns a string array containing the names of all of the devices registered by this plugin. In query mode, this flag needs a value.
dragAndDropBehavior(ddb)	string
returns a string array containing the names of all of the drag and drop behaviors registered by this plugin. In query mode, this flag needs a value.
userNamed(u)	boolean
returns a boolean specifying whether or not the plugin has been assigned a name by the user. In query mode, this flag needs a value.
registered(r)	boolean
returns a boolean specifying whether or not plugin is currently registered with the system. In query mode, this flag needs a value.
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. In query mode, this flag needs a value.
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 In query mode, this flag needs a value.

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.

Return value

Related

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 )