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

Synopsis

aliasAttr([remove=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

aliasAttr is undoable, queryable, and editable.

Allows aliases (alternate names) to be defined for any attribute of a specified node. When an attribute is aliased, the alias will be used by the system to display information about the attribute. The user may, however, freely use either the alias or the original name of the attribute. Only a single alias can be specified for an attribute so setting an alias on an already-aliased attribute destroys the old alias.

Return value

string[] in query mode.

In query mode, return type is based on queried flag.

Keywords

dg, dependency, graph, alias, attribute, name

Related

addAttr, attributeInfo, connectAttr, deleteAttr, disconnectAttr, getAttr, getClassification, nodeType, objExists, objectType, renameAttr, setAttr

Flags

remove
Long name (short name) Argument types Properties
remove(rm) boolean create
Specifies that aliases listed should be removed (otherwise new aliases are added).
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

cmds.createNode( 'blendShape', n='blender' )
#
# Define intuitive names for the weights of a blendShape.
# The blendShape command does this automatically to allow you
# to refer to the weight corresponding to a target shape by the name
# of that shape.
#
cmds.aliasAttr( 'smile', 'blender.w[0]', 'frown', 'blender.w[1]' )
# Result: 2 #
#
# List all the attribute aliases for the node blendShape1
#
cmds.aliasAttr( 'blender', query=True )
# Result: smile weight[0] frown weight[1] #
#
# Allow the X rotation on a joint to be called its "roll"
#
cmds.createNode( 'joint', n='elbow' )
cmds.aliasAttr( 'roll', 'elbow.rx' )
# Result: 1 #
cmds.aliasAttr( 'tuck', 'elbow.ry' )
# Result: 1 #
#
# Remove the roll alias defined above.
#
cmds.aliasAttr( 'elbow.roll', rm=True )
#
# Remove the tuck alias defined above.
#
cmds.aliasAttr( 'elbow.ry', rm=True )