Go to: Synopsis. Return value. Related. Flags. Python examples.
pluginInfo(
[string]
, [activeFile=boolean], [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], [loadPluginPrefs=boolean], [loaded=boolean], [modelEditorCommand=string], [name=string], [path=string], [pluginsInUse=boolean], [registered=boolean], [remove=boolean], [savePluginPrefs=boolean], [serviceDescriptions=boolean], [settings=boolean], [tool=string], [translator=boolean], [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.
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.
| Any | Dependent upon the action requested. |
In query mode, return type is based on queried flag.
loadPlugin, openMayaPref, unloadPlugin
activeFile, apiVersion, autoload, cacheFormat, changedCommand, command, constraintCommand, controlCommand, data, dependNode, dependNodeByType, dependNodeId, device, dragAndDropBehavior, iksolver, listPlugins, loadPluginPrefs, loaded, modelEditorCommand, name, path, pluginsInUse, registered, remove, savePluginPrefs, serviceDescriptions, settings, tool, translator, unloadOk, userNamed, vendor, version
| 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
normal commands registered by this plugin.
Constraint, control, context and model editor commands are not included.
|
|
tool(t)
|
string
|
|
|
returns a string array containing the names of all of the
tool contexts registered by this plugin.
|
|
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.
|
|
dependNode(dn)
|
boolean
|
|
|
returns a string array containing the names of all of the
custom nodes types registered by this plugin.
|
|
dependNodeId(dni)
|
string
|
|
|
returns a integer array containing the ids of all of the
custom node types 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)
|
boolean
|
|
|
returns a string array containing the names of all of the
file translators registered by this plugin.
|
|
iksolver(ik)
|
boolean
|
|
|
returns a string array containing the names of all of the
ik solvers registered by this plugin.
|
|
device(dv)
|
boolean
|
|
|
returns a string array containing the names of all of the
devices registered by this plugin.
|
|
dragAndDropBehavior(ddb)
|
boolean
|
|
|
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)
|
script
|
|
|
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)
|
boolean
|
|
|
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.
|
|
modelEditorCommand(mec)
|
string
|
|
|
Returns a string array containing the names of all of the
model editor commands registered by this plugin.
|
|
controlCommand(ctc)
|
string
|
|
|
Returns a string array containing the names of all of the
control commands registered by this plugin.
|
|
constraintCommand(cnc)
|
string
|
|
|
Returns a string array containing the names of all of the
constraint commands registered by this plugin.
|
|
|
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.
|
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 )
# Return all custom locators registered by plug-ins.
cmds.pluginInfo( query=True, dependNodeByType="kLocatorNode" )