Blizzard_APIDocumentation? - WoWInterface
Thread Tools Display Modes
01-25-18, 11:26 PM   #1
A Pyroguard Emberseer
zork's Avatar
AddOn Author - Click to view addons
Join Date: Jul 2008
Posts: 1,739

I'm looking through the latest API changes and found that Blizzard added a new addon with 7.2 called: Blizzard_APIDocumentation


What is this thing and how can be benefit from it?

*edit* Oh...

WoW API changelog
| Simple is beautiful.
| WoWI AddOns | GitHub | Zork (WoW) | TDMOG

"I wonder what the non-pathetic people are doing tonight?" - Rajesh Koothrappali (The Big Bang Theory)

Last edited by zork : 01-26-18 at 12:16 AM.
  Reply With Quote
01-26-18, 12:24 AM   #2
A Flamescale Wyrmkin
Join Date: Aug 2011
Posts: 129
Things like Click image for larger version

Name:	111.jpg
Views:	349
Size:	18.3 KB
ID:	9031 maybe, it's hard to keep those datas up-to-date in the old days.
  Reply With Quote
01-26-18, 12:01 PM   #3
A Frostmaul Preserver
Tim's Avatar
AddOn Author - Click to view addons
Join Date: Apr 2008
Posts: 279
From what I can remember is it will allow you to look up documentation via the client instead of 3rd party sites. Not sure if this will extend to events, etc. but, it's a good start.
AddOns: Tim @ WoWInterface
Characters: Warrior, Shaman, DH, Mage, Pally
Current PC Setup: PCPartPicker List
  Reply With Quote
01-26-18, 02:10 PM   #4
I did that?
Fizzlemizz's Avatar
Premium Member
AddOn Author - Click to view addons
Join Date: Dec 2011
Posts: 1,260
Just looking at the UnitDocumentation.lua from 7.3.5 to 8.0 they seem to be adding events and enum tables although it doesn't seem to list function returns to chat even though they are in the code.
Maintainer of Discord Unit Frames and Discord Art.
Author of FauxMazzle, FauxMazzleHUD and Move Pad Plus.

Last edited by Fizzlemizz : 01-26-18 at 02:12 PM.
  Reply With Quote
01-27-18, 01:53 AM   #5
A Pyroguard Emberseer
AddOn Author - Click to view addons
Join Date: Mar 2010
Posts: 1,289
This looks very weak, feels like even my documentation is more useful. (Currently working on Widget Reference):

Also i'm not sure whats the point listing the type of arguments/return values and nilability, since it's Lua. It can be table, string or number (or nil) and 99,9% of the time you can tell what it is just by it's name.

Personally i would like to see something like this, and this is what i'm also aiming for:

Lua Code:
  1. GetPlayerMapPosition = { -- Returns the position of a unit on the current map
  2.     args = {
  3.         unit, -- The unitID for which the position is returned (string)
  4.     }
  5.     returns = {
  6.         x, -- X value of the unit position (a proportion between 0 and 1, relative to WorldMapDetailFrame) (number)
  7.         y, -- Y value of the unit position (a proportion between 0 and 1, relative to WorldMapDetailFrame) (number)
  8.     }
  9. }

And only add the arg/return types if done with everything.

Last edited by Resike : 01-27-18 at 02:00 AM.
  Reply With Quote

WoWInterface » Developer Discussions » General Authoring Discussion » Blizzard_APIDocumentation?

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off