Skip to content

Commit

Permalink
Update changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Ketho committed May 28, 2022
1 parent 0f48e48 commit a08cde5
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 45 deletions.
14 changes: 10 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@
- Frame templates are not completely supported, only BackdropTemplate ([#15](https://github.com/Ketho/vscode-wow-api/issues/15))
- The Classic (TBC) API is not supported ([#13](https://github.com/Ketho/vscode-wow-api/issues/13))

## [0.8.5] - 2022-05-28
### Added
- 🌙 EmmyLua: Added initial `Mixin()` support and fixed issue [#42](https://github.com/Ketho/vscode-wow-api/issues/42)

## [0.8.4] - 2022-05-26
### Added
- 🌙 EmmyLua: Added widgets: Minimap, CheckButton, SimpleHTML, MovieFrame, CinematicModel, TabardModel, FogOfWarFrame, UnitPositionFrame, POIFrame, QuestPOIFrame ScenarioPOIFrame, LineScale, LineTranslation, TextureCoordTranslation
- 🌙 EmmyLua: Added [EmoteToken](https://wowpedia.fandom.com/wiki/API_DoEmote#Emotes)
- 🛠 Improvements: CreateFrame() now accepts lowercase/uppercase frame types e.g. "frame" or "FRAME".
- 🛠 Improvements: Added comment to widget scripts what frame type they were inherited from.

### Changed
- 🐞 Bug Fixes: Fixed widget scripts not inheriting from parent classes (regression).
- 🌙 EmmyLua: Fixed warnings in issues [#39](https://github.com/Ketho/vscode-wow-api/issues/39), [#40](https://github.com/Ketho/vscode-wow-api/issues/40), [#41](https://github.com/Ketho/vscode-wow-api/issues/41); Fixed EditBox to inherit FontInstance; Fixed .SetTexture, .SetPoint
Expand Down Expand Up @@ -257,10 +262,11 @@
### Added
- 🚧 Wip: Development work

[0.8.4]: https://github.com/Ketho/vscode-wow-api/releases/tag/v0.8.4
[0.8.3]: https://github.com/Ketho/vscode-wow-api/releases/tag/v0.8.3
[0.8.2]: https://github.com/Ketho/vscode-wow-api/releases/tag/v0.8.2
[0.8.1]: https://github.com/Ketho/vscode-wow-api/releases/tag/v0.8.1
[0.8.5]: https://github.com/Ketho/vscode-wow-api/releases/tag/0.8.5
[0.8.4]: https://github.com/Ketho/vscode-wow-api/releases/tag/0.8.4
[0.8.3]: https://github.com/Ketho/vscode-wow-api/releases/tag/0.8.3
[0.8.2]: https://github.com/Ketho/vscode-wow-api/releases/tag/0.8.2
[0.8.1]: https://github.com/Ketho/vscode-wow-api/releases/tag/0.8.1
[0.7.6]: https://github.com/Ketho/vscode-wow-api/releases/tag/v0.7.6
[0.7.5]: https://github.com/Ketho/vscode-wow-api/releases/tag/v0.7.5
[0.7.4]: https://github.com/Ketho/vscode-wow-api/releases/tag/v0.7.4
Expand Down
1 change: 1 addition & 0 deletions EmmyLua/API/Mixin/SmoothStatusBar.lua
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---@meta
SmoothStatusBarMixin = {}
function SmoothStatusBarMixin:ResetSmoothedValue(value) end
function SmoothStatusBarMixin:SetSmoothedValue(value) end
Expand Down
1 change: 1 addition & 0 deletions EmmyLua/API/Type/EmoteToken.lua
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---@meta
---@alias EmoteToken
---|"ABSENT"
---|"AGREE"
Expand Down
8 changes: 4 additions & 4 deletions Lua/Emmy/EmmyLiterals.lua
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ function EmmyLiterals:GetEventLiterals()
local t = {}
table.insert(t, "---@alias WowEvent")
for _, event in ipairs(APIDocumentation.events) do
local line = string.format("'\"%s\"'", event.LiteralName)
local line = string.format([["%s"]], event.LiteralName)
local payload = event:GetPayloadString(false, false)
if #payload > 0 then
line = line.." # `"..payload.."`"
end
table.insert(t, line)
end
return table.concat(t, "\n---| ").."\n"
return table.concat(t, "\n---|").."\n"
end

function EmmyLiterals:GetCVarLiterals()
Expand All @@ -28,9 +28,9 @@ function EmmyLiterals:GetCVarLiterals()
table.insert(t, "---@alias CVar")
local sorted = Util:SortTable(data[1].var)
for _, cvar in pairs(sorted) do
table.insert(t, string.format("'\"%s\"'", cvar))
table.insert(t, string.format([["%s"]], cvar))
end
return table.concat(t, "\n---| ").."\n"
return table.concat(t, "\n---|").."\n"
end

local function SortByValue(tbl)
Expand Down
40 changes: 3 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,47 +34,12 @@ See [Recommended settings](https://github.com/Ketho/vscode-wow-api/wiki/Recommen
Shows completion for GlobalStrings at >3 uppercase letters to declutter fuzzy search.

![](https://github.com/Ketho/vscode-wow-api/raw/master/img/globalstring.gif)
#### [Ace3](https://www.wowace.com/projects/ace3/pages/getting-started)
Due to the way Ace3 is designed, it is not possible to get full IntelliSense out of the box. When defining your addon you need create a class for your addon and extend it with the `AceAddon-3.0` librarys you plan to use in order to get full functionality.

Defining your addon example:

`MyAddon.lua`
```lua
---@class MyAddon : AceAddon-3.0, AceConsole-3.0, AceEvent-3.0, AceTimer-3.0
local MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceConsole-3.0", "AceEvent-3.0", "AceTimer-3.0")
_G.MyAddon = MyAddon
```
Now your will be able to see the extended API that Ace3 offers via IntelliSense.


In order to get full IntelliSense for Ace3 localizations you will need to give your localization a class then refrence that class in your addon.

`enUS.lua`
```lua
---@class MyAddonLocale
local L = LibStub('AceLocale-3.0'):NewLocale('MyAddon', 'enUS', true, debug)

... Your Language Deffinitions
```
`MyAddon.lua`
```lua
MyAddon.L = LibStub('AceLocale-3.0'):GetLocale('MyAddon', true) ---@type MyAddonLocale
```

You can also enable full IntelliSense for Ace3 options tables by defining what table contains your ace options
`options.lua`
```lua
---@type AceConfigOptionsTable
local options = {}
```
Tip: If you have options spread out over multiple files you can attach the options table to your global addon object. This will allow IntelliSense to continue to work in any file without having to re-define the type.
![](https://github.com/Ketho/vscode-wow-api/raw/master/img/aceconfigoptionstable.gif)
# Environment Setup
If using WSL, it is HIGHLY recommended that you setup your WSL instance and handle all git operations within WSL.

While using WSL is not required, the below setups are written around the assumption that WSL is being used. If you do not have WSL setup, you can start the install by running `wsl --install` from an elevated command prompt.
#

## Setting up a WSL Ubuntu Instance
### Windows Command Prompt (Elevated)
* Start an elevated command prompt in Windows
Expand All @@ -100,7 +65,7 @@ While using WSL is not required, the below setups are written around the assumpt
* This will open VS Code in windows and prompt you to install the Remote WSL extension
* You will then be able to use VS Code like you normally do but with the benefits of running an environment in Linux!
* Read more [here](https://code.visualstudio.com/docs/remote/wsl#:~:text=Alternatively%2C%20you%20can%20open%20a%20Remote%20WSL%20window,Use%20the%20File%20menu%20to%20open%20your%20folder.)!
#

### Generating documentation
* Blizzard documented functions are generated from [Blizzard_APIDocumentation](https://github.com/Gethe/wow-ui-source/tree/live/AddOns/Blizzard_APIDocumentation).
* Non-Blizzard documented functions are [exported](https://wowpedia.fandom.com/wiki/Special:Export) and parsed from Wowpedia.
Expand Down Expand Up @@ -133,6 +98,7 @@ The following people contributed to the development resources or their work was
* [Resike](https://github.com/Resike)
* [Stanzilla](https://github.com/Stanzilla)
* [Sumneko](https://github.com/Sumneko)
* [Wutname](https://github.com/Wutname1)
* [Yuyuli](https://www.curseforge.com/members/yuyuli/projects)
---
* [Blizzard Entertainment](https://www.blizzard.com/)
Expand Down

0 comments on commit a08cde5

Please sign in to comment.