Skip to content

Commit d775fa8

Browse files
Added webgl.d.ts for those who need it. Changed readme.txt to readme.md
1 parent c3d2b7a commit d775fa8

3 files changed

Lines changed: 698 additions & 10 deletions

File tree

typescript/readme.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# TypeScript Definitions #
2+
3+
If you are a phaser dev, just grab the whole directory as is. It is setup with sibling references and is the easiest way to get full typed support. Otherwise:
4+
5+
- `phaser.plugins.x.d.ts` depend on `phaser.d.ts` and are optional.*
6+
- `phaser.d.ts` depends on `pixi.d.ts` and so both these files are needed
7+
- `pixi.d.ts` has no dependicies and can be used by pixi devs**
8+
9+
*If creating a third party plugin definition. Please add a reference path to point at phaser `/// <reference path="phaser.d.ts" />`
10+
11+
**Versions of TypeScript lower than version 1.0 may experience errors in `pixi.d.ts` due to missing WebGL definitions. If you fall into this category then a `webgl.d.ts` has been provided but is disabled by default. Add this line to the top of the pixi.d.ts file `/// <reference path="webgl.d.ts" />` to fix the type errors.

typescript/readme.txt

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)