Swingtimer

# Swing timer cast weaving indicator

## Package features:

* Main hand/Off hand swing timer
* Main hand/Off hand Synch/Stagger indicator
* Lightning Bolt weaving indicator
* Chain Lightning weaving indicator
* Swing Timer clipping indicator
* Global cooldown indicator
* SwingTimerAPI and WeavingAPI

The Core Swing Timer trigger have been removed from Weakaura in WOTLK:

> Classic communities expect this information to be 100% correct for their gameplay, but game API does not give this information, it has to be calculated from various events.  
> There are swing timer addons actively developped, but we don't have developpers willing to maintain this trigger.  
> So, Swing Timer trigger will be remove for Wrath.  
> Source: Official Weakaura Discord

This package use the [SwingTimerAPI aura](https://wago.io/mfxY37Jl9) to give an overview of the Swing Timer state based on various events. Like explain there is no relevant WOW API to have a real state of the Swing Timer so take in mind it can some time not be 100% accurate like all Swing Timer addons implementation!

This package as a Tutorial mode that add some informations to better uderstand all the indicators. It can be toggle on/off by checking/unchecking the Tutorial checkbox in the SwingTimer group Customs option tab.


## Main hand and Off hand Swing with Synch/Stagger indicator

This Weakaura indicate the Main hand and Off hand swing state:

* Main hand (MH) it's represented by a bar and a white tick.
* Off hand (OH) it's represented by a white tick.
* Middle of the bar it's representig by the static white tick. If you OH is after this tick it can be reseted to middle swing time with the synch/stagger macro.


To properly Synched or Staggered your MH and OH the Main hand bar have two green overlays of 0.5 seconds before and after th MH tick that represent the window. You should place the OH swing in this window.

Stagger zones:   

MH and OH staggered with OH leading:  

MH and OH staggered with MH leading:  

You can toggle on/off the stagger zone indicators by checking/unchecking the checkbox in the SwingTimer group Customs option tab.


You can toggle on/off the OH Synch/Stagger tick color by checking/unchecking the checkbox in the SwingTimer group Customs option tab.

This option will color the OH tick base on Synch/Stagger status:

* RED when not Synched and not Staggered
* Yellow when Staggered
* Green when Synched


Not Synched and Not Staggered:  

Staggered OH leading:  

Staggered MH leading:  

Synched:  

### Why Synch/Stagger?

Enhancement Shaman can increase there Flurry uptime by consuming only one charge by MH and OH swing.
For that the two swings need to land into a window of 0.5 seconds of each other as a Flurry charge can only be consume once every 0.5 seconds.

This technique is known as Sync or Stagger:
* Sync meen that the MH swing land at the exact same time than the OH swing.
* Stagger meen that the MH swing and OH swing land in a window of 0.5 seconds from each other.

## Lightning Bolt and Chain Lightning weaving

The Maelstrom Weapon (MW) buff have a hidden flag that prevent the reset of the weapon swing that normally occur after a succesfull cast.  
Enhancement Shaman can use this hidden flag to cast LB or CL between MH and OH swing without reseting there swing's even if they don't have the full five stacks to make this spell instant cast. It's working with at least one stack of MW.

**This technique is known as LB weaving or CL weaving.**

This weakaura add two ticks to the main swing bar that represent the upper limit when LB or CL spell must begin to be casted to not clip the swing.

To properly weave you need to start casting LB or CL when the MH and OH tick are placed before the LB tick (for LB cast) or CL tick (for CL cast).

LB/CL cast range zone:  

In this picture MH/OH are at the correct position to safely cast LB or CL:   

## Casting indicator

When you start casting LB or CL the corresponding tick will start to move to the end of the bar.
The tick will be flashing in red if at least one of your weapon swing will be clipped. In this case you need to stop your cast to prevent that.

Succesful weaving:  
  

Cast will clip a swing:  

If it's to fast for you to see this red casting indicator no worries. If by mistake you miss your weaving and clip the swing's, the swing bar will flash in red to late you know that you need to practice more!  


## SwingTimerAPI and WeavingAPI

This package includes two Auras that fire custom events use to manage the swing progress bar and tick state. This events can be use in any other aura to add more interaction or build you hown implementation of the swing and weaving.


### SwingTimerAPI

[SwingTimerAPI documentation](https://wago.io/mfxY37Jl9)

### WeavingAPI

**WEAVING_UPDATE_STATUS**

Fired when ganing new Maelstrom stack or starting to cast LB/CL.

| Property | Description |  
| ----------- | ----------- |
| speed | number - the weapon swing. Take the faster weapon between mainhand and offhand |
| castTime | number - cast time of the spell |
| expirationTime | number - calculated end of the cast relative to GetTime() |
| spellId | number - the id of the spell |
| spellName | string - the name of the spell |
| isCasting | boolean - True if your are starting to cast LB or CL. False otherwise |

**SWING_TIMER_WILL_CLIPPED**

Fired at a start of a spell cast if a weapon swing will be clipped.

| Property | Description |  
| ----------- | ----------- |
| hand | string - the hand that will be clipped ("mainhand" or "offhand") |
| castTime | number - cast time of the spell |
| spellId | number - the id of the spell |