vscode-wow-api
vscode-wow-api copied to clipboard
Ketho
WoW extension for VSCode
WoW API
Adds IntelliSense features for World of Warcraft API to VS Code. This is a plugin extension for Sumneko's Lua Language Server with LuaCATS annotations.
Features
API
- Parses Warcraft Wiki pages for API documentation
- Lua shorthand references e.g.
format(string.format) andtinsert(table.insert) - Custom WoW Lua functions e.g.
wipeandstrsplit
Widgets
Events
CVars
Enums
-
EnumandConstantstable -
LE_Lua Enums
GlobalStrings
Shows completion for GlobalStrings at >3 uppercase letters to declutter fuzzy search.
Contributing
The extension reflects the state of the wiki, so if you create/update the wiki pages, it will be updated in the extension on the next release. Otherwise feel free to create an issue with the false errors.
For example UnitLevel would be documented like so.
{{wowapi}}
Returns the level of the unit.
level = UnitLevel(unit)
==Arguments==
:;unit:{{apitype|string}} : [[UnitId]]
==Returns==
:;level:{{apitype|number}}
Alternatively, the script will look for a commented block if present.
(This only looks for global APIs not documented in Blizzard_APIDocumentationGenerated, it won't look for Widget APIs and FrameXML functions)
<!-- emmylua
---@param unit UnitId
---@return number level
function UnitLevel(unit) end
-->
Setup
Refer to SETUP.md if you want to run the Lua scripts which generate the documentation.
Acknowledgements
- Andols, Buds, ChrisKader
- DahkCeles, Ellypse, Ferronn
- Foxlit, Gethe, Iriel
- jnwhiteh, Kaydeethree, Kozoaku
- Marlamin, Meorawr, nebula
- thatnerdjosh, Nevcairiel, Oppzippy
- Resike, Stanzilla, Sumneko
- Torhal, Wutname, Yuyuli
- Xelnath
- Blizzard Entertainment, Townlong Yak, WoW.tools
- WoWInterface, Warcraft Wiki, Wowprogramming
Ketho