attrCompatibility

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

Synopsis

attrCompatibility [-addAttr] [-clear] [-dumpTable] [-enable boolean] [-nodeRename string] [-pluginNode string] [-removeAttr] [-renameAttr string] [-type string] [-version string] [string [string]]

attrCompatibility is undoable, NOT queryable, and NOT editable.

The first optional command argument argument is a node name and the second optional command argument is an attribute name.

Warning: Only use this command to describe changes in names or attributes of nodes that you have written as plugins. Do not use this command to change information about builtin dependency graph nodes. Removing attributes on a plug-in node is a special case. Use a separate attrCompatibility call with pluginNode flag and name so that these attributes can be tracked even though the plug-in may not be loaded.

Return value

None

Flags

Long name (short name)	Argument types	Properties
-addAttr(-a)
Add the given attribute to the named node.
-clear(-clr)
Clear out the compatibility table. This is only used internally for debugging purposes.
-dumpTable(-dmp)
Dump the current contents of the compatibility table. This is only used internally for debugging purposes.
-enable(-e)	boolean
Enable or disable the compatibility table. This is only used internally for debugging purposes.
-nodeRename(-nr)	string
Replace all uses of the node type 'nodeName' with given string.
-renameAttr(-r)	string
Rename the given attribute name of the given node with the given string.
-removeAttr(-rm)
Remove the given attribute from the named node.
-type(-typ)	string
Change the type of the given attribute to the given type.
-version(-v)	string
Set the version target for subsequent commands to the given string.
-pluginNode(-pn)	string
Registers the string argument as a plug-in node type. This is necessary for subsequent attrCompatibility calls that reference node attributes of unloaded plug-ins. Specifically, this works in the case when attributes are being removed.

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.

MEL examples

// Rename '.x' attributes in old files to '.tx' for all nodes
// of type 'transform'
//
attrCompatibility -r tx transform x;
// Rename the old 'group' node to the new 'transform' node
//
attrCompatibility -nr transform group;
// This will cause all subsequent attrCompatibility calls to translate
// files from older versions to version 1.0.
//
attrCompatibility -v "1.0";