WCL speedrun API

Features

1. Synchronize with WCL rules, load the corresponding speedrun rules in each raid zone and provide speedrun events

2. Support continue timing when leave raid zone,log out and raid reset

3. Support map changed

4. Support CN and EN

Install

1. Depend on WeakAuras-ItemUseStores addon (author HopeAsd) to save data offline, place the addon under the path 'World of Warcraft\_classic_\Interface\Addons

Addon maintenance address https://www.curseforge.com/wow/addons/weakauras-itemusestores

2. Restart the game to ensure addon loading

No dependencies are required on 5.0 WeakAuras

API events

SPEEDRUN_STARTIME_UPDATE

Fired if speedrun start

Index

Property

Description

1

ZoneID

Current map instances ID (See https://wowpedia.fandom.com/wiki/InstanceID)

2

StartTime

Speedrun start time

3

DifficultyID

Current diffculty (See https://wowpedia.fandom.com/wiki/DifficultyID)

SPEEDRUN_STOP

Fired if speedrun is finished

Index

Property

Description

1

ZoneID

Current map instances ID (See https://wowpedia.fandom.com/wiki/InstanceID)

2

duration

Speedrun total time (Without trash add time)

3

DifficultyID

Current diffculty (See https://wowpedia.fandom.com/wiki/DifficultyID)

SPEEDRUN_RESET

Fired by user to clear data

Index

Property

Description

1

arg1

Non-empty placeholder

SPEEDRUN_FORCE_START

Fired by user to force start speedrun

Index

Property

Description

1

arg1

Non-empty placeholder

SPEEDRUN_ENCOUNTER_UPDATE

Fired if kill a valid encounter successfully

Index

Property

Description

1

count

The killed number of encounters

2

countMax

The total number of encounters

SPEEDRUN_TRASH_TOTAL_UPDATE

Fired if kill a valid trash

Index

Property

Description

1

name

"Total"

2

count

The killed number of all trashs

3

countMax

The total number of all trashs

4

addTime

The add time of trashs

5

percent

The total percent of all trashs

SPEEDRUN_MAP_CHANGED

Fired if player enter a valid map

Index

Property

Description

1

mapID

Current zone map ID (See https://wowpedia.fandom.com/wiki/UiMapID)

SPEEDRUN_TRASH_MAP_UPDATE

Fired if player enter a valid map

Index

Property

Description

1

name

The name of the trash

2

count

The killed number of the trash

3

countMax

The total number of the trash

4

mapID

Current zone map ID (See https://wowpedia.fandom.com/wiki/UiMapID)

SPEEDRUN_TRASH_UPDATE

Fired if kill a valid trash

Index

Property

Description

1

name

The name of the trash

2

count

The killed number of the trash

3

countMax

The total number of the trash

4

mapID

Current zone map ID (See https://wowpedia.fandom.com/wiki/UiMapID)

SPEEDRUN_TIME_UPDATE

Fired if kill a valid encounter successfully

Index

Property

Description

1

name

The name of the encounter

2

duration

The time interval between encounter killed time and speedrun start time

3

mapID

Current zone map ID (See https://wowpedia.fandom.com/wiki/UiMapID)

SPEEDRUN_ENCOUNTER_MAP_UPDATE

Fired if player enter a valid map

Index

Property

Description

1

name

The name of the encounter

2

duration

The time interval between encounter killed time and speedrun start time

3

mapID

Current zone map ID (See https://wowpedia.fandom.com/wiki/UiMapID)

SPEEDRUN_DEATH_UPDATE

Fired if group member is dead

Index

Property

Description

1

count

Total death number from the speedrun beginning

2

deathTime

Total death time from the speedrun beginning

Control

1. Reset the timer and clear history (e.g. reset)

/run WeakAuras.ScanEvents("SPEEDRUN_RESET",true)

2. Force start the timer (e.g. GM)

/run WeakAuras.ScanEvents("SPEEDRUN_FORCE_START",true)

UI

• UI with trash and encounter details

https://wago.io/WCLSpeedrunUI

• Simple UI

https://wago.io/WclSpeedrunUISimple

• Encounter timer bar

https://wago.io/WclSpeedrunTimerBar