Skip to content

Commit 741cf1e

Browse files
photonstormphotonstorm
committed
Huge TypeScript defs update (thanks to @clark-stevenson - this is all of the changes from phaserjs#2156 merged into the current build)
1 parent ded2f72 commit 741cf1e

3 files changed

Lines changed: 220 additions & 93 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ If you are an exceptional JavaScript developer and would like to join the Phaser
275275

276276
### Updates
277277

278-
* TypeScript definitions fixes and updates (thanks @zimpy @iamfreee @milkey-mouse @juanmirod @danzel @staff0rd)
278+
* TypeScript definitions fixes and updates (thanks @clark-stevenson @zimpy @iamfreee @milkey-mouse @juanmirod @danzel @staff0rd)
279279
* Docs typo fixes (thanks @zeterain @staff0rd @milkey-mouse @dick-clark @nlotz @s4wny @jonjanisch @Alaxe @cdelstad @tsphillips)
280280
* Emitter methods `at`, `explode`, `flow`, `kill`, `revive`, `setAlpha`, `setRotation`, `setScale`, `setSize`, `setXSpeed`, `setYSpeed` and `start` now return the Emitter instance for better method chaining (thanks @samme #2308)
281281
* Tilemap.hasTile will now return `false` if the Tile doesn't exist in the coordinates given (which can happen if the coordinates are out of bounds) (thanks @cy-ryo-fujiwara #2304)

‎typescript/phaser.d.ts‎

Lines changed: 187 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/// <reference path="pixi.d.ts" />
22
/// <reference path="p2.d.ts" />
33

4-
// Type definitions for Phaser 2.4.5
4+
// Type definitions for Phaser 2.4.5 - 2nd February 2015
55
// Project: https://github.com/photonstorm/phaser
66

77
declare module "phaser" {
@@ -135,6 +135,7 @@ declare module Phaser {
135135

136136
static JSONData(game: Phaser.Game, json: any): Phaser.FrameData;
137137
static JSONDataHash(game: Phaser.Game, json: any): Phaser.FrameData;
138+
static JSONDataPyxel(game: Phaser.Game, json: any): Phaser.FrameData;
138139
static spriteSheet(game: Phaser.Game, key: string, frameWidth: number, frameHeight: number, frameMax?: number, margin?: number, spacing?: number): Phaser.FrameData;
139140
static XMLData(game: Phaser.Game, xml: any): Phaser.FrameData;
140141

@@ -193,6 +194,38 @@ declare module Phaser {
193194

194195
}
195196

197+
interface BitmapFont {
198+
199+
base: PIXI.BaseTexture;
200+
data: HTMLImageElement;
201+
font: Phaser.BMFont;
202+
url: string;
203+
204+
}
205+
206+
interface BMFont {
207+
208+
chars: Phaser.BMFontChar[];
209+
font: string;
210+
lineHeight: number;
211+
size: number;
212+
213+
}
214+
215+
interface BMFontChar {
216+
217+
x: number;
218+
y: number;
219+
width: number;
220+
height: number;
221+
xOffset: number;
222+
yOffset: number;
223+
xAdvance: number;
224+
kerning: number[];
225+
texture: PIXI.BaseTexture;
226+
227+
}
228+
196229
class BitmapData {
197230

198231
constructor(game: Phaser.Game, key: string, width?: number, height?: number);
@@ -400,6 +433,13 @@ declare module Phaser {
400433

401434
}
402435

436+
class PointerMode {
437+
438+
static CURSOR: number;
439+
static CONTACT: number;
440+
441+
}
442+
403443
class Cache {
404444

405445
constructor(game: Phaser.Game);
@@ -432,7 +472,7 @@ declare module Phaser {
432472
addBitmapFont(key: string, url: string, data: any, atlasData: any, atlasType: string, xSpacing?: number, ySpacing?: number): void;
433473
addCanvas(key: string, canvas: HTMLCanvasElement, context?: CanvasRenderingContext2D): void;
434474
addDefaultImage(): void;
435-
addImage(key: string, url: string, data: any): Phaser.CachedImage;
475+
addImage(key: string, url: string, data: any): HTMLImageElement;
436476
addJSON(key: string, urL: string, data: any): void;
437477
addMissingImage(): void;
438478
addPhysicsData(key: string, url: string, JSONData: any, format: number): void;
@@ -469,14 +509,14 @@ declare module Phaser {
469509
getBaseTexture(key: string, cache?: number): PIXI.BaseTexture;
470510
getBinary(key: string): any;
471511
getBitmapData(key: string): Phaser.BitmapData;
472-
getBitmapFont(key: string): Phaser.RetroFont;
512+
getBitmapFont(key: string): Phaser.BitmapFont;
473513
getCanvas(key: string): HTMLCanvasElement;
474514
getFrame(key: string, cache?: number): Phaser.Frame;
475515
getFrameByIndex(key: string, index: number, cache?: number): Phaser.Frame;
476516
getFrameByName(key: string, name: string, cache?: number): Phaser.Frame;
477517
getFrameCount(key: string, cache?: number): number;
478518
getFrameData(key: string, cache?: number): Phaser.FrameData;
479-
getImage(key: string, full?: boolean): Phaser.CachedImage;
519+
getImage(key: string, full?: boolean): HTMLImageElement;
480520
getItem(key: string, cache: number, method?: string, property?: string): any;
481521
getJSON(key: string, clone?: boolean): any;
482522
getKeys(cache: number): string[];
@@ -525,17 +565,6 @@ declare module Phaser {
525565

526566
}
527567

528-
interface CachedImage {
529-
530-
key: string;
531-
url: string;
532-
data: HTMLImageElement;
533-
base: PIXI.BaseTexture;
534-
frame: Phaser.Frame;
535-
frameData: Phaser.FrameData;
536-
537-
}
538-
539568
interface CachedRenderTexture {
540569

541570
frame: Phaser.Frame;
@@ -588,7 +617,8 @@ declare module Phaser {
588617

589618
static addToDOM(canvas: HTMLCanvasElement, parent: HTMLElement, overflowHidden?: boolean): HTMLCanvasElement;
590619
static create(parent: HTMLDivElement, width?: number, height?: number, id?: string, skipPool?: boolean): HTMLCanvasElement;
591-
static getSmoothngEnabled(context: CanvasRenderingContext2D): boolean;
620+
static getSmoothingEnabled(context: CanvasRenderingContext2D): boolean;
621+
static getSmoothingPrefix(context: CanvasRenderingContext2D): string;
592622
static removeFromDOM(canvas: HTMLCanvasElement): void;
593623
static setBackgroundColor(canvas: HTMLCanvasElement, color: string): HTMLCanvasElement;
594624
static setImageRenderingBicubic(canvas: HTMLCanvasElement): HTMLCanvasElement;
@@ -773,6 +803,7 @@ declare module Phaser {
773803
ie: boolean;
774804
ieVersion: number;
775805
iOS: boolean;
806+
iOSVersion: number;
776807
initialized: boolean;
777808
iPad: boolean;
778809
iPhone: boolean;
@@ -1300,6 +1331,7 @@ declare module Phaser {
13001331
cache: Phaser.Cache;
13011332
camera: Phaser.Camera;
13021333
canvas: HTMLCanvasElement;
1334+
clearBeforeRender: boolean;
13031335
config: IGameConfig;
13041336
context: CanvasRenderingContext2D;
13051337
count: number;
@@ -1910,26 +1942,26 @@ declare module Phaser {
19101942
destroy(): void;
19111943
disableDrag(): void;
19121944
disableSnap(): void;
1913-
downDuration(pointer: Phaser.Pointer): number;
1945+
downDuration(pointerId?: number): number;
19141946
enableDrag(lockCenter?: boolean, bringToTop?: boolean, pixelPerfect?: boolean, alphaThreshold?: number, boundsRect?: Phaser.Rectangle, boundsSprite?: Phaser.Sprite): void;
19151947
enableSnap(snapX: number, snapY: number, onDrag?: boolean, onRelease?: boolean, snapOffsetX?: number, snapOffsetY?: number): void;
19161948
isPixelPerfect(): boolean;
1917-
justOut(pointer: number, delay: number): boolean;
1918-
justOver(pointer: number, delay: number): boolean;
1919-
justPressed(pointer: number, delay: number): boolean;
1920-
justReleased(pointer: number, delay: number): boolean;
1921-
overDuration(pointer: Phaser.Pointer): number;
1922-
pointerDown(pointer: number): boolean;
1923-
pointerDragged(pointer: Phaser.Pointer): boolean;
1924-
pointerOut(index: number): boolean;
1925-
pointerOver(index: number): boolean;
1926-
pointerTimeDown(pointer: Phaser.Pointer): number;
1927-
pointerTimeOut(pointer: Phaser.Pointer): number;
1928-
pointerTimeOver(pointer: number): number;
1929-
pointerTimeUp(pointer: number): number;
1930-
pointerUp(pointer: number): boolean;
1931-
pointerX(pointer: number): number;
1932-
pointerY(pointer: number): number;
1949+
justOut(pointerId?: number, delay?: number): boolean;
1950+
justOver(pointerId?: number, delay?: number): boolean;
1951+
justPressed(pointerId?: number, delay?: number): boolean;
1952+
justReleased(pointerId?: number, delay?: number): boolean;
1953+
overDuration(pointerId?: number): number;
1954+
pointerDown(pointerId?: number): boolean;
1955+
pointerDragged(pointerId?: number): boolean;
1956+
pointerOut(pointerId?: number): boolean;
1957+
pointerOver(pointerId?: number): boolean;
1958+
pointerTimeDown(pointerId?: number): number;
1959+
pointerTimeOut(pointerId?: number): number;
1960+
pointerTimeOver(pointerId?: number): number;
1961+
pointerTimeUp(pointerId?: number): number;
1962+
pointerUp(pointerId?: number): boolean;
1963+
pointerX(pointerId?: number): number;
1964+
pointerY(pointerId?: number): number;
19331965
reset(): void;
19341966
setDragLock(allowHorizontal?: boolean, allowVertical?: boolean): void;
19351967
start(priority: number, useHandCursor: boolean): Phaser.Sprite;
@@ -2117,6 +2149,113 @@ declare module Phaser {
21172149

21182150
}
21192151

2152+
class KeyCode {
2153+
2154+
static A: number;
2155+
static B: number;
2156+
static C: number;
2157+
static D: number;
2158+
static E: number;
2159+
static F: number;
2160+
static G: number;
2161+
static H: number;
2162+
static I: number;
2163+
static J: number;
2164+
static K: number;
2165+
static L: number;
2166+
static M: number;
2167+
static N: number;
2168+
static O: number;
2169+
static P: number;
2170+
static Q: number;
2171+
static R: number;
2172+
static S: number;
2173+
static T: number;
2174+
static U: number;
2175+
static V: number;
2176+
static W: number;
2177+
static X: number;
2178+
static Y: number;
2179+
static Z: number;
2180+
static ZERO: number;
2181+
static ONE: number;
2182+
static TWO: number;
2183+
static THREE: number;
2184+
static FOUR: number;
2185+
static FIVE: number;
2186+
static SIX: number;
2187+
static SEVEN: number;
2188+
static EIGHT: number;
2189+
static NINE: number;
2190+
static NUMPAD_0: number;
2191+
static NUMPAD_1: number;
2192+
static NUMPAD_2: number;
2193+
static NUMPAD_3: number;
2194+
static NUMPAD_4: number;
2195+
static NUMPAD_5: number;
2196+
static NUMPAD_6: number;
2197+
static NUMPAD_7: number;
2198+
static NUMPAD_8: number;
2199+
static NUMPAD_9: number;
2200+
static NUMPAD_MULTIPLY: number;
2201+
static NUMPAD_ADD: number;
2202+
static NUMPAD_ENTER: number;
2203+
static NUMPAD_SUBTRACT: number;
2204+
static NUMPAD_DECIMAL: number;
2205+
static NUMPAD_DIVIDE: number;
2206+
static F1: number;
2207+
static F2: number;
2208+
static F3: number;
2209+
static F4: number;
2210+
static F5: number;
2211+
static F6: number;
2212+
static F7: number;
2213+
static F8: number;
2214+
static F9: number;
2215+
static F10: number;
2216+
static F11: number;
2217+
static F12: number;
2218+
static F13: number;
2219+
static F14: number;
2220+
static F15: number;
2221+
static COLON: number;
2222+
static EQUALS: number;
2223+
static COMMA: number;
2224+
static UNDERSCORE: number;
2225+
static PERIOD: number;
2226+
static QUESTION_MARK: number;
2227+
static TILDE: number;
2228+
static OPEN_BRACKET: number;
2229+
static BACKWARD_SLASH: number;
2230+
static CLOSED_BRACKET: number;
2231+
static QUOTES: number;
2232+
static BACKSPACE: number;
2233+
static TAB: number;
2234+
static CLEAR: number;
2235+
static ENTER: number;
2236+
static SHIFT: number;
2237+
static CONTROL: number;
2238+
static ALT: number;
2239+
static CAPS_LOCK: number;
2240+
static ESC: number;
2241+
static SPACEBAR: number;
2242+
static PAGE_UP: number;
2243+
static PAGE_DOWN: number;
2244+
static END: number;
2245+
static HOME: number;
2246+
static LEFT: number;
2247+
static UP: number;
2248+
static RIGHT: number;
2249+
static DOWN: number;
2250+
static INSERT: number;
2251+
static DELETE: number;
2252+
static HELP: number;
2253+
static NUM_LOCK: number;
2254+
static PLUS: number;
2255+
static MINUS: number;
2256+
2257+
}
2258+
21202259
class Line {
21212260

21222261
constructor(x1?: number, y1?: number, x2?: number, y2?: number);
@@ -2184,6 +2323,7 @@ declare module Phaser {
21842323
static TEXTURE_ATLAS_JSON_ARRAY: number;
21852324
static TEXTURE_ATLAS_JSON_HASH: number;
21862325
static TEXTURE_ATLAS_XML_STARLING: number;
2326+
static TEXTURE_ATLAS_JSON_PYXEL: number;
21872327

21882328
baseURL: string;
21892329
cache: Phaser.Cache;
@@ -3667,7 +3807,7 @@ declare module Phaser {
36673807

36683808
class Pointer {
36693809

3670-
constructor(game: Phaser.Game, id: number);
3810+
constructor(game: Phaser.Game, id: number, pointerMode?: number);
36713811

36723812
static NO_BUTTON: number;
36733813
static LEFT_BUTTON: number;
@@ -3687,8 +3827,10 @@ declare module Phaser {
36873827
duration: number;
36883828
eraserButton: Phaser.DeviceButton;
36893829
exists: boolean;
3830+
forceOut: boolean;
36903831
forwardButton: Phaser.DeviceButton;
36913832
game: Phaser.Game;
3833+
justReleasePreventsOver: boolean | number;
36923834
id: number;
36933835
identifier: number;
36943836
isDown: boolean;
@@ -3791,7 +3933,7 @@ declare module Phaser {
37913933

37923934
class RandomDataGenerator {
37933935

3794-
constructor(seeds: number[]|string);
3936+
constructor(seeds: any[] | string);
37953937

37963938
angle(): number;
37973939
between(min: number, max: number): number;
@@ -4332,28 +4474,27 @@ declare module Phaser {
43324474

43334475
}
43344476

4335-
class Stage extends PIXI.Stage {
4477+
class Stage extends PIXI.DisplayObjectContainer {
43364478

43374479
constructor(game: Phaser.Game);
43384480

4339-
backgroundColor: any;
4340-
currentRenderOrderID: number;
4341-
disableVisibilityChange: boolean;
4342-
exists: boolean;
43434481
game: Phaser.Game;
43444482
name: string;
4483+
disableVisibilityChange: boolean;
4484+
exists: boolean;
4485+
currentRenderOrderID: number;
4486+
backgroundColor: any;
43454487
smoothed: boolean;
43464488

4347-
boot(): void;
4348-
checkVisibility(): void;
4349-
destroy(): void;
43504489
parseConfig(config: any): void;
4351-
postUpdate(): void;
43524490
preUpdate(): void;
4353-
setBackgroundColor(backgroundColor: number | string): void;
43544491
update(): void;
4492+
postUpdate(): void;
43554493
updateTransform(): void;
4494+
checkVisibility(): void;
43564495
visibilityChange(event: Event): void;
4496+
setBackgroundColor(backgroundColor: number | string): void;
4497+
destroy(): void;
43574498

43584499
}
43594500

@@ -5058,7 +5199,7 @@ declare module Phaser {
50585199
touchStartCallback: Function;
50595200
touchLockCallbacks: Function[];
50605201

5061-
addTouchLockCallback(callback: Function, context?: any): void;
5202+
addTouchLockCallback(callback: Function, context?: any, onEnd?: Function): void;
50625203
removeTouchLockCallback(callback: Function, context?: any): boolean;
50635204
consumeTouchMove(): void;
50645205
onTouchCancel(event: any): void;

0 commit comments

Comments
 (0)