pymel.core.general.getAttr

getAttr(attr, default=None, **kwargs)

This command returns the value of the named object’s attribute. UI units are used where applicable. Currently, the types of attributes that can be displayed are: numeric attributesstring attributesmatrix attributesnumeric compound attributes (whose children are all numeric)vector array attributesdouble array attributesint32 array attributespoint array attributesdata component list attributesOther data types cannot be retrieved. No result is returned if the attribute contains no data.

Maya Bug Fix:

• maya pointlessly returned vector results as a tuple wrapped in a list ( ex. ‘[(1,2,3)]’ ). This command unpacks the vector for you.

Modifications:

• casts double3 datatypes to Vector
• casts matrix datatypes to Matrix
• casts vectorArrays from a flat array of floats to an array of Vectors
• when getting a multi-attr, maya would raise an error, but pymel will return a list of values for the multi-attr
• added a default argument. if the attribute does not exist and this argument is not None, this default value will be returned

Flags:

• asString : asString (bool) [create]

  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).

• caching : ca (bool) [create]

  Returns whether the attribute is set to be cached internally

• channelBox : cb (bool) [create]

  Returns whether the attribute is set to show in the channelBox. Keyable attributes also show in the channel box.

• expandEnvironmentVariables : x (bool) [create]

  Expand any environment variable and (tilde characters on UNIX) found in string attributes which are returned.

• keyable : k (bool) [create]

  Returns the keyable state of the attribute.

• lock : l (bool) [create]

  Returns the lock state of the attribute.

• multiIndices : mi (bool) [create]

  If the attribute is a multi, this will return a list containing all of the valid indices for the attribute. Flag can have multiple arguments, passed either as a tuple or a list.

• settable : se (bool) [create]

  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.

• silent : sl (bool) [create]

  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.

• size : s (bool) [create]

  Returns the size of a multi-attribute array. Returns 1 if non-multi.

• time : t (time) [create]

  Evaluate the attribute at the given time instead of the current time.

• type : typ (bool) [create]

  Returns the type of data to expect at the attribute.

Derived from mel command maya.cmds.getAttr