The lscommand returns the names (and optionally the type names) of objects in the scene. The most common use of lsis to filter or match objects based on their name (using wildcards) or based on their type. By default lswill match any object in the scene but it can also be used to filter or list the selected objects when used in conjunction with the -selection flag. If type names are requested, using the -showType flag, they will be interleaved with object names so the result will be pairs of object, typevalues. Internal nodes (for example itemFilter nodes) are typically filtered so that only scene objects are returned. However, using a wildcard will cause all the nodes matching the wild card to show up, including internal nodes. For example, ls *will list all nodes whether internal or not. When Maya is in relativeNames mode, the lscommand will return names relativeto the current namespace and ls *will list from the the current namespace. For more details, please refer to the -relativeNamesflag of the namespacecommand.
Added new keyword: ‘editable’ - this will return the inverse set of the readOnly flag. i.e. non-read-only nodes
Added new keyword: ‘regex’ - pass a valid regular expression string, compiled regex pattern, or list thereof.
>>> group('top')
nt.Transform(u'group1')
>>> duplicate('group1')
[nt.Transform(u'group2')]
>>> group('group2')
nt.Transform(u'group3')
>>> ls(regex='group\d+\|top') # don't forget to escape pipes `|`
[nt.Transform(u'group1|top'), nt.Transform(u'group2|top')]
>>> ls(regex='group\d+\|top.*')
[nt.Transform(u'group1|top'), nt.Camera(u'group1|top|topShape'), nt.Transform(u'group2|top'), nt.Camera(u'group2|top|topShape')]
>>> ls(regex='group\d+\|top.*', cameras=1)
[nt.Camera(u'group2|top|topShape'), nt.Camera(u'group1|top|topShape')]
>>> ls(regex='\|group\d+\|top.*', cameras=1) # add a leading pipe to search for full path
[nt.Camera(u'group1|top|topShape')]
The regular expression will be used to search the full DAG path, starting from the right, in a similar fashion to how globs currently work. Technically speaking, your regular expression string is used like this:
re.search( '(\||^)' + yourRegexStr + '$', fullNodePath )
| rtype: | PyNode list |
|---|
List all paths to nodes in DAG. This flag only works if -dagis also specified or if an object name is supplied.
List top level transform Dag objects
List camera shapes.
List containers. Includes both standard containers as well as other types of containers such as dagContainers. Flag can have multiple arguments, passed either as a tuple or a list.
List Dag objects of any type. If object name arguments are passed to the command then this flag will list all Dag objects below the specified object(s).
List dependency nodes. (including Dag objects)
List all objects of the specified type, but notobjects that are descendents of that type. This flag can appear multiple times on the command line. Note: the type passed to this flag is the same type name returned from the -showType flag. This flag cannot be used in conjunction with the -type flag.
Flattens the returned list of objects so that each component is identified individually.
List geometric Dag objects.
List ghosting objects.
This flag specifies the maximum number of elements to be returned from the beginning of the list of items. Note: each type flag will return at most this many items so if multiple type flags are specified then the number of items returned can be greater than this amount.
List objects that are currently hilited for component selection.
List only intermediate dag nodes.
List only invisible dag nodes.
List all leaf nodes in Dag. This flag is a modifier and must be used in conjunction with the -dag flag.
List light shapes.
List objects that are currently live.
Returns locked nodes, which cannot be deleted or renamed. However, their status may change.
Return full path names for Dag objects. By default the shortest unique name is returned.
List materials or shading groups.
List only non intermediate dag nodes.
Lists all registered node types.
When this flag is set only object names will be returned and components/attributes will be ignored.
List partitions.
Returns persistent nodes, which are nodes that stay in the Maya session after a file new.
List construction plane shapes.
List components that are currently hilited for pre-selection.
Returns referenced nodes. Referenced nodes are read only. NOTE: Obsolete. Please use -referencedNodes.
When set to true, this command will look for name matches in all namespaces. When set to false, this command will only look for matches in namespaces that are requested (e.g. by specifying a name containing the ‘:’... ns1:pSphere1).
Returns referenced nodes. Referenced nodes are read only.
List references associated with files. Excludes special reference nodes such as the sharedReferenceNode and unknown reference nodes.
List render globals.
List named render qualities.
List render resolutions.
Alias for -renderGlobals.
List objects that are currently selected.
List sets.
List shape objects.
Return short attribute names. By default long attribute names are returned.
List the type of each object after its name.
This flag specifies the maximum number of elements to be returned from the end of the list of items. Note: each type flag will return at most this many items so if multiple type flags are specified then the number of items returned can be greater than this amount
List only templated dag nodes.
List textures.
List transform objects.
List all objects of the specified type. This flag can appear multiple times on the command line. Note: the type passed to this flag is the same type name returned from the -showType flag. Note: some selection items in Maya do not have a specific object/data type associated with them and will return untypedwhen listed with this flag. This flag cannot be used in conjunction with the -exactType flag.
Returns nodes that cannot be deleted (which includes locked nodes). These nodes also cannot be renamed.
List only un-templated dag nodes.
List only visible dag nodes.
Derived from mel command maya.cmds.ls