pymel.core.general.commandEcho

commandEcho(*args, **kwargs)

This command controls what is echoed to the command window. In query mode, return type is based on queried flag.

Flags:
Long name (short name) Argument Types Properties
filter (f) <type ‘unicode’>, ... ../../../_images/create.gif ../../../_images/query.gif
 

This flag allows to filter out unwanted commands when echo all commands is enabled. You can provide a partial command name, so all commands that start with a substring specified in filter entry will be filtered out. If filter is empty, all commands are echoed to the command window.

lineNumbers (ln) bool ../../../_images/create.gif ../../../_images/query.gif
 

If true then file name and line number information is provided in error and warning messages. If false then no file name and line number information is provided in error and warning messages.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

state (st) bool ../../../_images/create.gif ../../../_images/query.gif
 
If true then all commands are echoed to the command window. If false then only relevant commands are echoed.

Derived from mel command maya.cmds.commandEcho

Example:

import pymel.core as pm

# Echo everything
pm.commandEcho( state=True )
# Go back to normal
pm.commandEcho( state=False )
# Display line number information in messages.  This is the default.
pm.commandEcho( lineNumbers=True )
# Do not display line number information in messages.
pm.commandEcho( lineNumbers=False )
# Do not display changeToolIcon, escapeCurrentTool or autoUpdateAttrEd commands when echoing everything
pm.commandEcho( filter=('changeToolIcon', 'escapeCurrentTool', 'autoUpdateAttrEd') );
# Do not display setLastFocusedCommandReporter or setLastFocusedCommandExecuter when echoing everything
pm.commandEcho( filter=('setLastFocusedCommand') );

Previous topic

pymel.core.general.colorIndex

Next topic

pymel.core.general.commandPort

Core

Core Modules

Other Modules

This Page