refaim / vanilla-wow-lua-definitions

Vanilla WoW 1.12.1 Lua definitions for statically typed World of Warcraft addon development using Luanalysis IDE

What is it

This repository contains WIP Lua definition files for statically typed Vanilla 1.12.1 World of Warcraft addon development using Luanalysis IDE.

How to use it

• Install Intellij IDEA 2022.1 (Community Edition will do)
• Install Luanalysis plugin (File -> Settings -> Plugins)
• Set language level to 5.0 (File -> Settings -> Languages & Frameworks -> Luanalysis -> Language level)
• Download this repository
• Create new project (File -> New Project -> Lua)
• Add downloaded repository folder to your project as Library (File -> Project Structure -> Project Settings -> Libraries -> [Press +] -> Lua Zip Library -> [Select folder] -> OK -> Apply [you must click this button] -> OK)

Also see Luanalysis README.

Sources of information

Wowpedia

• Global functions as of 18:36, 2 October 2006
• Widget API as of 02:27, 9 October 2006

Other

• Lua 5.0 Reference Manual
• Lua 5.0 Definition Files from Benjamin-Dobell/IntelliJ-Luanalysis
• WoW 1.12.1 UI Source Code from MOUZU/Blizzard-WoW-Interface

License

This project is distributed under the Apache License 2.0 and under the Creative Commons Attribution ShareAlike 3.0 License.

See NOTICE for more information.

vanilla-wow-lua-definitions's Issues

Annotate UIObject

Annotate StatusBar

Annotate Frame

Annotate ColorSelect

Annotate Button

Annotate FontInstance

Annotate Texture

Add CVar annotations

Annotate Minimap

Annotate SimpleHTML

Annotate remaining STL functions

Annotate ScrollFrame

Add ScriptType annotations

See ScriptsType in UI.xsd

Annotate remaining global functions

I'll have to write a Wowpedia client and/or crawler to get 2006 era functions data. Thus, at least part of the work can be done automatically.

Annotate EditBox

Annotate MessageFrame

Annotate CheckButton

Annotate DressUpModel

Annotate FontString

Port KethoDoc to 1.12.1 API and use its output

It will be necessary to compare the list of symbols from the addon, the list of symbols in this repository and the list of symbols from the game client UI source code.

Annotate Region

Annotate Slider

Annotate PlayerModel

Annotate Font

Annotate LayeredRegion

Annotate ScrollingMessageFrame

Annotate Model

Implement multiple inheritance from FontInstance for some UIObject descendants

See TODOs about FontInstance inheritance

Add event annotations

Pack defs into Lua Zip Library package during CI run

Annotate GameTooltip

Annotate TabardModel

Somehow hide/delete Lua STL symbols that have been removed from WoW Lua Interpreter

I will probably have to fork Luanalysis and add a new code standard.

Deal with license issues

• Remove remaining book quotes
• Add license info for Luanalysis
• Add license info for Lua docs
• Add license info for Wowpedia
• Mention Lua docs in readme
• Change license to something compatible with all used data sources

Annotate LootButton