getAttr

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

Synopsis

getAttr [-asString] [-caching] [-channelBox] [-expandEnvironmentVariables] [-keyable] [-lock] [-multiIndices] [-settable] [-silent] [-size] [-time time] [-type] attribute

getAttr is NOT undoable, NOT queryable, and NOT editable.

For Ufe attributes, the input attribute string should be "<ufe_path_string>.<ufe_attribute_name>".

UI units are used where applicable.

Currently, the types of attributes that can be displayed are:

• numeric attributes
• string attributes
• matrix attributes
• numeric compound attributes (whose children are all numeric)
• vector array attributes
• double array attributes
• int32 array attributes
• point array attributes
• data component list attributes
• Ufe attributes

Other data types cannot be retrieved. No result is returned if the attribute contains no data.

Return value

Related

Flags

Long name (short name)	Argument types	Properties
-asString(-as)
This flag is only valid for enum attributes. It allows you to get the attribute values as strings instead of integer values. Note that the returned string value is dependent on the UI language Maya is running in (about -uiLanguage). Not supported for Ufe attributes.
-caching(-ca)
Returns whether the attribute is set to be cached internally Not supported for Ufe attributes.
-channelBox(-cb)
Returns whether the attribute is set to show in the Channel Box. Keyable attributes also show in the Channel Box. Not supported for Ufe attributes. The display of Ufe attributes in the Channel Box is controlled using the channelBox command flag -ual/ufeFixedAttrList.
-expandEnvironmentVariables(-x)
Expand any environment variable and (tilde characters on UNIX) found in string attributes which are returned. Not supported for Ufe attributes.
-keyable(-k)
Returns the keyable state of the attribute. Not supported for Ufe attributes.
-lock(-l)
Returns the lock state of the attribute.
-multiIndices(-mi)
If the attribute is a multi, this will return a list containing all of the valid indices for the attribute. Not supported for Ufe attributes.
-settable(-se)
Returns 1 if this attribute is currently settable by setAttr, 0 otherwise. An attribute is settable if it's not locked and either not connected, or has only keyframed animation. For Ufe attributes an attribute is settable if it's not locked.
-silent(-sl)
When evaluating an attribute that is not a numeric or string value, suppress the error message saying that the data cannot be displayed. The attribute will be evaluated even though its data cannot be displayed. This flag does not suppress all error messages, only those that are benign. Not supported for Ufe attributes.
-size(-s)
Returns the size of a multi-attribute array. Returns 1 if non-multi. Not supported for Ufe attributes.
-time(-t)	time
Evaluate the attribute at the given time instead of the current time. Not supported for Ufe attributes.
-type(-typ)
Returns the type of data currently in the attribute. Attributes of simple types such as strings and numerics always contain data, but attributes of complex types (arrays, meshes, etc) may contain no data if none has ever been assigned to them. When this happens the command will return with no result: not an empty string, but no result at all. Attempting to directly compare this non-result to another value or use it in an expression will result in an error, but you can assign it to a variable in which case the variable will be set to the default value for its type (e.g. an empty string for a string variable, zero for an integer variable, an empty array for an array variable). So to be safe when using this flag, always assign its result to a string variable, never try to use it directly.

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

createNode revolve -n gravityWell;
sphere -n loxTank;
cone -n noseCone;
cone -n fin;
pointConstraint -n weld fin noseCone;

float  $angle    = `getAttr gravityWell.esw`;
// Result: 360 //
string $type     = `getAttr -type loxTank.translate`;
// Result: double3 //
int    $lock     = `getAttr -lock noseCone.translateX`;
// Result: 0 //
float  $finZ     = `getAttr -time 12 fin.translateZ`;
// Result: 0 //
int    $size     = `getAttr -size weld.target`;
// Result: 1 //
int    $size     = `getAttr -settable weld.target`;
// Result: 0 //
float  $matrix[] = `getAttr loxTank.matrix`;
// Result: 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1 //
createNode file -n file1;
setAttr file1.ftn -type "string" "$TMPDIR/smile.gif";
string $s = `getAttr file1.ftn`;
// Result: $TMPDIR/smile.gif //
string $s = `getAttr -x file1.ftn`;
// Result: /var/tmp/smile.gif //

// Get the list of all used indices on a multi attribute
getAttr -multiIndices initialShadingGroup.dagSetMembers
// Result: 0 1 2 //