# ToolTip UDF - Script Breaking Changes

The ToolTip UDF was completely rewritten to remove magic numbers, make it easier to implement ToolTips in scripts, standardize the parameters and documentation, and correct bugs.
This means that scripts written for AutoIt up to version 3.3.8.1 won't run with later versions and need to be modified.
The following table lists the differences between the old and the new version.
Changed and removed functions/parameters

Old UDF Function/Parameter | Comments
--- | ---
_GUIToolTip_Activate | $fActivate parameter removed, only used to activate a tooltip as it no longer is used to deactivate one
_GUIToolTip_AddTool | The $iFlags parameters have been changed to use the ToolTip constants instead of magic numbers, also the default setting has changed to BitOr($TTF_SUBCLASS, $TTF_IDISHWND)
_GUIToolTip_BitsToTTF | Functionality of this has been totally altered, because there are no longer any magic numbers for the tool flags, this function now translates the value of the flags to a comma delimited text string containing the constants used in the flags parameter.
_GUIToolTip_Create | New default constant for tooltip control creation
$_TT_ghTTDefaultStyle | Its value is equal to BitOr($TTS_ALWAYSTIP, $TTS_NOPREFIX)
_GUIToolTip_Destroy | Documented @error return values
_GUIToolTip_EnumTools | The return values have changed to reflect the changes in _GUIToolTip_Add and _GUIToolTip_BitsToTTF, the returned array's [0] element is now a text string containing the return from the _GUIToolTip_BitsToTTF function instead of the magic numbers used previously.
_GUIToolTip_GetBubbleHeight | Default value for the $iFlags parameter changed to BitOR($TTF_IDISHWND, $TTF_SUBCLASS)
_GUIToolTip_GetBubbleSize | Default value for the $iFlags parameter changed to BitOR($TTF_IDISHWND, $TTF_SUBCLASS)
_GUIToolTip_GetBubbleWidth | Default value for the $iFlags parameter changed to BitOR($TTF_IDISHWND, $TTF_SUBCLASS)
_GUIToolTip_GetCurrentTools | The return values have changed to reflect the changes in _GUIToolTip_Add and _GUIToolTip_BitsToTTF, the returned array's [0] element is now a text string containing the return from the _GUIToolTip_BitsToTTF function instead of the magic numbers used previously.
_GUIToolTip_GetDelayTime | The function now correctly uses the ToolTip constants to retrieve the tooltip delay times. The previous values used were 0 - 2, the correct values for the duration constants are 1 - 3
_GUIToolTip_GetTitleBitMap | Corrected a long standing bug in the function that prevented it from returning the correct information.
_GUIToolTip_GetTitleText | Corrected a long standing bug in the function that prevented it from returning the correct information.
_GUIToolTip_GetToolInfo | The return values have changed to reflect the changes in _GUIToolTip_Add and _GUIToolTip_BitsToTTF, the returned array's [0] element is now a text string containing the return from the _GUIToolTip_BitsToTTF function instead of the magic numbers used previously.
_GUIToolTip_HitTest | The return values have changed to reflect the changes in _GUIToolTip_Add and _GUIToolTip_BitsToTTF, the returned array's [0] element is now a text string containing the return from the _GUIToolTip_BitsToTTF function instead of the magic numbers used previously.
_GUIToolTip_SetToolInfo | The $iFlags parameters have been changed to use the ToolTip constants instead of magic numbers, also the default setting has changed to BitOr($TTF_SUBCLASS, $TTF_IDISHWND)
_GUIToolTip_ToolToArray | The [0] element of the returned array now correctly returns the flag value based on the tooltip constants instead of the magic numbers used previously
_GUIToolTip_TTFToBits | Removed

New functions/parameters

New UDF Function/Parameter | Comments
--- | ---
_GUIToolTip_Deactivate | This function is used to deactivate a tooltip, replaces the dual functionality of the _GUIToolTip_Activate function.