TellMeWhen_Script_Tools

his addon provides a list of utilities to help write icons driven by LUA scripts (Mostly through the Notifications>LUA interface, though the global methods will work just as well through the LUA Snippets interface)

Examples

Provided are some usage examples. Some examples contain explanations, so make sure to only copy the export code. 

• Dynamic Absorb Bar
• VDH Soul Fragments Tracker
• Normalized Stagger bar (uses NormalizedStagger addon)
• AHR Trinket tracker (tracks how much or the absorb is left, and how much damage was accumulated) 
• Black Ox Statue Tracker
• Last Defender buff tracker
• Infested Tracker – a port of a very useful WA. This will only trigger when running keystones of level 10 or higher, and will add a floating icon on top of infested mobs
• CC Trackers – this group will track all forms of CC (when they cast and when they will cancel). Uses the new Timers API

Utilities

Enemy Count Utilities

This module provides 3 main tools to count nearby enemies (for eg – to have a rotation based on number of nearby targets). All tools max out at 5 nearby enemies. 

Script Tools > Enemy Count condition

A new condition type was added to allow you to set conditions based on enemy count

LUA Methods

TMW_ST:EnableUnitCounter / TMW:DisableUnitCounter

This will enable/disable a new counter – "tmwst_hostiles_in_range".

TMW_ST:CountInRange(stop=5)

This function will return the number of nearby enemies. Will stop counting once/if stop has been achieved. 

Azerite Trait Condition

You can now check how many traits are active for a given spell id.

Counter Management

The library provides tools to get set counters for TellMeWhen:

TMW_ST:GetCounter(name)

This method will return the value of an existing counter

TMW_ST:InitCounter(name)

This method will initialize a counter for future use. Please note that you must call this on the Icon Setup notification event for any counter that is defined in your LUA scripts. Failing to do that will prevent TMW icons from accessing your counter

TMW_ST:UpdateCounter(name, value)

This method will update a counter value. Note that value must be a number.

Dynamic Text Setup

This toolset will allow you to set dynamic text that can be accessed in your icon labels (so that you can change icon text through LUA)

TMW_ST:SetScriptText(name, text)

This method will set a variable that you can access in icon labels using the following DogTag. 

[ST_GetScriptText(name)]

This DogTag will be accessible through your icon labels

Dynamic Bar

This tool is a new icon type- "Dynamic Bar" that allows you to manually set various properties of a bar icon. All the icon methods are only accessible through the Notifications > LUA interface.

There are 2 ways to control the bar growth – one is by setting a duration (startDurationTracking) or by manually setting max and current values.

icon:registerTriggerFunction(fnc)

This function can be used on Icon Setup event to register a function that will be called every time the icon goes through an update check. This function must return true for the icon to go through an update cycle. 

icon:setMaxValue(value) 

Set the max value for the bar

icon:setCurrentValue(value)

Set the current value of the bar.

icon:setBarColors(startColor, midColor, lastColor)

This allows you to manually set the color of your bar. A color is an 8-digit hex value representing an rgba color value (eg – "#aa12eeff"). Easiest way to access these colors is using TellMeWhen's color picker. You can pass nil if you want to only pass one or two of the parameters.

icon:startDurationTracking(duration)

Starts a duration countdown with {duration} length. If you use this without setting max/current values, it will control the bar display. Otherwise, it will create a value you can track using the various duration DogTags.

icon:setStacks(stacks[, stackText])

Will set the stacks attribute of the icon, so you can access in via DogTags. If you pass {stackText} it will control the value being displayed by the DogTag. 

Timers

You can now manipulate TMW timers using LUA:

TMW_ST.Timers.Init(name)

TMW_ST.Timers.Start(name)

TMW_ST.Timers.Stop(name)

TMW_ST.Timers.Reset(name)

TMW_ST.Timers.Restart(name)

TMW_ST.Timers.GetTime(name)