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

Synopsis

pluginInfo [-apiVersion] [-autoload boolean] [-changedCommand string] [-command string] [-data string string] [-dependNode string string] [-dependNodeInfo string] [-device string] [-dragAndDropBehavior string] [-iksolver string] [-listPlugins] [-loadPluginPrefs] [-loaded] [-name string] [-path string] [-pluginsInUse] [-registered] [-remove] [-savePluginPrefs] [-serviceDescriptions] [-settings] [-tool string] [-translator string] [-unloadOk] [-userNamed] [-vendor string] [-version] [pluginName | plugin path]

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.

Flags

apiVersion, autoload, changedCommand, command, data, dependNode, dependNodeInfo, device, dragAndDropBehavior, iksolver, listPlugins, loadPluginPrefs, loaded, name, path, pluginsInUse, registered, remove, savePluginPrefs, serviceDescriptions, settings, tool, translator, unloadOk, userNamed, vendor, version
Long name (short name) [argument types] Properties
-name(-n) string query
returns a string containing the internal name by which the plugin is registered.

In query mode, this flag needs a value.
-path(-p) string query
returns a string containing the absolute path name to the plugin.

In query mode, this flag needs a value.
-vendor(-vd) string query
returns a string containing the vendor of the plugin.

In query mode, this flag needs a value.
-version(-v) query
returns a string containing the version the plugin.

In query mode, this flag needs a value.
-apiVersion(-av) query
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) query
returns a string array containing all the plugins that are currently loaded.

In query mode, this flag needs a value.
-pluginsInUse(-pu) query
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) query
returns a boolean specifying whether or not the plugin is loaded.

In query mode, this flag needs a value.
-unloadOk(-uo) query
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 createqueryedit
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) create
saves the plugin preferences (ie. autoload) out to pluginPrefs.mel
-loadPluginPrefs(-lpp) create
loads the plugin preferences (ie. autoload) from pluginPrefs.mel into Maya.
-command(-c) string query
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 query
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 query
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 query
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 query
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 query
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 query
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 query
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 query
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) query
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) query
returns a boolean specifying whether or not plugin is currently registered with the system.

In query mode, this flag needs a value.
-serviceDescriptions(-sd) query
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) edit
removes the given plugin's record from the registry. There is no return value.
-changedCommand(-cc) string edit
adds a callback that will get executed every time the plugin registry changes. Any other previously registered callbacks will also get called.
-settings(-set) query
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 be used more than once in a command

Return value


Dependent upon the action or query requested.

Related

loadPlugin, openMayaPref, unloadPlugin

MEL examples

// List the plugins that are currently loaded
pluginInfo -query -listPlugins;

// Find the vendor of a plugin
pluginInfo -query -vendor newNode;

// Find the commands provided by a given plug-in
pluginInfo -query -command helloCmd;

// Turn on autoloading for a plug-in
pluginInfo -edit -autoload true newNode;