Go to: Synopsis. Return value. Keywords. Related. Flags. Python examples.
attributeQuery([affectsAppearance=boolean], [affectsWorldspace=boolean], [attributeType=boolean], [cachedInternally=boolean], [categories=boolean], [channelBox=boolean], [connectable=boolean], [enum=boolean], [exists=boolean], [hidden=boolean], [indeterminant=boolean], [indexMatters=boolean], [internal=boolean], [internalGet=boolean], [internalSet=boolean], [keyable=boolean], [listChildren=boolean], [listDefault=boolean], [listEnum=boolean], [listParent=boolean], [listSiblings=boolean], [longName=boolean], [maxExists=boolean], [maximum=boolean], [message=boolean], [minExists=boolean], [minimum=boolean], [multi=boolean], [niceName=boolean], [node=name], [numberOfChildren=boolean], [range=boolean], [rangeExists=boolean], [readable=boolean], [renderSource=boolean], [shortName=boolean], [softMax=boolean], [softMaxExists=boolean], [softMin=boolean], [softMinExists=boolean], [softRange=boolean], [softRangeExists=boolean], [storable=boolean], [type=string], [typeExact=string], [usedAsColor=boolean], [usedAsFilename=boolean], [usesMultiBuilder=boolean], [worldspace=boolean], [writable=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
attributeQuery is NOT undoable, NOT queryable, and NOT editable.
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 "and"
of all the specified boolean flags. You may not specify any two flags when both do not
provide a boolean return type. (eg. "-internal -hidden" is okay but "-range -hidden" or
"-range -softRange" is not.)
| float[] | when querying ranges or default values |
| boolean | when querying attribute flags |
dg, dependency, graph, attribute, query
getClassification, isConnected, isDirty, nodeType, objExists, objectType
affectsAppearance, affectsWorldspace, attributeType, cachedInternally, categories, channelBox, connectable, enum, exists, hidden, indeterminant, indexMatters, internal, internalGet, internalSet, keyable, listChildren, listDefault, listEnum, listParent, listSiblings, longName, maxExists, maximum, message, minExists, minimum, multi, niceName, node, numberOfChildren, range, rangeExists, readable, renderSource, shortName, softMax, softMaxExists, softMin, softMinExists, softRange, softRangeExists, storable, type, typeExact, usedAsColor, usedAsFilename, usesMultiBuilder, worldspace, writable
| Long name (short name) |
Argument types |
Properties |
affectsAppearance(aa)
|
boolean
|
|
|
Return true if the attribute affects the appearance of the node
|
|
affectsWorldspace(aws)
|
boolean
|
|
|
Return the status of the attribute flag marking attributes affecting worldspace
|
|
attributeType(at)
|
boolean
|
|
|
Return the name of the attribute type (will be the same type names as described in the addAttr and addExtension commands).
|
|
cachedInternally(ci)
|
boolean
|
|
|
Return whether the attribute is cached within the node as well as in the datablock
|
|
categories(ct)
|
boolean
|
|
|
Return the categories to which the attribute belongs or an empty list if it does not belong to any.
|
|
channelBox(ch)
|
boolean
|
|
|
Return whether the attribute should show up in the channelBox or not
|
|
connectable(c)
|
boolean
|
|
|
Return the connectable status of the attribute
|
|
enum(e)
|
boolean
|
|
|
Return true if the attribute is a enum attribute
|
|
exists(ex)
|
boolean
|
|
|
Return true if the attribute exists
|
|
hidden(h)
|
boolean
|
|
|
Return the hidden status of the attribute
|
|
indeterminant(idt)
|
boolean
|
|
|
Return true if this attribute might be used in evaluation but it's not known for sure until evaluation time
|
|
indexMatters(im)
|
boolean
|
|
|
Return the indexMatters status of the attribute
|
|
internal(i)
|
boolean
|
|
|
Return true if the attribute is either internalSet or internalGet
|
|
internalGet(ig)
|
boolean
|
|
|
Return true if the attribute come from getCachedValue
|
|
internalSet(internalSet)
|
boolean
|
|
|
Return true if the attribute must be set through setCachedValue
|
|
keyable(k)
|
boolean
|
|
|
Return the keyable status of the attribute
|
|
listChildren(lc)
|
boolean
|
|
|
Return the list of children attributes of the given attribute.
|
|
listDefault(ld)
|
boolean
|
|
|
Return the default values of numeric and compound numeric attributes.
|
|
listEnum(le)
|
boolean
|
|
|
Return the list of enum strings for the given attribute.
|
|
listParent(lp)
|
boolean
|
|
|
Return the parent of the given attribute.
|
|
listSiblings(ls)
|
boolean
|
|
|
Return the list of sibling attributes of the given attribute.
|
|
longName(ln)
|
boolean
|
|
|
Return the long name of the attribute.
|
|
maxExists(mxe)
|
boolean
|
|
|
Return true if the attribute has a hard maximum. A min does not have to be present.
|
|
maximum(max)
|
boolean
|
|
|
Return the hard maximum of the attribute's value
|
|
message(msg)
|
boolean
|
|
|
Return true if the attribute is a message attribute
|
|
minExists(mne)
|
boolean
|
|
|
Return true if the attribute has a hard minimum. A max does not have to be present.
|
|
minimum(min)
|
boolean
|
|
|
Return the hard minimum of the attribute's value
|
|
multi(m)
|
boolean
|
|
|
Return true if the attribute is a multi-attribute
|
|
niceName(nn)
|
boolean
|
|
|
Return the nice name (or "UI name") of the attribute.
|
|
node(n)
|
name
|
|
|
Use all attributes from node named NAME
|
|
numberOfChildren(nc)
|
boolean
|
|
|
Return the number of children the attribute has
|
|
range(r)
|
boolean
|
|
|
Return the hard range of the attribute's value
|
|
rangeExists(re)
|
boolean
|
|
|
Return true if the attribute has a hard range. Both min and max must be present.
|
|
readable(rd)
|
boolean
|
|
|
Return the readable status of the attribute
|
|
renderSource(rs)
|
boolean
|
|
|
Return whether this attribute is marked as a render source or not
|
|
shortName(sn)
|
boolean
|
|
|
Return the short name of the attribute.
|
|
softMax(smx)
|
boolean
|
|
|
Return the soft max (slider range) of the attribute's value
|
|
softMaxExists(sxe)
|
boolean
|
|
|
Return true if the attribute has a soft maximum. A min does not have to be present.
|
|
softMin(smn)
|
boolean
|
|
|
Return the soft min (slider range) of the attribute's value
|
|
softMinExists(sme)
|
boolean
|
|
|
Return true if the attribute has a soft minimum. A max does not have to be present.
|
|
softRange(s)
|
boolean
|
|
|
Return the soft range (slider range) of the attribute's value
|
|
softRangeExists(se)
|
boolean
|
|
|
Return true if the attribute has a soft range. Both min and max must be present.
|
|
storable(st)
|
boolean
|
|
|
Return true if the attribute is storable
|
|
type(typ)
|
string
|
|
|
Use static attributes from nodes of type TYPE. Includes attributes inherited from parent class nodes.
|
|
typeExact(tex)
|
string
|
|
|
Use static attributes only from nodes of type TYPE. Does not included inherited attributes.
|
|
usedAsColor(uac)
|
boolean
|
|
|
Return true if the attribute should bring up a color picker
|
|
usedAsFilename(uaf)
|
boolean
|
|
|
Return true if the attribute should bring up a file browser
|
|
usesMultiBuilder(umb)
|
boolean
|
|
|
Return true if the attribute is a multi-attribute and it uses the multi-builder to handle its data
|
|
worldspace(ws)
|
boolean
|
|
|
Return the status of the attribute flag marking worldspace attribute
|
|
writable(w)
|
boolean
|
|
|
Return the writable status of the attribute
|
|
|
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.
|
import maya.cmds as cmds
# Determine the hidden status of the "selector" attribute on choice nodes.
#
cmds.attributeQuery( 'selector', typ='choice', h=True )
# Result: 0
# Determine the hidden status of the "selector" attribute on this choice node.
# (Usually the same but you can do this for dynamic attributes too.)
#
cmds.createNode( 'choice', n='whoIsIt' )
# Result: choice1
cmds.attributeQuery( 'selector', n='whoIsIt', h=True )
# Result: 0
# Determine the range of the selector value on choice nodes.
# In this case there is no range.
# Note, if there is only a minimum or only a maximum range will not set.
#
cmds.attributeQuery( 'selector', typ='choice', range=True )
# For the next several examples create a poly cube and add extra attributes.
cmds.polyCube( cuv=4, ch=1, w=1, h=1, d=1, sx=1, sy=1, sz=1, ax=(0, 1, 0) )
cmds.addAttr( '|pCube1', ln='egRange', at='long', min=0, max=5, dv=2 )
cmds.setAttr( '|pCube1.egRange', e=True, keyable=False )
# Determine if an attribute is keyable
#
cmds.attributeQuery( 'egRange', node='pCube1', k=True )
# Result: 0
# Determine the minimum and maximum values of the added attribute egRange
#
cmds.attributeQuery( 'egRange', node='pCube1', range=True )
# Result: [0.0, 5.0]
# Determine if there is a minimum for the attribute.
# Note, having a minimum or maximum value does not imply the attribute has a range.
cmds.addAttr( '|pCube1', ln='egMin', at='long', min=2 )
cmds.attributeQuery( 'egMin', node='pCube1', minExists=True )
# Result: 1
cmds.attributeQuery( 'egMin', node='pCube1', maxExists=True )
# Result: 0
cmds.attributeQuery( 'egMin', node='pCube1', min=True )
# Result: [2.0]
# Determine if an attribute is an enum
# List the enum strings. This will use ':' as a separator like the attr is written in
# an .ma file.
cmds.addAttr( '|pCube1', ln='myEnum', at='enum', en='chicken:turkey:duck:', ct='fowl' )
cmds.attributeQuery( 'myEnum', node='pCube1', listEnum=True )
# Result: [u'chicken:turkey:duck'] #
# Secondary way to find an attribute's type directly
cmds.attributeQuery( 'myEnum', node='pCube1', attributeType=True )
# Result: ['enum'] #
# See to which categories and attribute belongs
cmds.attributeQuery( 'myEnum', node='pCube1', categories=True )
# Result: ['fowl'] #