mirror of
https://github.com/brues-code/SuperCleveRoidMacros.git
synced 2026-09-16 03:38:00 +00:00
Brues
69318572c7
Document opportunities to use ClassicAPI (modern C_* API backport for the 1.12 client) in the addon: C_UnitAuras for target aura/dispel-type conditionals, GetWeaponEnchantInfo enchant IDs for poison/imbue checks, GetUnitSpeed to drop the MonkeySpeed dependency, plus C_Spell, C_Timer, UnitGUID, native focus, and Tier-3 items. Each entry cites API.md line refs and the addon files it touches, and notes the cross-cutting requirement to feature-detect with fallback (mirroring the nampower HasMinimumVersion pattern).
94 lines
4.1 KiB
Markdown
94 lines
4.1 KiB
Markdown
# ClassicAPI Adoption Backlog
|
|
|
|
Opportunities to use [ClassicAPI](https://github.com/) (`C:\Git\ClassicAPI`, see
|
|
`docs/API.md`) in SuperCleveRoidMacros. ClassicAPI is a client mod (sibling to
|
|
nampower/SuperWoW) that backports the modern `C_*` API into the 1.12.1 client.
|
|
We already gate nampower behind version detection — every ClassicAPI path below
|
|
must follow the same pattern: **feature-detect, then fall back to the current
|
|
implementation** so users without ClassicAPI are unaffected.
|
|
|
|
API references are line numbers into `C:\Git\ClassicAPI\docs\API.md`.
|
|
|
|
---
|
|
|
|
## Tier 1 — high impact (new capabilities, not just refactors)
|
|
|
|
### 1. `C_UnitAuras` — native aura data for any unit
|
|
- **API:** `API.md:8670` — `GetAuraDataBySpellName(unit, name, filter)`,
|
|
`GetUnitAuraBySpellID(unit, spellID, filter)`, `GetAuraDataByIndex`.
|
|
- Returns `spellId`, `dispelName` (`"Magic"`/`"Curse"`/`"Disease"`/`"Poison"`),
|
|
`applications` (stacks), `duration`.
|
|
- **Unlocks:** `[dispellable]` / `[curse]` / `[magic]` target conditionals and
|
|
spellID-based (rank/locale-proof) aura matching.
|
|
- **Replaces today:** pfUI libdebuff + tooltip scanning (`Conditionals.lua:1815+`).
|
|
- **Caveat:** `expirationTime` is only populated for `unit=="player"`; it's `0`
|
|
for target/focus (vanilla server limitation). Target debuff *timers* still
|
|
need the existing libdebuff tracking — only presence/stacks/school/spellId
|
|
are reliable cross-unit.
|
|
|
|
### 2. `C_Item.GetWeaponEnchantInfo()` — temp-enchant IDs
|
|
- **API:** `API.md:7159` — returns 12-tuple including `enchantID` for main/off/ranged.
|
|
- **Unlocks:** `[poison:<id>]` / `[weaponenchant:<id>]` conditionals — detect
|
|
*which* poison/oil/sharpening stone is applied, not just that one exists.
|
|
- Vanilla's global only reports presence; this is a genuinely new capability
|
|
(rogue/shaman/enhance).
|
|
|
|
### 3. `GetUnitSpeed(unit)` + `IsFalling()` / `IsSwimming()`
|
|
- **API:** `API.md:8312`, `API.md:7629`.
|
|
- **Replaces today:** MonkeySpeed addon dependency (which needs SuperWoW
|
|
`UnitPosition`) for `[moving]` — `Conditionals.lua:2981`.
|
|
|
|
---
|
|
|
|
## Tier 2 — replace custom scanning / extra deps
|
|
|
|
### 4. `C_Spell.*` / `GetSpellInfo(spellID)`
|
|
- **API:** `API.md:6649+` — `GetSpellCooldown`, `IsUsableSpell`, `IsSpellKnown`,
|
|
`SpellHasRange`, `GetSpellSchool`, `FindSpellBookSlotByID`.
|
|
- **Replaces today:** spellbook scanning via `GetSpellName(i, BOOKTYPE_SPELL)`
|
|
(`Conditionals.lua:2500`) and the Slam-slot hack. Simplifies `[known]`,
|
|
`[usable]`, range checks.
|
|
|
|
### 5. `C_Timer.After` / `NewTicker` (+ coroutines)
|
|
- **API:** `API.md:8008+`.
|
|
- **Replaces today:** manual `OnUpdate` frames (`Core.lua:5082`, `:80`, `:460`)
|
|
and the UnitXP aura-cleanup timer (`Conditionals.lua:1474`).
|
|
|
|
### 6. `UnitGUID` / `UnitTokenFromGUID`
|
|
- **API:** `API.md:8206+`.
|
|
- **Replaces today:** SuperWoW GUIDs in ComboPointTracker (`ComboPointTracker.lua`).
|
|
- **Verify first:** confirm GUID string format matches SuperWoW's before swapping.
|
|
|
|
### 7. Native `focus` token + `FocusUnit`/`ClearFocus` + `PLAYER_FOCUS_CHANGED`
|
|
- **API:** `API.md:2624+`.
|
|
- **Replaces today:** custom/pfUI focus resolution (`Conditionals.lua:5799`, `:3148`).
|
|
Gives engine-backed `@focus` for non-pfUI users.
|
|
|
|
---
|
|
|
|
## Tier 3 — situational
|
|
|
|
- **`C_NamePlate.GetNamePlates()` / `nameplateN` tokens** (`API.md:5742+`) —
|
|
alternative to UnitXP enemy enumeration for AoE counting (`Conditionals.lua:3099`).
|
|
- **`GetShapeshiftFormID()` + `UPDATE_SHAPESHIFT_FORM`** (`API.md:7792`) —
|
|
cleaner stance/form conditionals.
|
|
- **`CastSpellNoToggle` / numeric spellIDs in `/cast`** (`API.md:5336+`) —
|
|
rank-specific casting by ID, no-toggle behavior; could back a `/cast <spellID>`.
|
|
- **State helpers** `IsStealthed` / `IsMounted` / `UnitStandState` (`API.md:7574+`) —
|
|
back simple `[stealth]` / `[mounted]` / `[standing]` conditionals.
|
|
|
|
---
|
|
|
|
## Cross-cutting requirement
|
|
|
|
Gate **every** ClassicAPI path behind feature-detection with graceful fallback,
|
|
mirroring the nampower `HasMinimumVersion` pattern (`Conditionals.lua:227`):
|
|
|
|
```lua
|
|
if C_UnitAuras and C_UnitAuras.GetAuraDataBySpellName then
|
|
-- ClassicAPI path
|
|
else
|
|
-- existing libdebuff/tooltip path
|
|
end
|
|
```
|