Skip to content

Access the wc3 natives from your lua code. Includes documentation on all natives from the jassdoc project

Notifications You must be signed in to change notification settings

Tomotz/wc3-lua-natives

Repository files navigation

WC3 Lua Natives

Access Warcraft 3 native functions, types, constants, and globals from your Lua code. Includes comprehensive documentation for all natives from the jassdoc project.

Features

  • Go to Definition (F11): Press F11 while your cursor is on any native function, type, constant, or global variable to jump directly to its documentation
  • Command Palette: Use "WC3: Go to Native Function" to search for and navigate to any definition
  • 5500+ Definitions: Includes natives, functions, types, constants, and global variables from:
    • common.j - Core WC3 natives
    • Blizzard.j - Blizzard.j library functions
    • Extra JASS/Lua APIs
    • AI scripts

Usage

  1. Open a Lua file for Warcraft 3 modding
  2. Place your cursor on a native function name (e.g., CreateUnit, ConvertRace, ABILITY_ILF_SHIELD_LIFE)
  3. Press F12 to view the full documentation with parameters and descriptions

Or use Ctrl+Shift+P and type "WC3: Go to Native Function" to search by name.

Requirements

  • VS Code 1.106.1 or higher

Extension Settings

This extension activates automatically when you open Lua files.

Known Issues

None at this time.

Release Notes

0.0.1

Initial release:

  • Navigate to native definitions with F12
  • Support for natives, functions, types, constants, and globals
  • Comprehensive jassdoc documentation included

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

  • Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
  • Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
  • Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

Enjoy!

About

Access the wc3 natives from your lua code. Includes documentation on all natives from the jassdoc project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published