pymel.core.general.attributeQuery

attributeQuery(*args, **kwargs)

attributeQuery returns information about the configuration of an attribute. It handles both boolean flags, returning true or false, as well as other return values. Specifying more than one boolean flag will return the logical andof all the specified boolean flags. You may not specify any two flags when both do not provide a boolean return type. (eg. -internal -hiddenis okay but -range -hiddenor -range -softRangeis not.)

Flags:
  • connectable : c (bool) [create]

    Return the connectable status of the attribute

  • enum : e (bool) [create]

    Return true if the attribute is a enum attribute

  • exists : ex (bool) [create]

    Return true if the attribute exists

  • hidden : h (bool) [create]

    Return the hidden status of the attribute

  • indexMatters : im (bool) [create]

    Return the indexMatters status of the attribute

  • internal : i (bool) [create]

    Return true if the attribute is either internalSet or internalGet

  • internalGet : ig (bool) [create]

    Return true if the attribute come from getCachedValue

  • internalSet : internalSet (bool) [create]

    Return true if the attribute must be set through setCachedValue

  • keyable : k (bool) [create]

    Return the keyable status of the attribute

  • listChildren : lc (bool) [create]

    Return the list of children attributes of the given attribute.

  • listDefault : ld (bool) [create]

    Return the default values of numeric and compound numeric attributes.

  • listEnum : le (bool) [create]

    Return the list of enum strings for the given attribute.

  • listParent : lp (bool) [create]

    Return the parent of the given attribute.

  • listSiblings : ls (bool) [create]

    Return the list of sibling attributes of the given attribute.

  • longName : ln (bool) [create]

    Return the long name of the attribute.

  • maxExists : mxe (bool) [create]

    Return true if the attribute has a hard maximum. A min does not have to be present.

  • maximum : max (bool) [create]

    Return the hard maximum of the attribute’s value

  • message : msg (bool) [create]

    Return true if the attribute is a message attribute

  • minExists : mne (bool) [create]

    Return true if the attribute has a hard minimum. A max does not have to be present.

  • minimum : min (bool) [create]

    Return the hard minimum of the attribute’s value

  • multi : m (bool) [create]

    Return true if the attribute is a multi-attribute

  • niceName : nn (bool) [create]

    Return the nice name (or UI name) of the attribute. Flag can have multiple arguments, passed either as a tuple or a list.

  • node : n (PyNode) [create]

    Use all attributes from node named NAME

  • numberOfChildren : nc (bool) [create]

    Return the number of children the attribute has

  • range : r (bool) [create]

    Return the hard range of the attribute’s value

  • rangeExists : re (bool) [create]

    Return true if the attribute has a hard range. Both min and max must be present.

  • readable : rd (bool) [create]

    Return the readable status of the attribute

  • shortName : sn (bool) [create]

    Return the short name of the attribute.

  • softMax : smx (bool) [create]

    Return the soft max (slider range) of the attribute’s value

  • softMaxExists : sxe (bool) [create]

    Return true if the attribute has a soft maximum. A min does not have to be present.

  • softMin : smn (bool) [create]

    Return the soft min (slider range) of the attribute’s value

  • softMinExists : sme (bool) [create]

    Return true if the attribute has a soft minimum. A max does not have to be present.

  • softRange : s (bool) [create]

    Return the soft range (slider range) of the attribute’s value

  • softRangeExists : se (bool) [create]

    Return true if the attribute has a soft range. Both min and max must be present.

  • storable : st (bool) [create]

    Return true if the attribute is storable

  • type : typ (unicode) [create]

    Use static attributes from nodes of type TYPE. Includes attributes inherited from parent class nodes.

  • typeExact : tex (unicode) [create]

    Use static attributes only from nodes of type TYPE. Does not included inherited attributes.

  • usedAsColor : uac (bool) [create]

    Return true if the attribute should bring up a color picker

  • writable : w (bool) [create]

    Return the writable status of the attribute

Derived from mel command maya.cmds.attributeQuery

Previous topic

pymel.core.general.attributeName

Next topic

pymel.core.general.bakePartialHistory

Core

Core Modules

Other Modules

This Page