whatsNewHighlight

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

whatsNewHighlight([highlightColor=[float, float, float]], [highlightOn=boolean], [showStartupDialog=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

whatsNewHighlight is undoable, queryable, and NOT editable.

Return value

None

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
highlightColor(hc)	[float, float, float]
Set the color of the What's New highlight. The arguments correspond to the red, green, and blue color components. Each color component ranges in value from 0.0 to 1.0.
highlightOn(ho)	boolean
Toggle the What's New highlighting feature. When turned on, menu items and buttons introduced in the latest version will be highlighted.
showStartupDialog(ssd)	boolean
Set whether the settings dialog for this feature appears on startup.

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.

Python examples

import maya.cmds as cmds

#    Turn on What's New highlighting if not already on.
#
if not cmds.whatsNewHighlight(query=True, highlightOn=True):
    cmds.whatsNewHighlight(highlightOn=True)

#    Turn off What's New highlighting startup dialog if it is set to appear.
#
if cmds.whatsNewHighlight(query=True, showStartupDialog=True):
    cmds.whatsNewHighlight(showStartupDialog=False)