TellMeWhen is an addon that can display of abilities and show/hide them based on many different conditions and parameters.
Icon Settings
Universal Icon Settings
The following settings/features apply to all icons:
- Chose spell/item/buff/etc. - Opens a dialog where you can input the name of the spell/item/buff/debuff/totem you wish to track. Doesn't apply to Temporary Weapon Enchant icons, these simply check your mainhand/offhand/thrown weapon.
- Enable Icon - Toggles whether the icon is enabled or not. Disabled icons will not use any CPU, will never be shown, and cannot be checked by the conditions of other icons (more on this later).
- Icon Type - Chooses the type of icon to display; there are currently 5 different icon types:
- Cooldown - Shows/hides the icon based on the cooldown state of the ability.
- Buff/Debuff - Shows/hides the icon based on the presence/absence of a buff or debuff on a unit.
- Reactive - Shows/hides the icon based on the reactive state of an ability such as Kill Shot or Revenge.
- Temporary Weapon Enchant - Shows/hides the icon based on the presence/absence of a temporary enchant such as Flametounge Weapon or Deadly Poison.
- Totem/non MoG ghoul - Shows/hides the icon based on the presence/absence of a totem or ghoul without the Master of Ghouls talent (Death Knights).
- Set Alpha Level - Sets the alpha level (opacity/transparency/etc) of the icon.
- Unusable/Absent Alpha Level - Change the alpha of the icon when the ability of the icon is unusable or absent and the icon is set to show when it is unusable/absent or always show.
- Usable/Present Alpha Level - Change the alpha of the icon when the ability of the icon is usable or present and the icon is set to show when it is usable/present or always show.
- Fake Hidden - Checking this box will cause the icon to be hidden at all times, but while still treated as if it were not checked for purposes of having other icons check to see if this icon is shown. Do not use this if you wish to disable the icon, only use it if you wish to not display this icon while still have another icon's conditions check if it is shown. (more on this later)
- Add/Edit Condition - See LINKHERE
- Show Timer - Show a cooldown animation on the icon (the clock animation) to show the icons cooldown/duration
- Show Timer Number - Show a number on the icon showing the time remaining on the cooldown/duration. REQUIRES OmniCC and that Show Timer be checked.
- Copy from Another Icon - Opens a GUI that can be used to copy the settings to be used for the current icon from another icon. Use the sliders on the window to choose which icon to copy the settings from. If a group is disabled or not enabled for the current spec, you must press the button to temporarily enable it. It will be set back to its original settings when the dialog is canceled/closed. Once you are content with the icon you are copying from, press the 'Copy' button to copy the settings.
- Clear Settings - Revert the icon back to a default, brand new, unconfigured icon.
Cooldown Settings
The following settings, in addition to the universal icon settings, apply to cooldown icons:
- Cooldown Type - The type of cooldown to check
- Spell or Ability - An ability such as Explosive Shot or Mind Freeze
- Item - An item such as a trinket or gloves with hand rockets, or a hearthstone
- Show Icon When - Set when the icon should be shown.
- Usable - Show the icon when the spell/item is usable
- Unusable - Show the icon when the spell/item is unusable
- Always - Show the icon all the time, with a color distinction between usable and unusable.
- Range Check? - Check to make usability also consider being in range/out of range to use the spell/item
- Power Check? - Check to make usability also based on available resources (but not runes). Does not effect item cooldowns.
- Unit Reaction - Check the hostility/friendliness of the target.
- All Units - Don't check hostility/friendliness.
- Friendly Units - Only show when the target is friendly, or if there is no target.
- Hostile Units - Only show when the target is hostile (including neutral attackable).
- Bars - Settings for overlay bars. Overlay bars provide a visual representation of the cooldown and the level of resource required for the ability. Most useful for classes that must heavily manage their resources (hunters, rogues, and warriors to some extent).
- Show Power Bar - Show a bar on the top half of the icon that represents resource required to use the ability (but not runes). The bar will fill down to empty as enough resource is obtained to use the ability.
- Show cooldown/timer bar - Show a bar on the bottom half of the icon that represents the cooldown remaining. Fills down as the ability comes off cooldown.
- Fill Bars Up - Causes bars to fill up instead of down, making them span the width of the icon when the ability can/should be used.
Buff/Debuff Settings
The following settings, in addition to the universal icon settings, apply to cooldown icons:
- Stacks - Opens a dialog to configure the number of stacks of the buff/debuff required to show the icon.
- Minimum stacks to show - Set the minimum number of stacks required to show the icon.
- Maximum stacks to show - Set the maximum number of stacks that the icon will show for.
- Only Show if Cast by Self - Only show the icon if the buff/debuff was casted by you and not another player.
- Buff or Debuff? - Set whether the icon should check for a buff or for a debuff.
- Buff - Check for a buff.
- Debuff - Check for a debuff.
- Unit to watch - Select the unit to check for the specified buff/debuff
- Player - Watch for the buff/debuff on you.
- Target - Watch for the buff/debuff on your target.
- Target's Target - Watch for the buff/debuff on your target's target.
- Focus - Watch for the buff/debuff on your focus (set by /focus).
- Focus' Target - Watch for the buff/debuff on your focus's target.
- Pet - Watch for the buff/debuff on your pet.
- Pet's Target - Watch for the buff/debuff on your pet's target.
- Mouseover - Watch for the buff/debuff on the unit that you are mousing over either in the game world or on unit frames.
- Mouseover's Target - Watch for the buff/debuff on your mouseover's target.
- Vehicle - Watch for the buff/debuff on the vehicle that you are in.
- Show When Buff/Debuff - Set when the icon should be shown.
- Present - Show the icon when the buff/debuff is present.
- Absent - Show the icon when the buff/debuff is absent.
- Always - Show the icon all the time, with a color distinction between present and absent that is configurable in the interface options menu.
- Unit Reaction - Check the hostility/friendliness of the target.
- All Units - Don't check hostility/friendliness.
- Friendly Units - Only show when the target is friendly, or if there is no target.
- Hostile Units - Only show when the target is hostile (including neutral attackable).
- Bars - Settings for overlay bars. Overlay bars provide a visual representation of the cooldown/duration and the level of resource required for the ability. Most useful for classes that must heavily manage their resources (hunters, rogues, and warriors to some extent).
- Show Power Bar - Show a bar on the top half of the icon that represents resource required to use the ability (but not runes). The bar will fill down to empty as enough resource is obtained to use the ability.
- Show cooldown/timer bar - Show a bar on the bottom half of the icon that represents the duration of the buff/debuff. Fills down as the buff/debuff is expiring.
- Fill Bars Up - Causes bars to fill up instead of down, making them span the width of the icon when the ability can/should be used.
Reactive Settings
The following settings, in addition to the universal icon settings, apply to reactive icons:
- Show Icon When - Set when the icon should be shown.
- Usable - Show the icon when the spell is usable.
- Unusable - Show the icon when the spell is unusable.
- Always - Show the icon all the time, with a color distinction between usable and unusable.
- Cooldown Check? - Check to make usability also consider the cooldown of the spell.
- Range Check? - Check to make usability also consider being in range/out of range to use the spell.
- Power Check? - Check to make usability also consider available resources (but not runes).
- Unit Reaction - Check the hostility/friendliness of the target.
- All Units - Don't check hostility/friendliness.
- Friendly Units - Only show when the target is friendly, or if there is no target.
- Hostile Units - Only show when the target is hostile (including neutral attackable).
- Bars - Settings for overlay bars. Overlay bars provide a visual representation of the cooldown and the level of resource required for the ability. Most useful for classes that must heavily manage their resources (hunters, rogues, and warriors to some extent).
- Show Power Bar - Show a bar on the top half of the icon that represents resource required to use the ability (but not runes). The bar will fill down to empty as enough resource is obtained to use the ability.
- Show cooldown/timer bar - Show a bar on the bottom half of the icon that represents the cooldown remaining. Fills down as the ability comes off cooldown.
- Fill Bars Up - Causes bars to fill up instead of down, making them span the width of the icon when the ability can/should be used.
Temporary Weapon Enchant Settings
The following settings, in addition to the universal icon settings, apply to temporary weapon enchant icons:
- Weapon Slot to Monitor - Selects the slot to monitor for a temporary weapon enchant.
- Main Hand - Set the icon to monitor your main hand weapon.
- Off Hand - Set the icon to monitor your off hand weapon.
- Thrown Weapon - Set the icon to monitor your thrown weapon.
- Show Icon When - Set when the icon should be shown.
- Present - Show the icon when a temporary enchant is present.
- Absent - Show the icon when a temporary enchant is absent.
- Always - Show the icon all the time, with a color distinction between present and absent that is configurable in the interface options menu.
Totem/Non-MoG Ghoul Settings
The following settings, in addition to the universal icon settings, apply to Totem/non-MoG Ghoul icons:
- Show Icon When - Set when the icon should be shown.
- Present - Show the icon when a totem/non-MoG ghoul is present.
- Absent - Show the icon when a totem/non-MoG ghoul is absent.
- Always - Show the icon all the time, with a color distinction between present and absent that is configurable in the interface options menu.
Conditions
The Condition Editor
The TellMeWhen condition editor allows you to specify many conditions that must be true in order for the icon to show. It includes the following items/settings:
- Check Box - The first thing that you see when you open the condition editor is a check box in the upper left hand corner. Check this box to enable the first condition. Upon checking a box, another condition and another box will appear. Only check boxes for conditions that you need to use.
- Type - The first setting of every condition is the condition type. This specifies what the condition should be checking in order to determine if the icon should be shown or not. Types currently include:
- Health - Checks the health as a percentage of the specified unit.
- Primary Resource - Checks the primary resource as a percentage of the specified unit. Checks mana for druids in caster/tree/moonkin form, energy for druids in cat form, runic power for death knights, focus for hunters and hunter pets, etc.
- Mana - Checks the mana as a percentage of the specified unit.
- Energy - Checks the energy as a percentage of the specified unit.
- Rage - Checks the rage as a percentage of the specified unit.
- Focus - Checks the focus as a percentage of the specified unit.
- Runic Power - Checks the runic power as a percentage of the specified unit.
- Unit Exists - Checks if the specified unit exists. A hunter would not want to check the happiness of their pet if their pet was not out.
- Icon Shown - Checks if the specified icon is shown. The icon that is being checked must be enabled and have an alpha above 0 to be considered shown. If you do not want the icon that is being checked to be shown, check the 'Fake Hidden' option in the alpha settings of the icon that is being checked. This can be used to, for example, show a cooldown for earth shock that checks to see if an icon that checks the stacks of lightning shield is shown. Or for a mind blast icon that checks another icon that checks the number of shadow orbs (this was the ticket that got me to make this feature)
- Soul Shards (Warlock Only) - Checks the number of soul shards that the player has.
- Holy Power (Paladin Only) - Checks the amount of holy power that the player has.
- Combo Points (Druid and Rogue only) - Checks the number of combo points that the player has on the unit.
- Eclipse (Druid Only) - Checks amount of eclipse power that the player has. range is -100 to 100, -100 is a lunar eclipse, 100 is a solar eclipse.
- Eclipse Direction (Druid Only) - Checks the direction that the eclipse bar is going in. 0 is invalid and will always return false.
- Happiness (Hunter only) - Checks the happiness of the player's pet.
- Icon - Specify the icon to check for Icon Shown conditions
- Unit - Specify the unit to check. Some types cannot change this, text will be shown for those showing the only unit that they can check.
- Player - Check the condition on you.
- Target - Check the condition on your target.
- Target's Target - Check the condition on your target's target.
- Focus - Check the condition on your focus (set by /focus).
- Focus' Target - Check the condition on your focus's target.
- Pet - Check the condition on your pet.
- Pet's Target - Check the condition on your pet's target.
- Mouseover - Check the condition on the unit that you are mousing over either in the game world or on unit frames.
- Mouseover's Target - Check the condition on your mouseover's target.
- Vehicle - Check the condition on the vehicle that you are in.
- Operator - Specify how to compare the amount of the type on the specified unit with the value to check against. Self explanatory. May not be shown based on the type selected.
- Value Slider - Set the value that the amount of the type on the specified unit is being checked against. The range of this slider will change based on the type selected, or may not be shown at all if not needed for the type.
- And / Or - Specify whether the two conditions adjacent to the and/or dropdown should both be true or either be true. Conditions are checked from top to bottom.
For example, the following would return true:
- Condition 1 (true)
- Condition 2 (false)
- Condition 3 (true)
But this would return false:
- Condition 1 (true)
- Condition 3 (true)
- Condition 2 (false)
Think of it this way:
((((Condition1 or Condition2) and Condition3) and Condition4) or Condition5)
This would return true whenever Condition5 is true, regardless of any others.
Interface Options Panel
These are the settings for TellMeWhen that can be configured in Blizzard's interface options panel.
Main Options
- Lock/Unlock Addon - Toggles whether the groups are locked and ready for use or are unlocked and ready for configuration.
- Bar Texture - Select a LibSharedMedia bar texture to be used for the overlay bars on icons.
- Update Interval - Change how often icons are updated, in seconds. Does not affect overlay bars and some other features, but can greatly increase or reduce CPU usage based on the setting.
- Number of Conditions - Change the number of conditions available in the condition editor. Reducing this number below the highest number of
conditions that any icon has can cause problems.
- Bars Ignore GCD - If checked, cooldown bars will not change values if the cooldown triggered is a global cooldown.
- Timers Ignore GCD - If checked, timers and the cooldown clock will not trigger from a global cooldown.
- Hightlight Timer Edge - Highlights the edge of the cooldown timer (clock animation) to increase visibility.
- Reset All - Resets the data and position of all icons and groups, reverting everything back to the default settings.
Colors
- CD/Duration Begin - Color of the cooldown/duration overlay bar when the cooldown/duration has just begun.
- Cd/Duration Complete - Color of the cooldown/duration overlay bar when the cooldown/duration is complete.
- Out of range color - Tint and alpha of icons when you are not in range of the target/specified unit to cast the spell/use the item.
- Out of power color - Tint and alpha of icons when you lack the Mana / Rage / Energy / Focus / Runic Power to cast the spell
- Present Color - The tint of an icon when the buff/debuff/enchant/totem is present and the icon is set to always show.
- Absent Color - The tint of an icon when the buff/debuff/enchant/totem is absent and the icon is set to always show.
Groups
Group Settings
- Enable Group - Toggles the group on/off. Groups toggled off will never be shown for any reason and will not consume any CPU.
- Only show in combat - Sets whether the group should only be shown in combat or should be shown all the time.
- Primary Spec - Sets whether the group should be shown while your primary spec is active or not.
- Secondary Spec - Sets whether the group should be shown while your secondary spec is active or not.
- Columns - Sets the number of columns that the group should display. This currently shifts icons around about, so use the Copy Settings feature to quickly migrate icon settings to the correct icons.
- Rows - Sets the number of rows that the group should display.
- Stances - Sets the stances/shapeshifts/etc that the group should show in. Checking 'None of the below' or 'Caster form' will make the group show while no stance/shapeshift/etc is active. A druid may wish to show a small group with some essential feral abilities when they are resto specced, but only when they are in the proper stance, for example. A feral druid probably does not care about his/her bear cooldowns while in cat form.
- Reset Position - Resets the group to the center of the screen in case it has been moved off the screen. Does not reset any data.