-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,23 @@ | ||
# API | ||
This repository aims to document the different interfaces relevant to Dota 2 Modding. It uses these to render http://docs.moddota.com/ and provides a repository for TypeScript declarations to be used for Panorama UI or with [TypescriptToLua](https://github.com/Perryvw/TypescriptToLua) for game code. | ||
|
||
### File Structure | ||
**/_data** Contains raw dumps from the engine | ||
## File Structure | ||
### /_data | ||
Contains raw dumps from the engine | ||
|
||
**/declarations/panorama/** TypeScript declarations for Panorama. | ||
### /declarations/panorama/ | ||
TypeScript declarations for Panorama. | ||
* **dota.d.ts** Declarations for interfacing with the game engine. | ||
* **dota_enums.d.ts** Declarations for enumerations used in Panorama. | ||
* **dota_panels.d.ts** Declarations for Panel interaction in Panorama. | ||
|
||
**/declarations/server/** TypeScript declarations for the lua API (see [TypescriptToLua](https://github.com/Perryvw/TypescriptToLua)). | ||
### /declarations/server/ | ||
TypeScript declarations for the lua API (see [TypescriptToLua](https://github.com/Perryvw/TypescriptToLua)). | ||
* **dota-api.d.ts** Declarations for the Lua API. | ||
* **dota-enums.d.ts** Declarations of Lua enums. | ||
* **dota-gameevents.d.ts** Declarations of the different game events and their event contents. | ||
* **dota-modifier-properties.d.ts** Declarations for modifier properties on Lua modifiers. | ||
* **dota-std.d.ts** Lua std functions used for Dota modding. | ||
|
||
**/examples/vscript/** Example TypeScript code. | ||
### /examples/vscript/ | ||
Example TypeScript code. |