Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-22 11:03:23 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/typescript/phaser.comments.d.ts

25994 lines
1.1 MiB
TypeScript
Raw Normal View History

Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/// <reference path="pixi.comments.d.ts" />
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/// <reference path="p2.d.ts" />
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
// Type definitions for Phaser 2.3.0 RC1 2015-03-24
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
// Project: https://github.com/photonstorm/phaser
declare class Phaser {
static VERSION: string;
static DEV_VERSION: string;
static GAMES: Phaser.Game[];
static AUTO: number;
static CANVAS: number;
static WEBGL: number;
static HEADLESS: number;
static BITMAPDATA: number;
static BITMAPTEXT: number;
static BUTTON: number;
static CANVAS_FILTER: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
static CIRCLE: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
static ELLIPSE: number;
static EMITTER: number;
static GRAPHICS: number;
static GROUP: number;
static IMAGE: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
static LINE: number;
static MATRIX: number;
static POINT: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
static POINTER: number;
static POLYGON: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
static RECTANGLE: number;
static ROUNDEDRECTANGLE: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
static RENDERTEXTURE: number;
static RETROFONT: number;
static SPRITE: number;
static SPRITEBATCH: number;
static TEXT: number;
static TILEMAP: number;
static TILEMAPLAYER: number;
static TILESPRITE: number;
static WEBGL_FILTER: number;
static ROPE: number;
static NONE: number;
static LEFT: number;
static RIGHT: number;
static UP: number;
static DOWN: number;
}
declare module Phaser {
/**
* An Animation instance contains a single animation and the controls to play it.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* It is created by the AnimationManager, consists of Animation.Frame objects and belongs to a single Game Object such as a Sprite.
*/
class Animation {
/**
* An Animation instance contains a single animation and the controls to play it.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* It is created by the AnimationManager, consists of Animation.Frame objects and belongs to a single Game Object such as a Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param parent A reference to the owner of this Animation.
* @param name The unique name for this animation, used in playback commands.
* @param frameData The FrameData object that contains all frames used by this Animation.
* @param frames An array of numbers or strings indicating which frames to play in which order.
* @param frameRate The speed at which the animation should play. The speed is given in frames per second. - Default: 60
* @param loop Whether or not the animation is looped or just plays once. - Default: false
* @param loop Should this animation loop when it reaches the end or play through once.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, parent: Phaser.Sprite, name: string, frameData: Phaser.FrameData, frames: number[]|string[], frameRate?: number, loop?: boolean);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The currently displayed frame of the Animation.
*/
currentFrame: Phaser.Frame;
/**
* The delay in ms between each frame of the Animation, based on the given frameRate.
*/
delay: number;
/**
* Gets or sets if this animation will dispatch the onUpdate events upon changing frame.
*/
enableUpdate: boolean;
/**
* Gets or sets the current frame index and updates the Texture Cache for display.
*/
frame: number;
/**
* The total number of frames in the currently loaded FrameData, or -1 if no FrameData is loaded.
*/
frameTotal: number;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* The finished state of the Animation. Set to true once playback completes, false during playback.
* Default: false
*/
isFinished: boolean;
/**
* The paused state of the Animation.
* Default: false
*/
isPaused: boolean;
/**
* The playing state of the Animation. Set to false once playback completes, true during playback.
* Default: false
*/
isPlaying: boolean;
/**
* Should the parent of this Animation be killed when the animation completes?
* Default: false
*/
killOnComplete: boolean;
/**
* The loop state of the Animation.
*/
loop: boolean;
/**
* The number of times the animation has looped since it was last started.
*/
loopCount: number;
/**
* The user defined name given to this Animation.
*/
name: string;
/**
* This event is dispatched when this Animation completes playback. If the animation is set to loop this is never fired, listen for onAnimationLoop instead.
*/
onComplete: Phaser.Signal;
/**
* This event is dispatched when this Animation loops.
*/
onLoop: Phaser.Signal;
/**
* This event is dispatched when this Animation starts playback.
*/
onStart: Phaser.Signal;
/**
* This event is dispatched when the Animation changes frame. By default this event is disabled due to its intensive nature. Enable it with: `Animation.enableUpdate = true`.
* Default: null
*/
onUpdate: Phaser.Signal;
/**
* Gets and sets the paused state of this Animation.
*/
paused: boolean;
/**
* Gets or sets the current speed of the animation in frames per second. Changing this in a playing animation will take effect from the next frame. Minimum value is 1.
*/
speed: number;
/**
* Called internally when the animation finishes playback.
* Sets the isPlaying and isFinished states and dispatches the onAnimationComplete event if it exists on the parent and local onComplete event.
*/
complete(): void;
/**
* Cleans up this animation ready for deletion. Nulls all values and references.
*/
destroy(): void;
/**
* Really handy function for when you are creating arrays of animation data but it's using frame names and not numbers.
* For example imagine you've got 30 frames named: 'explosion_0001-large' to 'explosion_0030-large'
* You could use this function to generate those by doing: Phaser.Animation.generateFrameNames('explosion_', 1, 30, '-large', 4);
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param prefix The start of the filename. If the filename was 'explosion_0001-large' the prefix would be 'explosion_'.
* @param start The number to start sequentially counting from. If your frames are named 'explosion_0001' to 'explosion_0034' the start is 1.
* @param stop The number to count to. If your frames are named 'explosion_0001' to 'explosion_0034' the stop value is 34.
* @param suffix The end of the filename. If the filename was 'explosion_0001-large' the prefix would be '-large'. - Default: ''
* @param zeroPad The number of zeroes to pad the min and max values with. If your frames are named 'explosion_0001' to 'explosion_0034' then the zeroPad is 4. - Default: 0
* @return An array of framenames.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static generateFrameNames(prefix: string, start: number, stop: number, suffix?: string, zeroPad?: number): string[];
/**
* Advances by the given number of frames in the Animation, taking the loop value into consideration.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param quantity The number of frames to advance. - Default: 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
next(quantity?: number): void;
/**
* Called when the Game enters a paused state.
*/
onPause(): void;
/**
* Called when the Game resumes from a paused state.
*/
onResume(): void;
/**
* Plays this animation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frameRate The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used. - Default: null
* @param loop Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used. - Default: false
* @param killOnComplete If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed. - Default: false
* @return - A reference to this Animation instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
play(frameRate?: number, loop?: boolean, killOnComplete?: boolean): Phaser.Animation;
/**
* Moves backwards the given number of frames in the Animation, taking the loop value into consideration.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param quantity The number of frames to move back. - Default: 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
previous(quantity?: number): void;
/**
* Sets this animation back to the first frame and restarts the animation.
*/
restart(): void;
/**
* Sets this animations playback to a given frame with the given ID.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frameId The identifier of the frame to set. Can be the name of the frame, the sprite index of the frame, or the animation-local frame index.
* @param useLocalFrameIndex If you provide a number for frameId, should it use the numeric indexes of the frameData, or the 0-indexed frame index local to the animation. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setFrame(frameId?: string|number, useLocalFrameIndex?: boolean): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Stops playback of this animation and set it to a finished state. If a resetFrame is provided it will stop playback and set frame to the first in the animation.
* If `dispatchComplete` is true it will dispatch the complete events, otherwise they'll be ignored.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param resetFrame If true after the animation stops the currentFrame value will be set to the first frame in this animation. - Default: false
* @param dispatchComplete Dispatch the Animation.onComplete and parent.onAnimationComplete events? - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
stop(resetFrame?: boolean, dispatchComplete?: boolean): void;
/**
* Updates this animation. Called automatically by the AnimationManager.
*/
update(): boolean;
/**
* Changes the FrameData object this Animation is using.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frameData The FrameData object that contains all frames used by this Animation.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateFrameData(frameData: FrameData): void;
}
/**
* The Animation Manager is used to add, play and update Phaser Animations.
* Any Game Object such as Phaser.Sprite that supports animation contains a single AnimationManager instance.
*/
class AnimationManager {
/**
* The Animation Manager is used to add, play and update Phaser Animations.
* Any Game Object such as Phaser.Sprite that supports animation contains a single AnimationManager instance.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite A reference to the Game Object that owns this AnimationManager.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(sprite: Phaser.Sprite);
/**
* The currently displayed animation, if any.
* Default: null
*/
currentAnim: Phaser.Animation;
/**
* The currently displayed Frame of animation, if any.
* Default: null
*/
currentFrame: Phaser.Frame;
/**
* Gets or sets the current frame index and updates the Texture Cache for display.
*/
frame: number;
/**
* The current animations FrameData.
*/
frameData: Phaser.FrameData;
/**
* Gets or sets the current frame name and updates the Texture Cache for display.
*/
frameName: string;
/**
* The total number of frames in the currently loaded FrameData, or -1 if no FrameData is loaded.
*/
frameTotal: number;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* Set to true once animation data has been loaded.
* Default: false
*/
isLoaded: boolean;
/**
* Gets the current animation name, if set.
*/
name: string;
/**
* Gets and sets the paused state of the current animation.
*/
paused: boolean;
/**
* A reference to the parent Sprite that owns this AnimationManager.
*/
sprite: Phaser.Sprite;
/**
* Should the animation data continue to update even if the Sprite.visible is set to false.
* Default: true
*/
updateIfVisible: boolean;
/**
* Adds a new animation under the given key. Optionally set the frames, frame rate and loop.
* Animations added in this way are played back with the play function.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The unique (within this Sprite) name for the animation, i.e. "run", "fire", "walk".
* @param frames An array of numbers/strings that correspond to the frames to add to this animation and in which order. e.g. [1, 2, 3] or ['run0', 'run1', run2]). If null then all frames will be used. - Default: null
* @param frameRate The speed at which the animation should play. The speed is given in frames per second. - Default: 60
* @param loop Whether or not the animation is looped or just plays once. - Default: false
* @param useNumericIndex Are the given frames using numeric indexes (default) or strings? - Default: true
* @return The Animation object that was created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
add(name: string, frames?: number[]|string[], frameRate?: number, loop?: boolean, useNumericIndex?: boolean): Phaser.Animation;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Loads FrameData into the internal temporary vars and resets the frame index to zero.
* This is called automatically when a new Sprite is created.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frameData The FrameData set to load.
* @param frame The frame to default to.
* @return Returns `true` if the frame data was loaded successfully, otherwise `false`
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
copyFrameData(frameData: Phaser.FrameData, frame: string|number): boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Destroys all references this AnimationManager contains.
* Iterates through the list of animations stored in this manager and calls destroy on each of them.
*/
destroy(): void;
/**
* Returns an animation that was previously added by name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the animation to be returned, e.g. "fire".
* @return The Animation instance, if found, otherwise null.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getAnimation(name: string): Phaser.Animation;
/**
* Advances by the given number of frames in the current animation, taking the loop value into consideration.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param quantity The number of frames to advance. - Default: 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
next(quantity?: number): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Play an animation based on the given key. The animation should previously have been added via `animations.add`
*
* If the requested animation is already playing this request will be ignored.
* If you need to reset an already running animation do so directly on the Animation object itself.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the animation to be played, e.g. "fire", "walk", "jump".
* @param frameRate The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used. - Default: null
* @param loop Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used. - Default: false
* @param killOnComplete If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed. - Default: false
* @return A reference to playing Animation instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
play(name: string, frameRate?: number, loop?: boolean, killOnComplete?: boolean): Phaser.Animation;
/**
* Moves backwards the given number of frames in the current animation, taking the loop value into consideration.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param quantity The number of frames to move back. - Default: 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
previous(quantity?: number): void;
/**
* Refreshes the current frame data back to the parent Sprite and also resets the texture data.
*/
refreshFrame(): void;
/**
* Stop playback of an animation. If a name is given that specific animation is stopped, otherwise the current animation is stopped.
* The currentAnim property of the AnimationManager is automatically set to the animation given.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the animation to be stopped, e.g. "fire". If none is given the currently running animation is stopped. - Default: null
* @param resetFrame When the animation is stopped should the currentFrame be set to the first frame of the animation (true) or paused on the last frame displayed (false) - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
stop(name?: string, resetFrame?: boolean): void;
/**
* The main update function is called by the Sprites update loop. It's responsible for updating animation frames and firing related events.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if a new animation frame has been set, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(): boolean;
/**
* Check whether the frames in the given array are valid and exist.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frames An array of frames to be validated.
* @param useNumericIndex Validate the frames based on their numeric index (true) or string index (false) - Default: true
* @return True if all given Frames are valid, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
validateFrames(frames: Phaser.Frame[], useNumericIndex?: boolean): boolean;
}
/**
* Responsible for parsing sprite sheet and JSON data into the internal FrameData format that Phaser uses for animations.
*/
class AnimationParser {
/**
* Parse the JSON data and extract the animation frame data from it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param json The JSON data from the Texture Atlas. Must be in Array format.
* @param cacheKey The Game.Cache asset key of the texture image.
* @return A FrameData object containing the parsed frames.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static JSONData(game: Phaser.Game, json: any, cacheKey: string): Phaser.FrameData;
/**
* Parse the JSON data and extract the animation frame data from it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param json The JSON data from the Texture Atlas. Must be in JSON Hash format.
* @param cacheKey The Game.Cache asset key of the texture image.
* @return A FrameData object containing the parsed frames.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static JSONDataHash(game: Phaser.Game, json: any, cacheKey: string): Phaser.FrameData;
/**
* Parse a Sprite Sheet and extract the animation frame data from it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param key The Game.Cache asset key of the Sprite Sheet image.
* @param frameWidth The fixed width of each frame of the animation.
* @param frameHeight The fixed height of each frame of the animation.
* @param frameMax The total number of animation frames to extact from the Sprite Sheet. The default value of -1 means "extract all frames". - Default: -1
* @param margin If the frames have been drawn with a margin, specify the amount here. - Default: 0
* @param spacing If the frames have been drawn with spacing between them, specify the amount here. - Default: 0
* @return A FrameData object containing the parsed frames.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static spriteSheet(game: Phaser.Game, key: string, frameWidth: number, frameHeight: number, frameMax?: number, margin?: number, spacing?: number): Phaser.FrameData;
/**
* Parse the XML data and extract the animation frame data from it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param xml The XML data from the Texture Atlas. Must be in Starling XML format.
* @param cacheKey The Game.Cache asset key of the texture image.
* @return A FrameData object containing the parsed frames.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static XMLData(game: Phaser.Game, xml: any, cacheKey: string): Phaser.FrameData;
}
/**
* Audio Sprites are a combination of audio files and a JSON configuration.
* The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite
*/
class AudioSprite {
/**
* Audio Sprites are a combination of audio files and a JSON configuration.
* The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Reference to the current game instance.
* @param key Asset key for the sound.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, key: string);
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* Asset key for the Audio Sprite.
*/
key: string;
/**
* JSON audio atlas object.
*/
config: any;
/**
* If a sound is set to auto play, this holds the marker key of it.
*/
autoplayKey: string;
/**
* Is a sound set to autoplay or not?
* Default: false
*/
autoplay: boolean;
/**
* An object containing the Phaser.Sound objects for the Audio Sprite.
*/
sounds: any;
/**
* Get a sound with the given name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param marker The name of sound to get.
* @return The sound instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
get(marker: string): Phaser.Sound;
/**
* Play a sound with the given name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param marker The name of sound to play
* @param volume Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified). - Default: 1
* @return This sound instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
play(marker: string, volume?: number): Phaser.Sound;
/**
* Stop a sound with the given name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param marker The name of sound to stop. If none is given it will stop all sounds in the audio sprite. - Default: ''
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
stop(marker: string): Phaser.Sound;
}
/**
* ArraySet is a Set data structure (items must be unique within the set) that also maintains order.
* This allows specific items to be easily added or removed from the Set.
*
* Item equality (and uniqueness) is determined by the behavior of `Array.indexOf`.
*
* This used primarily by the Input subsystem.
*/
class ArraySet {
/**
* ArraySet is a Set data structure (items must be unique within the set) that also maintains order.
* This allows specific items to be easily added or removed from the Set.
*
* Item equality (and uniqueness) is determined by the behavior of `Array.indexOf`.
*
* This used primarily by the Input subsystem.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param list The backing array: if specified the items in the list _must_ be unique, per `Array.indexOf`, and the ownership of the array _should_ be relinquished to the ArraySet. - Default: (new array)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(list: any[]);
/**
* Current cursor position as established by `first` and `next`.
* Default: 0
*/
position: number;
/**
* The backing array.
*/
list: any[];
/**
* Number of items in the ArraySet. Same as `list.length`.
*/
total: number;
/**
* Returns the first item and resets the cursor to the start.
*/
first: any;
/**
* Returns the the next item (based on the cursor) and advances the cursor.
*/
next: any;
/**
* Adds a new element to the end of the list.
* If the item already exists in the list it is not moved.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param item The element to add to this list.
* @return The item that was added.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(item: any): any;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Gets an item from the set based on the property strictly equaling the value given.
* Returns null if not found.
*
* @param property The property to check against the value.
* @param value The value to check if the property strictly equals.
* @return The item that was found, or null if nothing matched.
*/
getByKey(property: string, value: any): any;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Gets the index of the item in the list, or -1 if it isn't in the list.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param item The element to get the list index for.
* @return The index of the item or -1 if not found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getIndex(item: any): number;
/**
* Checks for the item within this list.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param item The element to get the list index for.
* @return True if the item is found in the list, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
exists(item: any): boolean;
/**
* Removes all the items.
*/
reset(): void;
/**
* Removes the given element from this list if it exists.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param item The item to be removed from the list.
* @return item - The item that was removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(item: any): any;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Removes every member from this ArraySet and optionally destroys it.
*
* @param destroy Call `destroy` on each member as it's removed from this set. - Default: false
*/
removeAll(destoy?: boolean): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Sets the property `key` to the given value on all members of this list.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param key The property of the item to set.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The value to set the property to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setAll(key: any, value: any): void;
/**
* Calls a function on all members of this list, using the member as the context for the callback.
*
* If the `key` property is present it must be a function.
* The function is invoked using the item as the context.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The name of the property with the function to call.
* @param args Additional parameters that will be passed to the callback.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
callAll(key: string, ...parameter: any[]): void;
}
/**
* Utility functions for dealing with Arrays.
*/
class ArrayUtils {
/**
* Fetch a random entry from the given array.
*
* Will return null if there are no array items that fall within the specified range
* or if there is no item for the randomly choosen index.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param objects An array of objects.
* @param startIndex Optional offset off the front of the array. Default value is 0, or the beginning of the array.
* @param length Optional restriction on the number of values you want to randomly select from.
* @return The random object that was selected.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getRandomItem<T>(objects: T[], startIndex?: number, length?: number): T;
/**
* Removes a random object from the given array and returns it.
*
* Will return null if there are no array items that fall within the specified range
* or if there is no item for the randomly choosen index.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param objects An array of objects.
* @param startIndex Optional offset off the front of the array. Default value is 0, or the beginning of the array.
* @param length Optional restriction on the number of values you want to randomly select from.
* @return The random object that was removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static removeRandomItem<T>(objects: T[], startIndex?: number, length?: number): T;
/**
* A standard Fisher-Yates Array shuffle implementation which modifies the array in place.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param array The array to shuffle.
* @return The original array, now shuffled.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static shuffle<T>(array: T[]): T[];
/**
* Transposes the elements of the given matrix (array of arrays).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param array The matrix to transpose.
* @return A new transposed matrix
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static transposeMatrix<T>(array: T[]): T;
/**
* Rotates the given matrix (array of arrays).
*
* Based on the routine from {@link http://jsfiddle.net/MrPolywhirl/NH42z/}.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param matrix The array to rotate; this matrix _may_ be altered.
* @param direction The amount to rotate: the roation in degrees (90, -90, 270, -270, 180) or a string command ('rotateLeft', 'rotateRight' or 'rotate180').
* @return The rotated matrix. The source matrix should be discarded for the returned matrix.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static rotateMatrix(matrix: any, direction: number): any;
/**
* Snaps a value to the nearest value in an array.
* The result will always be in the range `[first_value, last_value]`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The search value
* @param arr The input array which _must_ be sorted.
* @return The nearest value found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static findClosest(value: number, arr: number[]): number;
/**
* Moves the element from the start of the array to the end, shifting all items in the process.
* The "rotation" happens to the left.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param array The array to shift/rotate. The array is modified.
* @return The shifted value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static rotate(array: any[]): any;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Create an array representing the inclusive range of numbers (usually integers) in `[start, end]`.
* This is equivalent to `numberArrayStep(start, end, 1)`.
*
* @param start The minimum value the array starts with.
* @param end The maximum value the array contains.
* @return The array of number values.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
static numberArray(start: number, end: number): number[];
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Create an array of numbers (positive and/or negative) progressing from `start`
* up to but not including `end` by advancing by `step`.
*
* If `start` is less than `stop` a zero-length range is created unless a negative `step` is specified.
*
* Certain values for `start` and `end` (eg. NaN/undefined/null) are currently coerced to 0;
* for forward compatibility make sure to pass in actual numbers.
*
* @param start The start of the range.
* @param end The end of the range.
* @param step The value to increment or decrement by. - Default: 1
* @return Returns the new array of numbers.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
static numberArrayStep(start: number, end: number, step?: number): number[];
}
/**
* A BitmapData object contains a Canvas element to which you can draw anything you like via normal Canvas context operations.
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* A single BitmapData can be used as the texture for one or many Images/Sprites.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* So if you need to dynamically create a Sprite texture then they are a good choice.
*/
class BitmapData {
/**
* A BitmapData object contains a Canvas element to which you can draw anything you like via normal Canvas context operations.
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* A single BitmapData can be used as the texture for one or many Images/Sprites.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* So if you need to dynamically create a Sprite texture then they are a good choice.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param key Internal Phaser reference key for the render texture.
* @param width The width of the BitmapData in pixels. - Default: 256
* @param height The height of the BitmapData in pixels. - Default: 256
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, key: string, width?: number, height?: number);
/**
* The PIXI.BaseTexture.
*/
baseTexture: PIXI.BaseTexture;
buffer: ArrayBuffer;
/**
* The canvas to which this BitmapData draws.
*/
canvas: HTMLCanvasElement;
/**
* The 2d context of the canvas.
*/
context: CanvasRenderingContext2D;
/**
* A reference to BitmapData.context.
*/
ctx: CanvasRenderingContext2D;
/**
* A Uint8ClampedArray view into BitmapData.buffer.
*/
data: Uint8Array;
/**
* If dirty this BitmapData will be re-rendered.
*/
dirty: boolean;
/**
* If disableTextureUpload is true this BitmapData will never send its image data to the GPU when its dirty flag is true.
*/
disableTextureUpload: boolean;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* The height of the BitmapData in pixels.
*/
height: number;
/**
* The context image data.
*/
imageData: ImageData;
/**
* The key of the BitmapData in the Cache, if stored there.
*/
key: string;
/**
* An Uint32Array view into BitmapData.buffer.
*/
pixels: Uint32Array;
smoothed: boolean;
/**
* The PIXI.Texture.
*/
texture: PIXI.Texture;
/**
* The Frame this BitmapData uses for rendering.
*/
textureFrame: Phaser.Frame;
/**
* The const type of this object.
*/
type: number;
/**
* The width of the BitmapData in pixels.
*/
width: number;
/**
* Gets a JavaScript object that has 6 properties set that are used by BitmapData in a transform.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param translateX The x translate value.
* @param translateY The y translate value.
* @param scaleX The scale x value.
* @param scaleY The scale y value.
* @param skewX The skew x value.
* @param skewY The skew y value.
* @return A JavaScript object containing all of the properties BitmapData needs for transforms.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getTransform(translateX: number, translateY: number, scaleX: number, scaleY: number, skewX: number, skewY: number): any;
/**
* Updates the given objects so that they use this BitmapData as their texture. This will replace any texture they will currently have set.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object Either a single Sprite/Image or an Array of Sprites/Images.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(object: any): Phaser.BitmapData;
/**
* Creates a new Phaser.Image object, assigns this BitmapData to be its texture, adds it to the world then returns it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate to place the Image at. - Default: 0
* @param y The y coordinate to place the Image at. - Default: 0
* @param anchorX Set the x anchor point of the Image. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right. - Default: 0
* @param anchorY Set the y anchor point of the Image. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right. - Default: 0
* @param scaleX The horizontal scale factor of the Image. A value of 1 means no scaling. 2 would be twice the size, and so on. - Default: 1
* @param scaleY The vertical scale factor of the Image. A value of 1 means no scaling. 2 would be twice the size, and so on. - Default: 1
* @return The newly added Image object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addToWorld(x?: number, y?: number, anchorX?: number, anchorY?: number, scaleX?: number, scaleY?: number): Phaser.Image;
/**
* Draws the image onto this BitmapData using an image as an alpha mask.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The source to copy from. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself.
* @param mask The object to be used as the mask. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself. If you don't provide a mask it will use this BitmapData as the mask.
* @param sourceRect A Rectangle where x/y define the coordinates to draw the Source image to and width/height define the size.
* @param maskRect A Rectangle where x/y define the coordinates to draw the Mask image to and width/height define the size.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
alphaMask(source: any, mask?: any, sourceRect?: Phaser.Rectangle, maskRect?: Phaser.Rectangle): Phaser.BitmapData;
/**
* Sets the blend mode to 'lighter'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendAdd(): Phaser.BitmapData;
/**
* Sets the blend mode to 'color'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendColor(): Phaser.BitmapData;
/**
* Sets the blend mode to 'color-burn'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendColorBurn(): Phaser.BitmapData;
/**
* Sets the blend mode to 'color-dodge'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendColorDodge(): Phaser.BitmapData;
/**
* Sets the blend mode to 'darken'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendDarken(): Phaser.BitmapData;
/**
* Sets the blend mode to 'destination-atop'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendDestinationAtop(): Phaser.BitmapData;
/**
* Sets the blend mode to 'destination-in'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendDestinationIn(): Phaser.BitmapData;
/**
* Sets the blend mode to 'destination-out'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendDestinationOut(): Phaser.BitmapData;
/**
* Sets the blend mode to 'destination-over'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendDestinationOver(): Phaser.BitmapData;
/**
* Sets the blend mode to 'difference'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendDifference(): Phaser.BitmapData;
/**
* Sets the blend mode to 'exclusion'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendExclusion(): Phaser.BitmapData;
/**
* Sets the blend mode to 'hard-light'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendHardLight(): Phaser.BitmapData;
/**
* Sets the blend mode to 'hue'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendHue(): Phaser.BitmapData;
/**
* Sets the blend mode to 'lighten'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendLighten(): Phaser.BitmapData;
/**
* Sets the blend mode to 'luminosity'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendLuminosity(): Phaser.BitmapData;
/**
* Sets the blend mode to 'multiply'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendMultiply(): Phaser.BitmapData;
/**
* Sets the blend mode to 'overlay'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendOverlay(): Phaser.BitmapData;
/**
* Resets the blend mode (effectively sets it to 'source-over')
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendReset(): Phaser.BitmapData;
/**
* Sets the blend mode to 'saturation'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendSaturation(): Phaser.BitmapData;
/**
* Sets the blend mode to 'screen'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendScreen(): Phaser.BitmapData;
/**
* Sets the blend mode to 'soft-light'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendSoftLight(): Phaser.BitmapData;
/**
* Sets the blend mode to 'source-atop'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendSourceAtop(): Phaser.BitmapData;
/**
* Sets the blend mode to 'source-in'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendSourceIn(): Phaser.BitmapData;
/**
* Sets the blend mode to 'source-out'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendSourceOut(): Phaser.BitmapData;
/**
* Sets the blend mode to 'source-over'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendSourceOver(): Phaser.BitmapData;
/**
* Sets the blend mode to 'xor'
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
blendXor(): Phaser.BitmapData;
/**
* Draws a filled Circle to the BitmapData at the given x, y coordinates and radius in size.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate to draw the Circle at. This is the center of the circle.
* @param y The y coordinate to draw the Circle at. This is the center of the circle.
* @param radius The radius of the Circle in pixels. The radius is half the diameter.
* @param fillStyle If set the context fillStyle will be set to this value before the circle is drawn.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
circle(x: number, y: number, radius: number, fillStyle?: string): Phaser.BitmapData;
/**
* Clears the BitmapData context using a clearRect.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clear(): Phaser.BitmapData;
cls(): Phaser.BitmapData;
/**
* Copies a rectangular area from the source object to this BitmapData. If you give `null` as the source it will copy from itself.
* You can optionally resize, translate, rotate, scale, alpha or blend as it's drawn.
* All rotation, scaling and drawing takes place around the regions center point by default, but can be changed with the anchor parameters.
* Note that the source image can also be this BitmapData, which can create some interesting effects.
*
* This method has a lot of parameters for maximum control.
* You can use the more friendly methods like `copyRect` and `draw` to avoid having to remember them all.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The source to copy from. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself.
* @param x The x coordinate representing the top-left of the region to copy from the source image. - Default: 0
* @param y The y coordinate representing the top-left of the region to copy from the source image. - Default: 0
* @param width The width of the region to copy from the source image. If not specified it will use the full source image width.
* @param height The height of the region to copy from the source image. If not specified it will use the full source image height.
* @param tx The x coordinate to translate to before drawing. If not specified it will default to the `x` parameter. If `null` and `source` is a Display Object, it will default to `source.x`.
* @param ty The y coordinate to translate to before drawing. If not specified it will default to the `y` parameter. If `null` and `source` is a Display Object, it will default to `source.y`.
* @param newWidth The new width of the block being copied. If not specified it will default to the `width` parameter.
* @param newHeight The new height of the block being copied. If not specified it will default to the `height` parameter.
* @param rotate The angle in radians to rotate the block to before drawing. Rotation takes place around the center by default, but can be changed with the `anchor` parameters. - Default: 0
* @param anchorX The anchor point around which the block is rotated and scaled. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right. - Default: 0
* @param anchorY The anchor point around which the block is rotated and scaled. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right. - Default: 0
* @param scaleX The horizontal scale factor of the block. A value of 1 means no scaling. 2 would be twice the size, and so on. - Default: 1
* @param scaleY The vertical scale factor of the block. A value of 1 means no scaling. 2 would be twice the size, and so on. - Default: 1
* @param alpha The alpha that will be set on the context before drawing. A value between 0 (fully transparent) and 1, opaque. - Default: 1
* @param blendMode The composite blend mode that will be used when drawing. The default is no blend mode at all. - Default: null
* @param roundPx Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances. - Default: false
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copy(source?: any, x?: number, y?: number, width?: number, height?: number, tx?: number, ty?: number, newWidth?: number, newHeight?: number, rotate?: number, anchorX?: number, anchorY?: number, scaleX?: number, scaleY?: number, alpha?: number, blendMode?: number, roundPx?: boolean): Phaser.BitmapData;
copyPixels(source: any, area: Phaser.Rectangle, x: number, y: number, alpha?: number): void;
/**
* Copies the area defined by the Rectangle parameter from the source image to this BitmapData at the given location.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The Image to copy from. If you give a string it will try and find the Image in the Game.Cache.
* @param area The Rectangle region to copy from the source image.
* @param x The destination x coordinate to copy the image to.
* @param y The destination y coordinate to copy the image to.
* @param alpha The alpha that will be set on the context before drawing. A value between 0 (fully transparent) and 1, opaque. - Default: 1
* @param blendMode The composite blend mode that will be used when drawing. The default is no blend mode at all. - Default: null
* @param roundPx Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances. - Default: false
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copyRect(source: any, area: Phaser.Rectangle, x?: number, y?: number, alpha?: number, blendMode?: number, roundPx?: boolean): Phaser.BitmapData;
/**
* Draws the given Phaser.Sprite, Phaser.Image or Phaser.Text to this BitmapData at the coordinates specified.
* You can use the optional width and height values to 'stretch' the sprite as it is drawn. This uses drawImage stretching, not scaling.
* When drawing it will take into account the Sprites rotation, scale and alpha values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The Sprite, Image or Text object to draw onto this BitmapData.
* @param x The x coordinate to translate to before drawing. If not specified it will default to `source.x`. - Default: 0
* @param y The y coordinate to translate to before drawing. If not specified it will default to `source.y`. - Default: 0
* @param width The new width of the Sprite being copied. If not specified it will default to `source.width`.
* @param height The new height of the Sprite being copied. If not specified it will default to `source.height`.
* @param blendMode The composite blend mode that will be used when drawing the Sprite. The default is no blend mode at all. - Default: null
* @param roundPx Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances. - Default: false
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
draw(source: any, x?: number, y?: number, width?: number, height?: number, blendMode?: number, roundPx?: boolean): Phaser.BitmapData;
/**
* Draws the immediate children of a Phaser.Group to this BitmapData.
* Children are only drawn if they have their `exists` property set to `true`.
* The children will be drawn at their `x` and `y` world space coordinates. If this is outside the bounds of the BitmapData they won't be drawn.
* When drawing it will take into account the child's rotation, scale and alpha values.
* No iteration takes place. Groups nested inside other Groups will not be iterated through.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param group The Group to draw onto this BitmapData.
* @param blendMode The composite blend mode that will be used when drawing the Group children. The default is no blend mode at all. - Default: null
* @param roundPx Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances. - Default: false
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
drawGroup(group: Phaser.Group, blendMode?: number, roundPx?: boolean): Phaser.BitmapData;
/**
* Scans this BitmapData for all pixels matching the given r,g,b values and then draws them into the given destination BitmapData.
* The original BitmapData remains unchanged.
* The destination BitmapData must be large enough to receive all of the pixels that are scanned unless the 'resize' parameter is true.
* Although the destination BitmapData is returned from this method, it's actually modified directly in place, meaning this call is perfectly valid:
* `picture.extract(mask, r, g, b)`
* You can specify optional r2, g2, b2 color values. If given the pixel written to the destination bitmap will be of the r2, g2, b2 color.
* If not given it will be written as the same color it was extracted. You can provide one or more alternative colors, allowing you to tint
* the color during extraction.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param destination The BitmapData that the extracted pixels will be drawn to.
* @param r The red color component, in the range 0 - 255.
* @param g The green color component, in the range 0 - 255.
* @param b The blue color component, in the range 0 - 255.
* @param a The alpha color component, in the range 0 - 255 that the new pixel will be drawn at. - Default: 255
* @param resize Should the destination BitmapData be resized to match this one before the pixels are copied? - Default: false
* @param r2 An alternative red color component to be written to the destination, in the range 0 - 255.
* @param g2 An alternative green color component to be written to the destination, in the range 0 - 255.
* @param b2 An alternative blue color component to be written to the destination, in the range 0 - 255.
* @return The BitmapData that the extract pixels were drawn on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
extract(destination: Phaser.BitmapData, r: number, g: number, b: number, a?: number, resize?: boolean, r2?: number, g2?: number, b2?: number): Phaser.BitmapData;
/**
* Fills the BitmapData with the given color.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r The red color value, between 0 and 0xFF (255).
* @param g The green color value, between 0 and 0xFF (255).
* @param b The blue color value, between 0 and 0xFF (255).
* @param a The alpha color value, between 0 and 1. - Default: 1
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fill(r: number, g: number, b: number, a?: number): Phaser.BitmapData;
/**
* Scans the BitmapData and calculates the bounds. This is a rectangle that defines the extent of all non-transparent pixels.
* The rectangle returned will extend from the top-left of the image to the bottom-right, exluding transparent pixels.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rect If provided this Rectangle object will be populated with the bounds, otherwise a new object will be created.
* @return A Rectangle whose dimensions encompass the full extent of non-transparent pixels in this BitmapData.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getBounds(rect?: Phaser.Rectangle): Phaser.Rectangle;
/**
* Scans the BitmapData, pixel by pixel, until it encounters a pixel that isn't transparent (i.e. has an alpha value > 0).
* It then stops scanning and returns an object containing the colour of the pixel in r, g and b properties and the location in the x and y properties.
*
* The direction parameter controls from which direction it should start the scan:
*
* 0 = top to bottom
* 1 = bottom to top
* 2 = left to right
* 3 = right to left
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param direction The direction in which to scan for the first pixel. 0 = top to bottom, 1 = bottom to top, 2 = left to right and 3 = right to left. - Default: 0
* @return Returns an object containing the colour of the pixel in the `r`, `g` and `b` properties and the location in the `x` and `y` properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFirstPixel(direction: number): { r: number; g: number; b: number; x: number; y: number; };
/**
* Get the color of a specific pixel in the context into a color object.
* If you have drawn anything to the BitmapData since it was created you must call BitmapData.update to refresh the array buffer,
* otherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @param y The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @param out An object into which 4 properties will be created: r, g, b and a. If not provided a new object will be created.
* @return An object with the red, green, blue and alpha values set in the r, g, b and a properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getPixel(x: number, y: number, out?: any): number;
/**
* Get the color of a specific pixel including its alpha value as a color object containing r,g,b,a and rgba properties.
* If you have drawn anything to the BitmapData since it was created you must call BitmapData.update to refresh the array buffer,
* otherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @param y The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @param out An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.
* @param hsl Also convert the rgb values into hsl? - Default: false
* @param hsv Also convert the rgb values into hsv? - Default: false
* @return An object with the red, green and blue values set in the r, g and b properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getPixelRGB(x: number, y: number, out?: any, hsl?: boolean, hsv?: boolean): any;
/**
* Get the color of a specific pixel including its alpha value.
* If you have drawn anything to the BitmapData since it was created you must call BitmapData.update to refresh the array buffer,
* otherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.
* Note that on little-endian systems the format is 0xAABBGGRR and on big-endian the format is 0xRRGGBBAA.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @param y The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @return A native color value integer (format: 0xAARRGGBB)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getPixel32(x: number, y: number): number;
/**
* Gets all the pixels from the region specified by the given Rectangle object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rect The Rectangle region to get.
* @return Returns a ImageData object containing a Uint8ClampedArray data property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getPixels(rect: Phaser.Rectangle): ImageData;
/**
* Gets a JavaScript object that has 6 properties set that are used by BitmapData in a transform.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param translateX The x translate value.
* @param translateY The y translate value.
* @param scaleX The scale x value.
* @param scaleY The scale y value.
* @param skewX The skew x value.
* @param skewY The skew y value.
* @return A JavaScript object containing all of the properties BitmapData needs for transforms.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTransform(translateX: number, translateY: number, scaleX: number, scaleY: number, skewX: number, skewY: number): any;
/**
* Takes the given Game Object, resizes this BitmapData to match it and then draws it into this BitmapDatas canvas, ready for further processing.
* The source game object is not modified by this operation.
* If the source object uses a texture as part of a Texture Atlas or Sprite Sheet, only the current frame will be used for sizing.
* If a string is given it will assume it's a cache key and look in Phaser.Cache for an image key matching the string.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The object that will be used to populate this BitmapData. If you give a string it will try and find the Image in the Game.Cache first.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
load(source: any): Phaser.BitmapData;
/**
* Scans through the area specified in this BitmapData and sends the color for every pixel to the given callback along with its x and y coordinates.
* Whatever value the callback returns is set as the new color for that pixel, unless it returns the same color, in which case it's skipped.
* Note that the format of the color received will be different depending on if the system is big or little endian.
* It is expected that your callback will deal with endianess. If you'd rather Phaser did it then use processPixelRGB instead.
* The callback will also be sent the pixels x and y coordinates respectively.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The callback that will be sent each pixel color to be processed.
* @param callbackContext The context under which the callback will be called.
* @param x The x coordinate of the top-left of the region to process from. - Default: 0
* @param y The y coordinate of the top-left of the region to process from. - Default: 0
* @param width The width of the region to process.
* @param height The height of the region to process.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processPixel(callback: Function, callbackContext: any, x?: number, y?: Number, width?: number, height?: number): Phaser.BitmapData;
/**
* Scans through the area specified in this BitmapData and sends a color object for every pixel to the given callback.
* The callback will be sent a color object with 6 properties: `{ r: number, g: number, b: number, a: number, color: number, rgba: string }`.
* Where r, g, b and a are integers between 0 and 255 representing the color component values for red, green, blue and alpha.
* The `color` property is an Int32 of the full color. Note the endianess of this will change per system.
* The `rgba` property is a CSS style rgba() string which can be used with context.fillStyle calls, among others.
* The callback will also be sent the pixels x and y coordinates respectively.
* The callback must return either `false`, in which case no change will be made to the pixel, or a new color object.
* If a new color object is returned the pixel will be set to the r, g, b and a color values given within it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The callback that will be sent each pixel color object to be processed.
* @param callbackContext The context under which the callback will be called.
* @param x The x coordinate of the top-left of the region to process from. - Default: 0
* @param y The y coordinate of the top-left of the region to process from. - Default: 0
* @param width The width of the region to process.
* @param height The height of the region to process.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processPixelRGB(callback: Function, callbackContext: any, x?: number, y?: Number, width?: number, height?: number): Phaser.BitmapData;
/**
* Draws a filled Rectangle to the BitmapData at the given x, y coordinates and width / height in size.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the top-left of the Rectangle.
* @param y The y coordinate of the top-left of the Rectangle.
* @param width The width of the Rectangle.
* @param height The height of the Rectangle.
* @param fillStyle If set the context fillStyle will be set to this value before the rect is drawn.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
rect(x: number, y: number, width: number, height: number, fillStyle?: string): Phaser.BitmapData;
/**
* If the game is running in WebGL this will push the texture up to the GPU if it's dirty.
* This is called automatically if the BitmapData is being used by a Sprite, otherwise you need to remember to call it in your render function.
* If you wish to suppress this functionality set BitmapData.disableTextureUpload to `true`.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
render(): Phaser.BitmapData;
/**
* Replaces all pixels matching one color with another. The color values are given as two sets of RGBA values.
* An optional region parameter controls if the replacement happens in just a specific area of the BitmapData or the entire thing.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r1 The red color value to be replaced. Between 0 and 255.
* @param g1 The green color value to be replaced. Between 0 and 255.
* @param b1 The blue color value to be replaced. Between 0 and 255.
* @param a1 The alpha color value to be replaced. Between 0 and 255.
* @param r2 The red color value that is the replacement color. Between 0 and 255.
* @param g2 The green color value that is the replacement color. Between 0 and 255.
* @param b2 The blue color value that is the replacement color. Between 0 and 255.
* @param a2 The alpha color value that is the replacement color. Between 0 and 255.
* @param region The area to perform the search over. If not given it will replace over the whole BitmapData.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
replaceRGB(r1: number, g1: number, b1: number, a1: number, r2: number, g2: number, b2: number, a2: number, region: Phaser.Rectangle): Phaser.BitmapData;
/**
* Resizes the BitmapData. This changes the size of the underlying canvas and refreshes the buffer.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
resize(width: number, height: number): Phaser.BitmapData;
/**
* Sets the hue, saturation and lightness values on every pixel in the given region, or the whole BitmapData if no region was specified.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param h The hue, in the range 0 - 1. - Default: null
* @param s The saturation, in the range 0 - 1. - Default: null
* @param l The lightness, in the range 0 - 1. - Default: null
* @param region The area to perform the operation on. If not given it will run over the whole BitmapData.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setHSL(h?: number, s?: number, l?: number, region?: Phaser.Rectangle): Phaser.BitmapData;
/**
* Sets the color of the given pixel to the specified red, green and blue values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @param y The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @param red The red color value, between 0 and 0xFF (255).
* @param green The green color value, between 0 and 0xFF (255).
* @param blue The blue color value, between 0 and 0xFF (255).
* @param alpha The alpha color value, between 0 and 0xFF (255).
* @param immediate If `true` the context.putImageData will be called and the dirty flag set. - Default: true
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setPixel(x: number, y: number, red: number, green: number, blue: number, immediate?: boolean): Phaser.BitmapData;
/**
* Sets the color of the given pixel to the specified red, green, blue and alpha values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @param y The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
* @param red The red color value, between 0 and 0xFF (255).
* @param green The green color value, between 0 and 0xFF (255).
* @param blue The blue color value, between 0 and 0xFF (255).
* @param alpha The alpha color value, between 0 and 0xFF (255).
* @param immediate If `true` the context.putImageData will be called and the dirty flag set. - Default: true
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setPixel32(x: number, y: number, red: number, green: number, blue: number, alpha: number, immediate?: boolean): Phaser.BitmapData;
/**
* Sets the shadow properties of this BitmapDatas context which will affect all draw operations made to it.
* You can cancel an existing shadow by calling this method and passing no parameters.
* Note: At the time of writing (October 2014) Chrome still doesn't support shadowBlur used with drawImage.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color The color of the shadow, given in a CSS format, i.e. `#000000` or `rgba(0,0,0,1)`. If `null` or `undefined` the shadow will be reset.
* @param blur The amount the shadow will be blurred by. Low values = a crisp shadow, high values = a softer shadow. - Default: 5
* @param x The horizontal offset of the shadow in pixels. - Default: 10
* @param y The vertical offset of the shadow in pixels. - Default: 10
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
shadow(color: string, blur?: number, x?: number, y?: number): Phaser.BitmapData;
/**
* Shifts any or all of the hue, saturation and lightness values on every pixel in the given region, or the whole BitmapData if no region was specified.
* Shifting will add the given value onto the current h, s and l values, not replace them.
* The hue is wrapped to keep it within the range 0 to 1. Saturation and lightness are clamped to not exceed 1.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param h The amount to shift the hue by. - Default: null
* @param s The amount to shift the saturation by. - Default: null
* @param l The amount to shift the lightness by. - Default: null
* @param region The area to perform the operation on. If not given it will run over the whole BitmapData.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
shiftHSL(h?: number, s?: number, l?: number, region?: Phaser.Rectangle): Phaser.BitmapData;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Draws text to the BitmapData in the given font and color.
* The default font is 14px Courier, so useful for quickly drawing debug text.
* If you need to do a lot of font work to this BitmapData we'd recommend implementing your own text draw method.
*
* @param text The text to write to the BitmapData.
* @param x The x coordinate of the top-left of the text string.
* @param y The y coordinate of the top-left of the text string.
* @param font The font. This is passed directly to Context.font, so anything that can support, this can. - Default: '14px Courier'
* @param color The color the text will be drawn in. - Default: 'rgb(255,255,255)'
* @param shadow Draw a single pixel black shadow below the text (offset by text.x/y + 1) - Default: true
* @return This BitmapData object for method chaining.
*/
text(text: string, x?: number, y?: number, font?: string, color?: string, shadow?: boolean): Phaser.BitmapData;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Takes the given Line object and image and renders it to this BitmapData as a repeating texture line.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param line A Phaser.Line object that will be used to plot the start and end of the line.
* @param image The key of an image in the Phaser.Cache to use as the texture for this line, or an actual Image.
* @param repeat The pattern repeat mode to use when drawing the line. Either `repeat`, `repeat-x` or `no-repeat`. - Default: 'repeat-x'
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
textureLine(line: Phaser.Line, key: string, repeat?: string): Phaser.BitmapData;
/**
* This re-creates the BitmapData.imageData from the current context.
* It then re-builds the ArrayBuffer, the data Uint8ClampedArray reference and the pixels Int32Array.
* If not given the dimensions defaults to the full size of the context.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the top-left of the image data area to grab from. - Default: 0
* @param y The y coordinate of the top-left of the image data area to grab from. - Default: 0
* @param width The width of the image data area.
* @param height The height of the image data area.
* @return This BitmapData object for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
update(x?: number, y?: number, width?: number, height?: number): Phaser.BitmapData;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* BitmapText objects work by taking a texture file and an XML file that describes the font structure.
* It then generates a new Sprite object for each letter of the text, proportionally spaced out and aligned to
* match the font structure.
*
* BitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability
* to use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by
* processing the font texture in an image editor, applying fills and any other effects required.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* To create a BitmapText you can use:
*
* BMFont (Windows, free): http://www.angelcode.com/products/bmfont/
* Glyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner
* Littera (Web-based, free): http://kvazars.com/littera/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class BitmapText extends PIXI.BitmapText {
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* BitmapText objects work by taking a texture file and an XML file that describes the font structure.
* It then generates a new Sprite object for each letter of the text, proportionally spaced out and aligned to
* match the font structure.
*
* BitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability
* to use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by
* processing the font texture in an image editor, applying fills and any other effects required.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* To create a BitmapText you can use:
*
* BMFont (Windows, free): http://www.angelcode.com/products/bmfont/
* Glyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner
* Littera (Web-based, free): http://kvazars.com/littera/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param x X position of the new bitmapText object.
* @param y Y position of the new bitmapText object.
* @param font The key of the BitmapFont as stored in Game.Cache.
* @param text The actual text that will be rendered. Can be set later via BitmapText.text. - Default: ''
* @param size The size the font will be rendered in, in pixels. - Default: 32
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, x: number, y: number, font: string, text?: string, size?: number);
/**
* Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.
*/
align: string;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angle property is the rotation of the Game Object in *degrees* from its original orientation.
*
* Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
*
* Values outside this range are added to or subtracted from 360 to obtain a value within the range.
* For example, the statement player.angle = 450 is the same as player.angle = 90.
*
* If you wish to work in radians instead of degrees you can use the property `rotation` instead.
* Working in radians is slightly faster as it doesn't have to perform any calculations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if `fixedToCamera` is true.
*
* The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraOffset: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* As a Game Object runs through its destroy method this flag is set to true,
* and can be checked in any sub-systems or plugins it is being destroyed from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroyPhase: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
* Game Object, or any of its components.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
events: Phaser.Events;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Controls if this Game Object is processed by the core game loop.
* If this Game Object has a physics body it also controls if its physics body is updated or not.
* When `exists` is set to `false` it will remove its physics body from the physics world if it has one.
* It also toggles the `visible` property to false as well.
*
* Setting `exists` to true will add its physics body back in to the physics world, if it has one.
* It will also set the `visible` property to `true`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
exists: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object that is "fixed" to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.
*
* The values are adjusted at the rendering stage, overriding the Game Objects actual world position.
*
* The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
* the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
* regardless where in the world the camera is.
*
* The offsets are stored in the `cameraOffset` property.
*
* Note that the `cameraOffset` values are in addition to any parent of this Game Object on the display list.
*
* Be careful not to set `fixedToCamera` on Game Objects which are in Groups that already have `fixedToCamera` enabled on them.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fixedToCamera: boolean;
/**
* The font the text will be rendered in, i.e. 'Arial'. Must be loaded in the browser before use.
*/
font: string;
/**
* The size of the font in pixels.
*/
fontSize: number;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The Input Handler for this Game Object.
*
* By default it is disabled. If you wish this Game Object to process input events you should enable it with: `inputEnabled = true`.
*
* After you have done this, this property will be a reference to the Phaser InputHandler.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
input: Phaser.InputHandler;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* By default a Game Object won't process any input events. By setting `inputEnabled` to true a Phaser.InputHandler is created
* for this Game Object and it will then start to process click / touch events and more.
*
* You can then access the Input Handler via `this.input`.
*
* Note that Input related events are dispatched from `this.events`, i.e.: `events.onInputDown`.
*
* If you set this property to false it will stop the Input Handler from processing any more input events.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inputEnabled: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A user defined name given to this Game Object.
* This value isn't ever used internally by Phaser, it is meant as a game level property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
name: string;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The const physics body type of this object.
*/
physicsType: number;
/**
* The position the Game Object was located in the previous frame.
*/
previousPosition: Phaser.Point;
/**
* The rotation the Game Object was in set to in the previous frame. Value is in radians.
*/
previousRotation: Phaser.Point;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The coordinate of the object relative to the local coordinates of the parent.
*/
position: Phaser.Point;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The render order ID is used internally by the renderer and Input Manager and should not be modified.
* This property is mostly used internally by the renderers, but is exposed for the use of plugins.
*/
renderOrderID: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The text string to be displayed by this Text object, taking into account the style settings.
*/
text: string;
/**
* The tint applied to the BitmapText. This is a hex value. Set to white to disable (0xFFFFFF)
*/
tint: number;
/**
* The const type of this object.
*/
type: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The world coordinates of this Game Object in pixels.
* Depending on where in the display list this Game Object is placed this value can differ from `position`,
* which contains the x/y coordinates relative to the Game Objects parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
world: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The z depth of this Game Object within its parent Group.
* No two objects in a Group can have the same z value.
* This value is adjusted automatically whenever the Group hierarchy changes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
z: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Destroy this DisplayObject.
* Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(destroyChildren?: boolean): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Automatically called by World.preUpdate.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
postUpdate(): void;
/**
* Automatically called by World.preUpdate.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @return True if the BitmapText was rendered, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
preUpdate(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Override this method in your own custom objects to handle any update requirements.
* It is called immediately after `preUpdate` and before `postUpdate`.
* Remember if this Game Object has any children you should call update on those too.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(): void;
/**
* Renders text and updates it when needed
*/
updateText(): void;
/**
* Updates the transform of this object
*/
updateTransform(): void;
}
/**
* Create a new `Button` object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically.
*
* The four states a Button responds to are:
*
* * 'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.
* * 'Out' - when the Pointer that was previously over the Button moves out of it.
* * 'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse.
* * 'Up' - when the Pointer that was pressed down on the Button is released again.
*
* A different texture/frame and activation sound can be specified for any of the states.
*
* Frames can be specified as either an integer (the frame ID) or a string (the frame name); the same values that can be used with a Sprite constructor.
*/
class Button extends Phaser.Image {
/**
* Create a new `Button` object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically.
*
* The four states a Button responds to are:
*
* * 'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.
* * 'Out' - when the Pointer that was previously over the Button moves out of it.
* * 'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse.
* * 'Up' - when the Pointer that was pressed down on the Button is released again.
*
* A different texture/frame and activation sound can be specified for any of the states.
*
* Frames can be specified as either an integer (the frame ID) or a string (the frame name); the same values that can be used with a Sprite constructor.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Current game instance.
* @param x X position of the Button. - Default: 0
* @param y Y position of the Button. - Default: 0
* @param key The image key (in the Game.Cache) to use as the texture for this Button.
* @param callback The function to call when this Button is pressed.
* @param callbackContext The context in which the callback will be called (usually 'this').
* @param overFrame The frame / frameName when the button is in the Over state.
* @param outFrame The frame / frameName when the button is in the Out state.
* @param downFrame The frame / frameName when the button is in the Down state.
* @param upFrame The frame / frameName when the button is in the Up state.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, x?: number, y?: number, key?: string, callback?: Function, callbackContext?: any, overFrame?: string|number, outFrame?: string|number, downFrame?: string|number, upFrame?: string|number);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* When the Button is touched / clicked and then released you can force it to enter a state of "out" instead of "up".
* Default: false
*/
forceOut: boolean;
/**
* When true the the texture frame will not be automatically switched on up/down/over/out events.
* Default: false
*/
freezeFrames: boolean;
/**
* The Sound to be played when this Buttons Down state is activated.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
onDownSound: Phaser.Sound|Phaser.AudioSprite;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The Sound Marker used in conjunction with the onDownSound.
*/
onDownSoundMarker: string;
/**
* The Signal (or event) dispatched when this Button is in an Down state.
*/
onInputDown: Phaser.Signal;
/**
* The Signal (or event) dispatched when this Button is in an Out state.
*/
onInputOut: Phaser.Signal;
/**
* The Signal (or event) dispatched when this Button is in an Over state.
*/
onInputOver: Phaser.Signal;
/**
* The Signal (or event) dispatched when this Button is in an Up state.
*/
onInputUp: Phaser.Signal;
/**
* The Sound to be played when this Buttons Out state is activated.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
onOutSound: Phaser.Sound|Phaser.AudioSprite;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The Sound Marker used in conjunction with the onOutSound.
*/
onOutSoundMarker: string;
/**
* The Sound to be played when this Buttons Over state is activated.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
onOverSound: Phaser.Sound|Phaser.AudioSprite;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The Sound Marker used in conjunction with the onOverSound.
*/
onOverSoundMarker: string;
/**
* If true then onOver events (such as onOverSound) will only be triggered if the Pointer object causing them was the Mouse Pointer.
* The frame will still be changed as applicable.
* Default: false
*/
onOverMouseOnly: boolean;
/**
* The Sound to be played when this Buttons Up state is activated.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
onUpSound: Phaser.Sound|Phaser.AudioSprite;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
onUpSoundMaker: string;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The const physics body type of this object.
*/
physicsType: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The Phaser Object Type.
*/
type: number;
/**
* Clears all of the frames set on this Button.
*/
clearFrames(): void;
/**
* The Sound to be played when a Pointer presses down on this Button.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sound The Sound that will be played.
* @param marker A Sound Marker that will be used in the playback.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setDownSound(sound: Phaser.Sound|Phaser.AudioSprite, marker?: string): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Used to manually set the frames that will be used for the different states of the Button.
*
* Frames can be specified as either an integer (the frame ID) or a string (the frame name); these are the same values that can be used with a Sprite constructor.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param overFrame The frame / frameName when the button is in the Over state.
* @param outFrame The frame / frameName when the button is in the Out state.
* @param downFrame The frame / frameName when the button is in the Down state.
* @param upFrame The frame / frameName when the button is in the Up state.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setFrames(overFrame?: string|number, outFrame?: string|number, downFrame?: string|number, upFrame?: string|number): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Internal function that handles input events.
*
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
* @param sprite The Button that the event occurred on.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointer The Pointer that activated the Button.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onInputDownHandler(sprite: Phaser.Button, pointer: Phaser.Pointer): void;
/**
* Internal function that handles input events.
*
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
* @param sprite The Button that the event occurred on.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointer The Pointer that activated the Button.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onInputUpHandler(sprite: Phaser.Button, pointer: Phaser.Pointer, isOver: boolean): void;
/**
* Called when this Button is removed from the World.
*/
removedFromWorld(): void;
/**
* The Sound to be played when a Pointer moves out of this Button.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sound The Sound that will be played.
* @param marker A Sound Marker that will be used in the playback.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setOutSound(sound: Phaser.Sound|Phaser.AudioSprite, marker?: string): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The Sound to be played when a Pointer moves over this Button.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sound The Sound that will be played.
* @param marker A Sound Marker that will be used in the playback.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setOverSound(sound: Phaser.Sound|Phaser.AudioSprite, marker?: string): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Sets the sounds to be played whenever this Button is interacted with. Sounds can be either full Sound objects, or markers pointing to a section of a Sound object.
* The most common forms of sounds are 'hover' effects and 'click' effects, which is why the order of the parameters is overSound then downSound.
*
* Call this function with no parameters to reset all sounds on this Button.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param overSound Over Button Sound.
* @param overMarker Over Button Sound Marker.
* @param downSound Down Button Sound.
* @param downMarker Down Button Sound Marker.
* @param outSound Out Button Sound.
* @param outMarker Out Button Sound Marker.
* @param upSound Up Button Sound.
* @param upMarker Up Button Sound Marker.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setSounds(overSound?: Phaser.Sound|Phaser.AudioSprite, overMarker?: string, downSound?: Phaser.Sound|Phaser.AudioSprite, downMarker?: string, outSound?: Phaser.Sound|Phaser.AudioSprite, outMarker?: string, upSound?: Phaser.Sound|Phaser.AudioSprite, upMarker?: string): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
setState(newState: number): void;
/**
* The Sound to be played when a Pointer has pressed down and is released from this Button.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sound The Sound that will be played.
* @param marker A Sound Marker that will be used in the playback.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setUpSound(sound: Phaser.Sound|Phaser.AudioSprite, marker?: string): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
/**
* A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds
* and data files as a result of Loader calls. Cached items use string based keys for look-up.
*/
class Cache {
/**
* A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds
* and data files as a result of Loader calls. Cached items use string based keys for look-up.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
static BINARY: number;
static BITMAPDATA: number;
static BITMAPFONT: number;
static CANVAS: number;
static IMAGE: number;
static JSON: number;
static PHYSICS: number;
static SOUND: number;
static TEXT: number;
static TEXTURE: number;
static TILEMAP: number;
static XML: number;
/**
* Automatically resolve resource URLs to absolute paths for use with the Cache.getURL method.
*/
autoResolveURL: boolean;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* This event is dispatched when the sound system is unlocked via a touch event on cellular devices.
*/
onSoundUnlock: Phaser.Signal;
/**
* Add a binary object in to the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for this binary data.
* @param binaryData The binary object to be addded to the cache.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addBinary(key: string, binaryData: any): void;
/**
* Add a BitmapData object to the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for this BitmapData.
* @param bitmapData The BitmapData object to be addded to the cache.
* @param frameData Optional FrameData set associated with the given BitmapData. If not specified (or `undefined`) a new FrameData object is created containing the Bitmap's Frame. If `null` is supplied then no FrameData will be created. - Default: (auto create)
* @return The BitmapData object to be addded to the cache.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addBitmapData(key: string, bitmapData: Phaser.BitmapData, frameData?: Phaser.FrameData): Phaser.BitmapData;
/**
* Add a new Bitmap Font to the Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The unique key by which you will reference this object.
* @param url URL of this font xml file.
* @param data Extra font data.
* @param xmlData Texture atlas frames data.
* @param xSpacing If you'd like to add additional horizontal spacing between the characters then set the pixel value here. - Default: 0
* @param ySpacing If you'd like to add additional vertical spacing between the lines then set the pixel value here. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addBitmapFont(key: string, texture: Phaser.RetroFont): void;
/**
* Add a new Bitmap Font to the Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The unique key by which you will reference this object.
* @param url URL of this font xml file.
* @param data Extra font data.
* @param xmlData Texture atlas frames data.
* @param xSpacing If you'd like to add additional horizontal spacing between the characters then set the pixel value here. - Default: 0
* @param ySpacing If you'd like to add additional vertical spacing between the lines then set the pixel value here. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addBitmapFont(key: string, url: string, data: any, xmlData: any, xSpacing?: number, ySpacing?: number): void;
/**
* Add a new canvas object in to the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for this canvas.
* @param canvas Canvas DOM element.
* @param context Render context of this canvas.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addCanvas(key: string, canvas: HTMLCanvasElement, context: CanvasRenderingContext2D): void;
/**
* Adds a default image to be used in special cases such as WebGL Filters. Is mapped to the key __default.
*/
addDefaultImage(): void;
/**
* Adds an Image file into the Cache. The file must have already been loaded, typically via Phaser.Loader, but can also have been loaded into the DOM.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If an image already exists in the cache with the same key then it is removed and destroyed, and the new image inserted in its place.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The unique key by which you will reference this object.
* @param url URL of this image file.
* @param data Extra image data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addImage(key: string, url: string, data: any): void;
/**
* Add a new json object into the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the json data.
* @param url URL of this json data file.
* @param data Extra json data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addJSON(key: string, urL: string, data: any): void;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Adds an image to be used when a key is wrong / missing. Is mapped to the key __missing.
*/
addMissingImage(): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Add a new physics data object to the Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The unique key by which you will reference this object.
* @param url URL of the physics json data.
* @param JSONData The physics data object (a JSON file).
* @param format The format of the physics data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addPhysicsData(key: string, url: string, JSONData: any, format: number): void;
/**
* Add a new Phaser.RenderTexture in to the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The unique key by which you will reference this object.
* @param texture The texture to use as the base of the RenderTexture.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addRenderTexture(key: string, texture: RenderTexture): void;
/**
* Adds a Sound file into the Cache. The file must have already been loaded, typically via Phaser.Loader.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the sound.
* @param url URL of this sound file.
* @param data Extra sound data.
* @param webAudio True if the file is using web audio.
* @param audioTag True if the file is using legacy HTML audio.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addSound(key: string, url: string, data: any, webAudio: boolean, audioTag: boolean): void;
/**
* Add a new sprite sheet in to the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The unique key by which you will reference this object.
* @param url URL of this sprite sheet file.
* @param data Extra sprite sheet data.
* @param frameWidth Width of the sprite sheet.
* @param frameHeight Height of the sprite sheet.
* @param frameMax How many frames stored in the sprite sheet. If -1 then it divides the whole sheet evenly. - Default: -1
* @param margin If the frames have been drawn with a margin, specify the amount here. - Default: 0
* @param spacing If the frames have been drawn with spacing between them, specify the amount here. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addSpriteSheet(key: string, url: string, data: any, frameWidth: number, frameHeight: number, frameMax?: number, margin?: number, spacing?: number): void;
/**
* Add a new text data.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the text data.
* @param url URL of this text data file.
* @param data Extra text data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addText(key: string, url: string, data: any): void;
/**
* Add a new texture atlas to the Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The unique key by which you will reference this object.
* @param url URL of this texture atlas file.
* @param data Extra texture atlas data.
* @param atlasData Texture atlas frames data.
* @param format The format of the texture atlas.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addTextureAtlas(key: string, url: string, data: any, atlasData: any, format: number): void;
/**
* Add a new tilemap to the Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The unique key by which you will reference this object.
* @param url URL of the tilemap image.
* @param mapData The tilemap data object (either a CSV or JSON file).
* @param format The format of the tilemap data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addTilemap(key: string, url: string, mapData: any, format: number): void;
/**
* Add a new xml object into the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the xml file.
* @param url URL of this xml file.
* @param data Extra text data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addXML(key: string, url: string, data: any): void;
/**
* Checks if the given key exists in the Binary Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the binary file to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkBinaryKey(key: string): boolean;
/**
* Checks if the given key exists in the BitmapData Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the BitmapData to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkBitmapDataKey(key: string): boolean;
/**
* Checks if the given key exists in the BitmapFont Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the BitmapFont to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkBitmapFontKey(key: string): boolean;
/**
* Checks if the given key exists in the Canvas Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the canvas to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkCanvasKey(key: string): boolean;
/**
* Checks if the given key exists in the Image Cache. Note that this also includes Texture Atlases, Sprite Sheets and Retro Fonts.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the image to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkImageKey(key: string): boolean;
/**
* Checks if the given key exists in the JSON Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the JSON file to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkJSONKey(key: string): boolean;
/**
* Checks if a key for the given cache object type exists.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param type The Cache type to check against. I.e. Phaser.Cache.CANVAS, Phaser.Cache.IMAGE, Phaser.Cache.JSON, etc.
* @param key Asset key of the image to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkKey(type: number, key: string): boolean;
/**
* Checks if the given key exists in the Physics Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the physics data file to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkPhysicsKey(key: string): boolean;
/**
* Checks if the given key exists in the Sound Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the sound file to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkSoundKey(key: string): boolean;
/**
* Checks if the given key exists in the Text Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the text file to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkTextKey(key: string): boolean;
/**
* Checks if the given key exists in the Texture Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the image to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkTextureKey(key: string): boolean;
/**
* Checks if the given key exists in the Tilemap Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the Tilemap to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkTilemapKey(key: string): boolean;
/**
* Checks if the given URL has been loaded into the Cache.
* This method will only work if Cache.autoResolveURL was set to `true` before any preloading took place.
* The method will make a DOM src call to the URL given, so please be aware of this for certain file types, such as Sound files on Firefox
* which may cause double-load instances.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param url The url to check for in the cache.
* @return True if the url exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkURL(url: string): any;
checkUrl(url: string): any;
/**
* Checks if the given key exists in the XML Cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the XML file to check is in the Cache.
* @return True if the key exists, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkXMLKey(key: string): boolean;
/**
* Add a new decoded sound.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the sound.
* @param data Extra sound data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
decodedSound(key: string, data: any): void;
/**
* Clears the cache. Removes every local cache object reference.
*/
destroy(): void;
/**
* Get binary data by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the binary data object to retrieve from the Cache.
* @return The binary data object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getBinary(key: string): any;
/**
* Get a BitmapData object from the cache by its key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the BitmapData object to retrieve from the Cache.
* @return The requested BitmapData object if found, or null if not.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getBitmapData(key: string): Phaser.BitmapData;
/**
* Get a BitmapFont object from the cache by its key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the BitmapFont object to retrieve from the Cache.
* @return The requested BitmapFont object if found, or null if not.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getBitmapFont(key: string): Phaser.RetroFont;
/**
* Get a canvas object from the cache by its key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the canvas to retrieve from the Cache.
* @return The canvas object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getCanvas(key: string): any;
/**
* Get a single frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the frame data to retrieve from the Cache.
* @return The frame data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrame(key: string): Phaser.Frame;
/**
* Get a single frame out of a frameData set by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the frame data to retrieve from the Cache.
* @return The frame object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrameByIndex(key: string, frame: string): Phaser.Frame;
/**
* Get a single frame out of a frameData set by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the frame data to retrieve from the Cache.
* @return The frame object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrameByName(key: string, frame: string): Phaser.Frame;
/**
* Get the number of frames in this image.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the image you want.
* @return Then number of frames. 0 if the image is not found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrameCount(key: string): number;
/**
* Get frame data by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the frame data to retrieve from the Cache.
* @param map The asset map to get the frameData from, for example `Phaser.Cache.IMAGE`. - Default: Phaser.Cache.IMAGE
* @return The frame data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrameData(key: string, map?: string): Phaser.FrameData;
/**
* Gets an image by its key. Note that this returns a DOM Image object, not a Phaser object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the image to retrieve from the Cache.
* @return The Image object if found in the Cache, otherwise `null`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getImage(key: string): Phaser.Image;
/**
* Get a JSON object by key from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the json object to retrieve from the Cache.
* @return The JSON object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getJSON(key: string): any;
/**
* Gets all keys used by the Cache for the given data type.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param type The type of Cache keys you wish to get. Can be Cache.CANVAS, Cache.IMAGE, Cache.SOUND, etc. - Default: Phaser.Cache.IMAGE
* @return The array of item keys.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getKeys(array: string[]): string[];
/**
* Get a physics data object from the cache by its key. You can get either the entire data set, a single object or a single fixture of an object from it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the physics data object to retrieve from the Cache.
* @param object If specified it will return just the physics object that is part of the given key, if null it will return them all. - Default: null
* @param fixtureKey Fixture key of fixture inside an object. This key can be set per fixture with the Phaser Exporter.
* @return The requested physics object data if found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getPhysicsData(key: string, object?: string, fixtureKey?: string): any[];
/**
* Get a RenderTexture by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the RenderTexture to retrieve from the Cache.
* @return The RenderTexture object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getRenderTexture(key: string): Phaser.RenderTexture;
/**
* Get sound by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the sound to retrieve from the Cache.
* @return The sound object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getSound(key: string): Phaser.Sound;
/**
* Get sound data by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the sound to retrieve from the Cache.
* @return The sound data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getSoundData(key: string): any;
/**
* Get text data by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the text data to retrieve from the Cache.
* @return The text data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getText(key: string): string;
getTextKeys(): string[];
/**
* DEPRECATED: Please use Cache.getRenderTexture instead. This method will be removed in Phaser 2.2.0.
*
* Get a RenderTexture by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the RenderTexture to retrieve from the Cache.
* @return The RenderTexture object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTexture(key: string): Phaser.RenderTexture;
/**
* Get a single texture frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the frame to retrieve from the Cache.
* @return The frame data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTextureFrame(key: string): Phaser.Frame;
getTilemap(key: string): any;
/**
* Get tilemap data by key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the tilemap data to retrieve from the Cache.
* @return The raw tilemap data in CSV or JSON format.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTilemapData(key: string): any;
/**
* Get a cached object by the URL.
* This only returns a value if you set Cache.autoResolveURL to `true` *before* starting the preload of any assets.
* Be aware that every call to this function makes a DOM src query, so use carefully and double-check for implications in your target browsers/devices.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param url The url for the object loaded to get from the cache.
* @return The cached object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getURL(url: string): any;
/**
* DEPRECATED: Please use Cache.getURL instead.
* Get a cached object by the URL.
* This only returns a value if you set Cache.autoResolveURL to `true` *before* starting the preload of any assets.
* Be aware that every call to this function makes a DOM src query, so use carefully and double-check for implications in your target browsers/devices.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param url The url for the object loaded to get from the cache.
* @return The cached object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getUrl(url: string): any;
/**
* Get a XML object by key from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the XML object to retrieve from the Cache.
* @return The XML object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getXML(key: string): any;
/**
* Check if the given sound has finished decoding.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the sound in the Cache.
* @return The decoded state of the Sound object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isSoundDecoded(key: string): boolean;
/**
* Check if the given sound is ready for playback. A sound is considered ready when it has finished decoding and the device is no longer touch locked.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key of the sound in the Cache.
* @return True if the sound is decoded and the device is not touch locked.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isSoundReady(key: string): boolean;
isSpriteSheet(key: string): boolean;
/**
* Reload a Sound file from the server.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the sound.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reloadSound(key: string): void;
/**
* Fires the onSoundUnlock event when the sound has completed reloading.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the sound.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reloadSoundComplete(key: string): void;
/**
* Removes a binary file from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeBinary(key: string): void;
/**
* Removes a bitmap data from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeBitmapData(key: string): void;
/**
* Removes a bitmap font from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeBitmapFont(key: string): void;
/**
* Removes a canvas from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeCanvas(key: string): void;
/**
* Removes an image from the cache and optionally from the Pixi.BaseTextureCache as well.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
* @param removeFromPixi Should this image also be removed from the Pixi BaseTextureCache? - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeImage(key: string, removeFromPixi?: boolean): void;
/**
* Removes a json object from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeJSON(key: string): void;
/**
* Removes a physics data file from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removePhysics(key: string): void;
/**
* Removes a sound from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeSound(key: string): void;
/**
* Removes a text from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeText(key: string): void;
/**
* Removes a tilemap from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeTilemap(key: string): void;
/**
* Removes a xml object from the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Key of the asset you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeXML(key: string): void;
/**
* Replaces a set of frameData with a new Phaser.FrameData object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The unique key by which you will reference this object.
* @param frameData The new FrameData.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateFrameData(key: string, frameData: any): void;
/**
* Updates the sound object in the cache.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the sound.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateSound(key: string, property: string, value: Phaser.Sound): void;
}
/**
* A Camera is your view into the game world. It has a position and size and renders only those objects within its field of view.
* The game automatically creates a single Stage sized camera on boot. Move the camera around the world with Phaser.Camera.x/y
*/
class Camera {
/**
* A Camera is your view into the game world. It has a position and size and renders only those objects within its field of view.
* The game automatically creates a single Stage sized camera on boot. Move the camera around the world with Phaser.Camera.x/y
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Game reference to the currently running game.
* @param id Not being used at the moment, will be when Phaser supports multiple camera
* @param x Position of the camera on the X axis
* @param y Position of the camera on the Y axis
* @param width The width of the view rectangle
* @param height The height of the view rectangle
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, id: number, x: number, y: number, width: number, height: number);
static FOLLOW_LOCKON: number;
static FOLLOW_PLATFORMER: number;
static FOLLOW_TOPDOWN: number;
static FOLLOW_TOPDOWN_TIGHT: number;
/**
* Whether this camera is flush with the World Bounds or not.
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The Cameras x coordinate. This value is automatically clamped if it falls outside of the World bounds. Gets or sets the cameras x position.
*/
/**
* The Cameras y coordinate. This value is automatically clamped if it falls outside of the World bounds. Gets or sets the cameras y position.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
atLimit: { x: boolean; y: boolean; };
/**
* The Camera is bound to this Rectangle and cannot move outside of it. By default it is enabled and set to the size of the World.
* The Rectangle can be located anywhere in the world and updated as often as you like. If you don't wish the Camera to be bound
* at all then set this to null. The values can be anything and are in World coordinates, with 0,0 being the top-left of the world. The Rectangle in which the Camera is bounded. Set to null to allow for movement anywhere.
*/
bounds: Phaser.Rectangle;
/**
* Moving inside this Rectangle will not cause the camera to move.
*/
deadzone: Phaser.Rectangle;
/**
* The display object to which all game objects are added. Set by World.boot
*/
displayObject: PIXI.DisplayObject;
/**
* Reserved for future multiple camera set-ups.
* Default: 0
*/
id: number;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* The Cameras height. By default this is the same as the Game size and should not be adjusted for now. Gets or sets the cameras height.
*/
height: number;
/**
* The Cameras position. This value is automatically clamped if it falls outside of the World bounds. Gets or sets the cameras xy position using Phaser.Point object.
*/
position: Phaser.Point;
/**
* If a Camera has roundPx set to `true` it will call `view.floor` as part of its update loop, keeping its boundary to integer values. Set this to `false` to disable this from happening.
* Default: true
*/
roundPx: boolean;
/**
* The scale of the display object to which all game objects are added. Set by World.boot
*/
scale: Phaser.Point;
/**
* Used by Sprites to work out Camera culling.
*/
screenView: Phaser.Rectangle;
/**
* If the camera is tracking a Sprite, this is a reference to it, otherwise null.
* Default: null
*/
target: Phaser.Sprite;
/**
* The total number of Sprites with `autoCull` set to `true` that are visible by this Camera.
*/
totalInView: number;
/**
* Camera view.
* The view into the world we wish to render (by default the game dimensions).
* The x/y values are in world coordinates, not screen coordinates, the width/height is how many pixels to render.
* Sprites outside of this view are not rendered if Sprite.autoCull is set to `true`. Otherwise they are always rendered.
*/
view: Phaser.Rectangle;
/**
* Whether this camera is visible or not.
* Default: true
*/
visible: boolean;
/**
* The Cameras width. By default this is the same as the Game size and should not be adjusted for now. Gets or sets the cameras width.
*/
width: number;
/**
* A reference to the game world.
*/
world: Phaser.World;
/**
* The Cameras x coordinate. This value is automatically clamped if it falls outside of the World bounds. Gets or sets the cameras x position.
*/
x: number;
/**
* The Cameras y coordinate. This value is automatically clamped if it falls outside of the World bounds. Gets or sets the cameras y position.
*/
y: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Method called to ensure the camera doesn't venture outside of the game world.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
checkBounds(): void;
/**
* Move the camera focus on a display object instantly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to focus the camera on. Must have visible x/y properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
focusOn(displayObject: PIXI.DisplayObject): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Move the camera focus on a location instantly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position.
* @param y Y position.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
focusOnXY(x: number, y: number): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Tell the camera which sprite to follow.
*
* If you find you're getting a slight "jitter" effect when following a Sprite it's probably to do with sub-pixel rendering of the Sprite position.
* This can be disabled by setting `game.renderer.renderSession.roundPixels = true` to force full pixel rendering.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param target The object you want the camera to track. Set to null to not follow anything.
* @param style Leverage one of the existing "deadzone" presets. If you use a custom deadzone, ignore this parameter and manually specify the deadzone after calling follow().
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
follow(target: Phaser.Sprite, style?: number): void;
/**
* Resets the camera back to 0,0 and un-follows any object it may have been tracking.
*/
reset(): void;
/**
* Update the Camera bounds to match the game world.
*/
setBoundsToWorld(): void;
/**
* A helper function to set both the X and Y properties of the camera at once
* without having to use game.camera.x and game.camera.y.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position.
* @param y Y position.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setPosition(x: number, y: number): void;
/**
* Sets the size of the view rectangle given the width and height in parameters.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The desired width.
* @param height The desired height.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setSize(width: number, height: number): void;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Sets the Camera follow target to null, stopping it from following an object if it's doing so.
*/
unfollow(): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Update focusing and scrolling.
*/
update(): void;
}
/**
* The Canvas class handles everything related to creating the `canvas` DOM tag that Phaser will use, including styles, offset and aspect ratio.
*/
class Canvas {
/**
* Adds the given canvas element to the DOM. The canvas will be added as a child of the given parent.
* If no parent is given it will be added as a child of the document.body.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param canvas The canvas to be added to the DOM.
* @param parent The DOM element to add the canvas to.
* @param overflowHidden If set to true it will add the overflow='hidden' style to the parent DOM element. - Default: true
* @return Returns the source canvas.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
static addToDOM(canvas: HTMLCanvasElement, parent: HTMLElement, overflowHidden?: boolean): HTMLCanvasElement;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Creates a `canvas` DOM element. The element is not automatically added to the document.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of the canvas element. - Default: 256
* @param height The height of the canvas element.. - Default: 256
* @param id If specified, and not the empty string, this will be set as the ID of the canvas element. Otherwise no ID will be set. - Default: (none)
* @return The newly created canvas element.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static create(width?: number, height?: number, id?: string): HTMLCanvasElement;
/**
* Returns the aspect ratio of the given canvas.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param canvas The canvas to get the aspect ratio from.
* @return The ratio between canvas' width and height.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getAspectRatio(canvas: HTMLCanvasElement): number;
/**
* Get the DOM offset values of any given element
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param element The targeted element that we want to retrieve the offset.
* @param point The point we want to take the x/y values of the offset.
* @return - A point objet with the offsetX and Y as its properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getOffset(element: HTMLElement, point?: Phaser.Point): Phaser.Point;
static getSmoothngEnabled(context: CanvasRenderingContext2D): boolean;
/**
* Removes the given canvas element from the DOM.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param canvas The canvas to be removed from the DOM.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static removeFromDOM(canvas: HTMLCanvasElement): void;
/**
* Sets the background color behind the canvas. This changes the canvas style property.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param canvas The canvas to set the background color on.
* @param color The color to set. Can be in the format 'rgb(r,g,b)', or '#RRGGBB' or any valid CSS color.
* @return Returns the source canvas.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static setBackgroundColor(canvas: HTMLCanvasElement, color: string): HTMLCanvasElement;
/**
* Sets the CSS image-rendering property on the given canvas to be 'bicubic' (aka 'auto').
* Note that if this doesn't given the desired result then see the CanvasUtils.setSmoothingEnabled method.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param canvas The canvas to set image-rendering bicubic on.
* @return Returns the source canvas.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static setImageRenderingBicubic(canvas: HTMLCanvasElement): HTMLCanvasElement;
/**
* Sets the CSS image-rendering property on the given canvas to be 'crisp' (aka 'optimize contrast' on webkit).
* Note that if this doesn't given the desired result then see the setSmoothingEnabled.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param canvas The canvas to set image-rendering crisp on.
* @return Returns the source canvas.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static setImageRenderingCrisp(canvas: HTMLCanvasElement): HTMLCanvasElement;
/**
* Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.
* By default browsers have image smoothing enabled, which isn't always what you visually want, especially
* when using pixel art in a game. Note that this sets the property on the context itself, so that any image
* drawn to the context will be affected. This sets the property across all current browsers but support is
* patchy on earlier browsers, especially on mobile.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context to enable or disable the image smoothing on.
* @param value If set to true it will enable image smoothing, false will disable it.
* @return Returns the source context.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static setSmoothingEnabled(context: CanvasRenderingContext2D, value: boolean): CanvasRenderingContext2D;
/**
* Sets the touch-action property on the canvas style. Can be used to disable default browser touch actions.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param canvas The canvas to set the touch action on.
* @param value The touch action to set. Defaults to 'none'.
* @return The source canvas.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static setTouchAction(canvas: HTMLCanvasElement, value: string): HTMLCanvasElement;
/**
* Sets the transform of the given canvas to the matrix values provided.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context to set the transform on.
* @param translateX The value to translate horizontally by.
* @param translateY The value to translate vertically by.
* @param scaleX The value to scale horizontally by.
* @param scaleY The value to scale vertically by.
* @param skewX The value to skew horizontaly by.
* @param skewY The value to skew vertically by.
* @return Returns the source context.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static setTransform(context: CanvasRenderingContext2D, translateX: number, translateY: number, scaleX: number, scaleY: number, skewX: number, skewY: number): CanvasRenderingContext2D;
/**
* Sets the user-select property on the canvas style. Can be used to disable default browser selection actions.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param canvas The canvas to set the touch action on.
* @param value The touch action to set. Defaults to 'none'.
* @return The source canvas.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static setUserSelect(canvas: HTMLCanvasElement, value?: string): HTMLCanvasElement;
}
/**
* Creates a new Circle object with the center coordinate specified by the x and y parameters and the diameter specified by the diameter parameter.
* If you call this function without parameters, a circle with x, y, diameter and radius properties set to 0 is created.
*/
class Circle {
/**
* Creates a new Circle object with the center coordinate specified by the x and y parameters and the diameter specified by the diameter parameter.
* If you call this function without parameters, a circle with x, y, diameter and radius properties set to 0 is created.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the center of the circle. - Default: 0
* @param y The y coordinate of the center of the circle. - Default: 0
* @param diameter The diameter of the circle. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(x?: number, y?: number, diameter?: number);
/**
* The area of this Circle.
*/
area: number;
/**
* The sum of the y and radius properties. Changing the bottom property of a Circle object has no effect on the x and y properties, but does change the diameter. Gets or sets the bottom of the circle.
*/
bottom: number;
/**
* The largest distance between any two points on the circle. The same as the radius * 2. Gets or sets the diameter of the circle.
*/
diameter: number;
/**
* Determines whether or not this Circle object is empty. Will return a value of true if the Circle objects diameter is less than or equal to 0; otherwise false.
* If set to true it will reset all of the Circle objects properties to 0. A Circle object is empty if its diameter is less than or equal to 0. Gets or sets the empty state of the circle.
*/
empty: boolean;
/**
* The x coordinate of the leftmost point of the circle. Changing the left property of a Circle object has no effect on the x and y properties. However it does affect the diameter, whereas changing the x value does not affect the diameter property.
*/
left: number;
/**
* The length of a line extending from the center of the circle to any point on the circle itself. The same as half the diameter. Gets or sets the radius of the circle.
*/
radius: number;
/**
* The x coordinate of the rightmost point of the circle. Changing the right property of a Circle object has no effect on the x and y properties. However it does affect the diameter, whereas changing the x value does not affect the diameter property. Gets or sets the value of the rightmost point of the circle.
*/
right: number;
/**
* The sum of the y minus the radius property. Changing the top property of a Circle object has no effect on the x and y properties, but does change the diameter. Gets or sets the top of the circle.
*/
top: number;
/**
* The x coordinate of the center of the circle.
*/
x: number;
/**
* The y coordinate of the center of the circle.
*/
y: number;
/**
* Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param angle The angle in radians (unless asDegrees is true) to return the point from.
* @param asDegrees Is the given angle in radians (false) or degrees (true)? - Default: false
* @param out An optional Point object to put the result in to. If none specified a new Point object will be created.
* @return The Point object holding the result.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static circumferencePoint(a: Phaser.Circle, angle: number, asDegrees: boolean, out?: Phaser.Point): Phaser.Point;
/**
* Return true if the given x/y coordinates are within this Circle object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The X value of the coordinate to test.
* @param y The Y value of the coordinate to test.
* @return True if the coordinates are within this circle, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static contains(a: Phaser.Circle, x: number, y: number): boolean;
/**
* Determines whether the two Circle objects match. This method compares the x, y and diameter properties.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The first Circle object.
* @param b The second Circle object.
* @return A value of true if the object has exactly the same values for the x, y and diameter properties as this Circle object; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static equals(a: Phaser.Circle, b: Phaser.Circle): boolean;
/**
* Determines whether the two Circle objects intersect.
* This method checks the radius distances between the two Circle objects to see if they intersect.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The first Circle object.
* @param b The second Circle object.
* @return A value of true if the specified object intersects with this Circle object; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static intersects(a: Phaser.Circle, b: Phaser.Circle): boolean;
/**
* Checks if the given Circle and Rectangle objects intersect.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param c The Circle object to test.
* @param r The Rectangle object to test.
* @return True if the two objects intersect, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static intersectsRectangle(c: Phaser.Circle, r: Phaser.Rectangle): boolean;
/**
* The circumference of the circle.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @return The circumference of the circle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
circumference(): number;
/**
* Returns a Point object containing the coordinates of a point on the circumference of the Circle based on the given angle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param angle The angle in radians (unless asDegrees is true) to return the point from.
* @param asDegrees Is the given angle in radians (false) or degrees (true)? - Default: false
* @param out An optional Point object to put the result in to. If none specified a new Point object will be created.
* @return The Point object holding the result.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
circumferencePoint(angle: number, asDegrees?: boolean, out?: Phaser.Point): Phaser.Point;
/**
* Returns a new Circle object with the same values for the x, y, width, and height properties as this Circle object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param output Optional Circle object. If given the values will be set into the object, otherwise a brand new Circle object will be created and returned.
* @return The cloned Circle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clone(output: Phaser.Circle): Phaser.Circle;
/**
* Return true if the given x/y coordinates are within this Circle object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The X value of the coordinate to test.
* @param y The Y value of the coordinate to test.
* @return True if the coordinates are within this circle, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
contains(x: number, y: number): boolean;
/**
* Copies the x, y and diameter properties from any given object to this Circle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The object to copy from.
* @return This Circle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copyFrom(source: any): Circle;
/**
* Copies the x, y and diameter properties from this Circle to any given object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dest The object to copy to.
* @return This dest object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copyTo(dest: any): any;
/**
* Returns the distance from the center of the Circle object to the given object
* (can be Circle, Point or anything with x/y properties)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dest The target object. Must have visible x and y properties that represent the center of the object.
* @param round Round the distance to the nearest integer. - Default: false
* @return The distance between this Point object and the destination Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
distance(dest: any, round?: boolean): number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Returns the framing rectangle of the circle as a Phaser.Rectangle object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The bounds of the Circle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getBounds(): Phaser.Rectangle;
/**
* Adjusts the location of the Circle object, as determined by its center coordinate, by the specified amounts.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dx Moves the x value of the Circle object by this amount.
* @param dy Moves the y value of the Circle object by this amount.
* @return This Circle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
offset(dx: number, dy: number): Phaser.Circle;
/**
* Adjusts the location of the Circle object using a Point object as a parameter. This method is similar to the Circle.offset() method, except that it takes a Point object as a parameter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param point A Point object to use to offset this Circle object (or any valid object with exposed x and y properties).
* @return This Circle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
offsetPoint(point: Phaser.Point): Phaser.Circle;
scale(x: number, y?: number): Phaser.Rectangle;
/**
* Sets the members of Circle to the specified values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the center of the circle.
* @param y The y coordinate of the center of the circle.
* @param diameter The diameter of the circle.
* @return This circle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setTo(x: number, y: number, diameter: number): Circle;
/**
* Returns a string representation of this object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return a string representation of the instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
toString(): string;
}
/**
* The Phaser.Color class is a set of static methods that assist in color manipulation and conversion.
*/
class Color {
/**
* Return a string containing a hex representation of the given color component.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color The color channel to get the hex value for, must be a value between 0 and 255.
* @return A string of length 2 characters, i.e. 255 = ff, 100 = 64.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static componentToHex(color: number): string;
/**
* A utility function to create a lightweight 'color' object with the default components.
* Any components that are not specified will default to zero.
*
* This is useful when you want to use a shared color object for the getPixel and getPixelAt methods.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r The red color component, in the range 0 - 255. - Default: 0
* @param g The green color component, in the range 0 - 255. - Default: 0
* @param b The blue color component, in the range 0 - 255. - Default: 0
* @param a The alpha color component, in the range 0 - 1. - Default: 1
* @param h The hue, in the range 0 - 1. - Default: 0
* @param s The saturation, in the range 0 - 1. - Default: 0
* @param l The lightness, in the range 0 - 1. - Default: 0
* @param v The value, in the range 0 - 1. - Default: 0
* @return The resulting object with r, g, b, a properties and h, s, l and v.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static createColor(r?: number, g?: number, b?: number, a?: number, h?: number, s?: number, l?: number, v?: number): any;
/**
* A utility to convert an integer in 0xRRGGBBAA format to a color object.
* This does not rely on endianness.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rgba An RGBA hex
* @param out The object to use, optional.
* @return A color object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static fromRGBA(rgba: number, out?: any): any;
/**
* Given a native color value (in the format 0xAARRGGBB) this will return the Alpha component, as a value between 0 and 255.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color In the format 0xAARRGGBB.
* @return The Alpha component of the color, will be between 0 and 1 (0 being no Alpha (opaque), 1 full Alpha (transparent)).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getAlpha(color: number): number;
/**
* Given a native color value (in the format 0xAARRGGBB) this will return the Alpha component as a value between 0 and 1.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color In the format 0xAARRGGBB.
* @return The Alpha component of the color, will be between 0 and 1 (0 being no Alpha (opaque), 1 full Alpha (transparent)).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getAlphaFloat(color: number): number;
/**
* Given a native color value (in the format 0xAARRGGBB) this will return the Blue component, as a value between 0 and 255.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color In the format 0xAARRGGBB.
* @return The Blue component of the color, will be between 0 and 255 (0 being no color, 255 full Blue).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getBlue(color: number): number;
/**
* Given 3 color values this will return an integer representation of it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r The red color component, in the range 0 - 255.
* @param g The green color component, in the range 0 - 255.
* @param b The blue color component, in the range 0 - 255.
* @return A native color value integer (format: 0xRRGGBB).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getColor(red: number, green: number, blue: number): number;
/**
* Given an alpha and 3 color values this will return an integer representation of it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The alpha color component, in the range 0 - 255.
* @param r The red color component, in the range 0 - 255.
* @param g The green color component, in the range 0 - 255.
* @param b The blue color component, in the range 0 - 255.
* @return A native color value integer (format: 0xAARRGGBB).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getColor32(alpha: number, red: number, green: number, blue: number): number;
/**
* Given a native color value (in the format 0xAARRGGBB) this will return the Green component, as a value between 0 and 255.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color In the format 0xAARRGGBB.
* @return The Green component of the color, will be between 0 and 255 (0 being no color, 255 full Green).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getGreen(color: number): number;
/**
* Returns a random color value between black and white
* Set the min value to start each channel from the given offset.
* Set the max value to restrict the maximum color used per channel.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The lowest value to use for the color.
* @param max The highest value to use for the color.
* @param alpha The alpha value of the returning color (default 255 = fully opaque).
* @return 32-bit color value with alpha.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getRandomColor(min?: number, max?: number, alpha?: number): number;
/**
* Given a native color value (in the format 0xAARRGGBB) this will return the Red component, as a value between 0 and 255.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color In the format 0xAARRGGBB.
* @return The Red component of the color, will be between 0 and 255 (0 being no color, 255 full Red).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getRed(color: number): number;
/**
* Return the component parts of a color as an Object with the properties alpha, red, green, blue.
*
* Alpha will only be set if it exist in the given color (0xAARRGGBB)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color Color in RGB (0xRRGGBB) or ARGB format (0xAARRGGBB).
* @return An Object with properties: alpha, red, green, blue (also r, g, b and a). Alpha will only be present if a color value > 16777215 was given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getRGB(color: number): any;
/**
* Returns a CSS friendly string value from the given color.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color Color in RGB (0xRRGGBB), ARGB format (0xAARRGGBB) or an Object with r, g, b, a properties.
* @return A string in the format: 'rgba(r,g,b,a)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getWebRGB(color: any): string;
/**
* Converts a hex string into an integer color value.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param hex The hex string to convert. Can be in the short-hand format `#03f` or `#0033ff`.
* @return The rgb color value in the format 0xAARRGGBB.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static hexToRGB(h: string): number;
/**
* Converts a hex string into a Phaser Color object.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* The hex string can supplied as `'#0033ff'` or the short-hand format of `'#03f'`; it can begin with an optional "#" or "0x", or be unprefixed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* An alpha channel is _not_ supported.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param hex The color string in a hex format.
* @param out An object into which 3 properties will be created or set: r, g and b. If not provided a new object will be created.
* @return An object with the red, green and blue values set in the r, g and b properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static hexToColor(hex: string, out?: any): any;
/**
* Converts an HSL (hue, saturation and lightness) color value to RGB.
* Conversion forumla from http://en.wikipedia.org/wiki/HSL_color_space.
* Assumes HSL values are contained in the set [0, 1] and returns r, g and b values in the set [0, 255].
* Based on code by Michael Jackson (https://github.com/mjijackson)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param h The hue, in the range 0 - 1.
* @param s The saturation, in the range 0 - 1.
* @param l The lightness, in the range 0 - 1.
* @param out An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.
* @return An object with the red, green and blue values set in the r, g and b properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static HSLtoRGB(h: number, s: number, l: number, out?: any): any;
/**
* Get HSL color wheel values in an array which will be 360 elements in size.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param s The saturation, in the range 0 - 1. - Default: 0.5
* @param l The lightness, in the range 0 - 1. - Default: 0.5
* @return An array containing 360 elements corresponding to the HSL color wheel.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static HSLColorWheel(s?: number, l?: number): any[];
/**
* Converts an HSV (hue, saturation and value) color value to RGB.
* Conversion forumla from http://en.wikipedia.org/wiki/HSL_color_space.
* Assumes HSV values are contained in the set [0, 1] and returns r, g and b values in the set [0, 255].
* Based on code by Michael Jackson (https://github.com/mjijackson)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param h The hue, in the range 0 - 1.
* @param s The saturation, in the range 0 - 1.
* @param v The value, in the range 0 - 1.
* @param out An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.
* @return An object with the red, green and blue values set in the r, g and b properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static HSVtoRGB(h: number, s: number, v: number, out?: any): any;
/**
* Get HSV color wheel values in an array which will be 360 elements in size.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param s The saturation, in the range 0 - 1. - Default: 1
* @param v The value, in the range 0 - 1. - Default: 1
* @return An array containing 360 elements corresponding to the HSV color wheel.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static HSVColorWheel(s?: number, v?: number): any[];
/**
* Converts a hue to an RGB color.
* Based on code by Michael Jackson (https://github.com/mjijackson)
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param p
* @param q
* @param t
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The color component value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static hueToColor(p: number, q: number, t: number): number;
/**
* Interpolates the two given colours based on the supplied step and currentStep properties.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color1 The first color value.
* @param color2 The second color value.
* @param steps The number of steps to run the interpolation over.
* @param currentStep The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.
* @param alpha The alpha of the returned color.
* @return The interpolated color value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static interpolateColor(color1: number, color2: number, steps: number, currentStep: number, alpha: number): number;
/**
* Interpolates the two given colours based on the supplied step and currentStep properties.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color The first color value.
* @param r The red color value, between 0 and 0xFF (255).
* @param g The green color value, between 0 and 0xFF (255).
* @param b The blue color value, between 0 and 0xFF (255).
* @param steps The number of steps to run the interpolation over.
* @param currentStep The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.
* @return The interpolated color value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static interpolateColorWithRGB(color: number, r: number, g: number, b: number, steps: number, currentStep: number): number;
/**
* Interpolates the two given colours based on the supplied step and currentStep properties.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r1 The red color value, between 0 and 0xFF (255).
* @param g1 The green color value, between 0 and 0xFF (255).
* @param b1 The blue color value, between 0 and 0xFF (255).
* @param r2 The red color value, between 0 and 0xFF (255).
* @param g2 The green color value, between 0 and 0xFF (255).
* @param b2 The blue color value, between 0 and 0xFF (255).
* @param steps The number of steps to run the interpolation over.
* @param currentStep The currentStep value. If the interpolation will take 100 steps, a currentStep value of 50 would be half-way between the two.
* @return The interpolated color value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static interpolateRGB(r1: number, g1: number, b1: number, r2: number, g2: number, b2: number, steps: number, currentStep: number): number;
/**
* Packs the r, g, b, a components into a single integer, for use with Int32Array.
* If device is little endian then ABGR order is used. Otherwise RGBA order is used.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r The red color component, in the range 0 - 255.
* @param g The green color component, in the range 0 - 255.
* @param b The blue color component, in the range 0 - 255.
* @param a The alpha color component, in the range 0 - 255.
* @return The packed color as uint32
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static packPixel(r: number, g: number, b: number, a: number): number;
/**
* Converts an RGB color value to HSL (hue, saturation and lightness).
* Conversion forumla from http://en.wikipedia.org/wiki/HSL_color_space.
* Assumes RGB values are contained in the set [0, 255] and returns h, s and l in the set [0, 1].
* Based on code by Michael Jackson (https://github.com/mjijackson)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r The red color component, in the range 0 - 255.
* @param g The green color component, in the range 0 - 255.
* @param b The blue color component, in the range 0 - 255.
* @param out An object into which 3 properties will be created, h, s and l. If not provided a new object will be created.
* @return An object with the hue, saturation and lightness values set in the h, s and l properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static RGBtoHSL(r: number, g: number, b: number, out?: any): any;
/**
* Converts an RGB color value to HSV (hue, saturation and value).
* Conversion forumla from http://en.wikipedia.org/wiki/HSL_color_space.
* Assumes RGB values are contained in the set [0, 255] and returns h, s and v in the set [0, 1].
* Based on code by Michael Jackson (https://github.com/mjijackson)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r The red color component, in the range 0 - 255.
* @param g The green color component, in the range 0 - 255.
* @param b The blue color component, in the range 0 - 255.
* @param out An object into which 3 properties will be created, h, s and v. If not provided a new object will be created.
* @return An object with the hue, saturation and value set in the h, s and v properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static RGBtoHSV(r: number, g: number, b: number, out?: any): any;
/**
* Converts the given color values into a string.
* If prefix was '#' it will be in the format `#RRGGBB` otherwise `0xAARRGGBB`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r The red color component, in the range 0 - 255.
* @param g The green color component, in the range 0 - 255.
* @param b The blue color component, in the range 0 - 255.
* @param a The alpha color component, in the range 0 - 255. - Default: 255
* @param prefix The prefix used in the return string. If '#' it will return `#RRGGBB`, else `0xAARRGGBB`. - Default: '#'
* @return A string containing the color values. If prefix was '#' it will be in the format `#RRGGBB` otherwise `0xAARRGGBB`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static RGBtoString(r: number, g: number, b: number, a?: number, prefix?: string): string;
/**
* A utility to convert RGBA components to a 32 bit integer in RRGGBBAA format.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param r The red color component, in the range 0 - 255.
* @param g The green color component, in the range 0 - 255.
* @param b The blue color component, in the range 0 - 255.
* @param a The alpha color component, in the range 0 - 255.
* @return A RGBA-packed 32 bit integer
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static toRGBA(r: number, g: number, b: number, a: number): number;
/**
* Unpacks the r, g, b, a components into the specified color object, or a new
* object, for use with Int32Array. If little endian, then ABGR order is used when
* unpacking, otherwise, RGBA order is used. The resulting color object has the
* `r, g, b, a` properties which are unrelated to endianness.
*
* Note that the integer is assumed to be packed in the correct endianness. On little-endian
* the format is 0xAABBGGRR and on big-endian the format is 0xRRGGBBAA. If you want a
* endian-independent method, use fromRGBA(rgba) and toRGBA(r, g, b, a).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rgba The integer, packed in endian order by packPixel.
* @param out An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.
* @param hsl Also convert the rgb values into hsl? - Default: false
* @param hsv Also convert the rgb values into hsv? - Default: false
* @return An object with the red, green and blue values set in the r, g and b properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static unpackPixel(rgba: number, out?: any, hsl?: boolean, hsv?: boolean): any;
/**
* Takes a color object and updates the rgba property.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param out The color object to update.
* @return A native color value integer (format: 0xAARRGGBB).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static updateColor(out: any): number;
/**
* Converts a value - a "hex" string, a "CSS 'web' string", or a number - into red, green, blue, and alpha components.
*
* The value can be a string (see `hexToColor` and `webToColor` for the supported formats) or a packed integer (see `getRGB`).
*
* An alpha channel is _not_ supported when specifying a hex string.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The color expressed as a recognized string format or a packed integer.
* @param out The object to use for the output. If not provided a new object will be created.
* @return The (`out`) object with the red, green, blue, and alpha values set as the r/g/b/a properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static valueToColor(value: string, out?: any): { r: number; g: number; b: number; a: number; };
/**
* Converts a CSS 'web' string into a Phaser Color object.
*
* The web string can be in the format `'rgb(r,g,b)'` or `'rgba(r,g,b,a)'` where r/g/b are in the range [0..255] and a is in the range [0..1].
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param web The color string in CSS 'web' format.
* @param out An object into which 4 properties will be created: r, g, b and a. If not provided a new object will be created.
* @return An object with the red, green, blue and alpha values set in the r, g, b and a properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static webToColor(web: string, out?: any): { r: number; g: number; b: number; a: number; };
}
interface CursorKeys {
up: Phaser.Key;
down: Phaser.Key;
left: Phaser.Key;
right: Phaser.Key;
}
/**
* Detects device support capabilities and is responsible for device intialization - see {@link Phaser.Device.whenReady whenReady}.
*
* This class represents a singleton object that can be accessed directly as `game.device`
* (or, as a fallback, `Phaser.Device` when a game instance is not available) without the need to instantiate it.
*
* Unless otherwise noted the device capabilities are only guaranteed after initialization. Initialization
* occurs automatically and is guaranteed complete before {@link Phaser.Game} begins its "boot" phase.
* Feature detection can be modified in the {@link Phaser.Device.onInitialized onInitialized} signal.
*
* When checking features using the exposed properties only the *truth-iness* of the value should be relied upon
* unless the documentation states otherwise: properties may return `false`, `''`, `null`, or even `undefined`
* when indicating the lack of a feature.
*
* Uses elements from System.js by MrDoob and Modernizr
*/
class Device {
/**
* Same value as `littleEndian`.
* Default: false
*/
static LITTLE_ENDIAN: boolean;
/**
* This signal is dispatched after device initialization occurs but before any of the ready
* callbacks (see {@link Phaser.Device.whenReady whenReady}) have been invoked.
*
* Local "patching" for a particular device can/should be done in this event.
*
* _Note_: This signal is removed after the device has been readied; if a handler has not been
* added _before_ `new Phaser.Game(..)` it is probably too late.
*/
static onInitialized: Phaser.Signal;
static checkFullScreenSupport(): void;
/**
* Check whether the host environment can play audio.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param type One of 'mp3, 'ogg', 'm4a', 'wav', 'webm' or 'opus'.
* @return True if the given file type is supported by the browser, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static canPlayAudio(type: string): boolean;
/**
* Check whether the console is open.
* Note that this only works in Firefox with Firebug and earlier versions of Chrome.
* It used to work in Chrome, but then they removed the ability: {@link http://src.chromium.org/viewvc/blink?view=revision&revision=151136}
*/
static isConsoleOpen(): boolean;
/**
* Detect if the host is a an Android Stock browser.
* This is available before the device "ready" event.
*
* Authors might want to scale down on effects and switch to the CANVAS rendering method on those devices.
*/
static isAndroidStockBrowser(): string;
static whenReady: (callback: Function, context?: any) => void;
/**
* Is running on android?
* Default: false
*/
android: boolean;
/**
* Set to true if running in Arora.
* Default: false
*/
arora: boolean;
/**
* Are Audio tags available?
* Default: false
*/
audioData: boolean;
cancelFullScreen: string;
/**
* Is canvas available?
* Default: false
*/
canvas: boolean;
/**
* Set to true if running in Chrome.
* Default: false
*/
chrome: boolean;
/**
* Is running on chromeOS?
* Default: false
*/
chromeOS: boolean;
/**
* Is the game running under CocoonJS?
* Default: false
*/
cocoonJS: boolean;
/**
* Is this game running with CocoonJS.App?
* Default: false
*/
cocoonJSApp: boolean;
/**
* Is the game running under Apache Cordova?
* Default: false
*/
cordova: boolean;
/**
* Is the game running under the Intel Crosswalk XDK?
* Default: false
*/
crosswalk: boolean;
/**
* Is css3D available?
* Default: false
*/
css3D: boolean;
/**
* Is running on a desktop?
* Default: false
*/
desktop: boolean;
/**
* The time the device became ready.
*/
deviceReadyAt: number;
/**
* Is the game running under Ejecta?
* Default: false
*/
ejecta: boolean;
/**
* Set to true if running in Epiphany.
* Default: false
*/
epiphany: boolean;
/**
* Is file available?
* Default: false
*/
file: boolean;
/**
* Is fileSystem available?
* Default: false
*/
fileSystem: boolean;
/**
* Set to true if running in Firefox.
* Default: false
*/
firefox: boolean;
fullScreen: boolean;
fullScreenKeyboard: boolean;
/**
* Does the device support the getUserMedia API?
* Default: false
*/
getUserMedia: boolean;
game: Phaser.Game;
/**
* Set to true if running in Internet Explorer.
* Default: false
*/
ie: boolean;
/**
* If running in Internet Explorer this will contain the major version number. Beyond IE10 you should use Device.trident and Device.tridentVersion.
* Default: 0
*/
ieVersion: number;
/**
* Is running on iOS?
* Default: false
*/
iOS: boolean;
/**
* The time as which initialization has completed.
*/
initialized: boolean;
/**
* Is running on iPad?
* Default: false
*/
iPad: boolean;
/**
* Is running on iPhone?
* Default: false
*/
iPhone: boolean;
/**
* Is running on iPhone4?
* Default: false
*/
iPhone4: boolean;
kindle: boolean;
/**
* Is running on linux?
* Default: false
*/
linux: boolean;
/**
* Is the device big or little endian? (only detected if the browser supports TypedArrays)
* Default: false
*/
littleEndian: boolean;
/**
* Is localStorage available?
* Default: false
*/
localStorage: boolean;
/**
* Can this device play m4a files? True if this device can play m4a files.
* Default: false
*/
m4a: boolean;
/**
* Is running on macOS?
* Default: false
*/
macOS: boolean;
/**
* Set to true if running in Midori.
* Default: false
*/
midori: boolean;
/**
* Set to true if running in Mobile Safari.
* Default: false
*/
mobileSafari: boolean;
/**
* Can this device play mp3 files?
* Default: false
*/
mp3: boolean;
/**
* Is mspointer available?
* Default: false
*/
mspointer: boolean;
/**
* Is the game running under Node.js?
* Default: false
*/
node: boolean;
/**
* Is the game running under Node-Webkit?
* Default: false
*/
nodeWebkit: boolean;
/**
* Can this device play ogg files?
* Default: false
*/
ogg: boolean;
/**
* Set to true if running in Opera.
* Default: false
*/
opera: boolean;
/**
* Can this device play opus files?
* Default: false
*/
opus: boolean;
/**
* PixelRatio of the host device?
* Default: 0
*/
pixelRatio: number;
/**
* Is Pointer Lock available?
* Default: false
*/
pointerLock: boolean;
/**
* Is the browser running in strict mode (false) or quirks mode? (true)
* Default: false
*/
quirksMode: boolean;
requestFullScreen: string;
/**
* Set to true if running in Safari.
* Default: false
*/
safari: boolean;
/**
* Set to true if running in the Silk browser (as used on the Amazon Kindle)
* Default: false
*/
silk: boolean;
/**
* Does the device context support 32bit pixel manipulation using array buffer views?
* Default: false
*/
support32bit: boolean;
/**
* Is touch available?
* Default: false
*/
touch: boolean;
/**
* Set to true if running a Trident version of Internet Explorer (IE11+)
* Default: false
*/
trident: boolean;
/**
* If running in Internet Explorer 11 this will contain the major version number. See {@link http://msdn.microsoft.com/en-us/library/ie/ms537503(v=vs.85).aspx}
* Default: 0
*/
tridentVersion: number;
/**
* Does the browser support TypedArrays?
* Default: false
*/
typedArray: boolean;
/**
* Does the device support the Vibration API?
* Default: false
*/
vibration: boolean;
vita: boolean;
/**
* Can this device play wav files?
* Default: false
*/
wav: boolean;
/**
* Set to true if running as a WebApp, i.e. within a WebView
* Default: false
*/
webApp: boolean;
/**
* Is the WebAudio API available?
* Default: false
*/
webAudio: boolean;
/**
* Is webGL available?
* Default: false
*/
webGL: boolean;
/**
* Can this device play webm files?
* Default: false
*/
webm: boolean;
/**
* Is running on windows?
* Default: false
*/
windows: boolean;
/**
* Is running on a Windows Phone?
* Default: false
*/
windowsPhone: boolean;
/**
* The newest type of Wheel/Scroll event supported: 'wheel', 'mousewheel', 'DOMMouseScroll'
* Default: null
*/
wheelEvent: string;
/**
* Is worker available?
* Default: false
*/
worker: boolean;
}
module Easing {
var Default: Function;
var Power0: Function;
var Power1: Function;
var power2: Function;
var power3: Function;
var power4: Function;
/**
* Back easing.
*/
class Back {
/**
* Back ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Back ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Back ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
/**
* Bounce easing.
*/
class Bounce {
/**
* Bounce ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Bounce ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Bounce ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
/**
* Circular easing.
*/
class Circular {
/**
* Circular ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Circular ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Circular ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
/**
* Cubic easing.
*/
class Cubic {
/**
* Cubic ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Cubic ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Cubic ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
/**
* Elastic easing.
*/
class Elastic {
/**
* Elastic ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Elastic ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Elastic ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
/**
* Exponential easing.
*/
class Exponential {
/**
* Exponential ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Exponential ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Exponential ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
/**
* Linear easing.
*/
class Linear {
/**
* Linear Easing (no variation).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return k.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static None(k: number): number;
}
/**
* Quadratic easing.
*/
class Quadratic {
/**
* Ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return k^2.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return k* (2-k).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
/**
* Quartic easing.
*/
class Quartic {
/**
* Quartic ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Quartic ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Quartic ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
/**
* Quintic easing.
*/
class Quintic {
/**
* Quintic ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Quintic ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Quintic ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
/**
* Sinusoidal easing.
*/
class Sinusoidal {
/**
* Sinusoidal ease-in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static In(k: number): number;
/**
* Sinusoidal ease-out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static Out(k: number): number;
/**
* Sinusoidal ease-in/out.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param k The value to be tweened.
* @return The tweened value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static InOut(k: number): number;
}
}
/**
* Creates a Ellipse object. A curve on a plane surrounding two focal points.
*/
class Ellipse {
/**
* Creates a Ellipse object. A curve on a plane surrounding two focal points.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The X coordinate of the upper-left corner of the framing rectangle of this ellipse. - Default: 0
* @param y The Y coordinate of the upper-left corner of the framing rectangle of this ellipse. - Default: 0
* @param width The overall width of this ellipse. - Default: 0
* @param height The overall height of this ellipse. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(x?: number, y?: number, width?: number, height?: number);
/**
* The sum of the y and height properties. Changing the bottom property of an Ellipse doesn't adjust the y property, but does change the height. Gets or sets the bottom of the ellipse.
*/
bottom: number;
/**
* Determines whether or not this Ellipse object is empty. Will return a value of true if the Ellipse objects dimensions are less than or equal to 0; otherwise false.
* If set to true it will reset all of the Ellipse objects properties to 0. An Ellipse object is empty if its width or height is less than or equal to 0. Gets or sets the empty state of the ellipse.
*/
empty: boolean;
/**
* The overall height of this ellipse.
*/
height: number;
/**
* The left coordinate of the Ellipse. The same as the X coordinate.
*/
left: number;
/**
* The x coordinate of the rightmost point of the Ellipse. Changing the right property of an Ellipse object has no effect on the x property, but does adjust the width. Gets or sets the value of the rightmost point of the ellipse.
*/
right: number;
/**
* The top of the Ellipse. The same as its y property. Gets or sets the top of the ellipse.
*/
top: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The const type of this object.
*/
type: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The overall width of this ellipse.
*/
width: number;
/**
* The X coordinate of the upper-left corner of the framing rectangle of this ellipse.
*/
x: number;
/**
* The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.
*/
y: number;
static constains(a: Phaser.Ellipse, x: number, y: number): boolean;
/**
* Returns a new Ellipse object with the same values for the x, y, width, and height properties as this Ellipse object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param output Optional Ellipse object. If given the values will be set into the object, otherwise a brand new Ellipse object will be created and returned.
* @return The cloned Ellipse object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clone(output: Phaser.Ellipse): Phaser.Ellipse;
/**
* Return true if the given x/y coordinates are within this Ellipse object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The X value of the coordinate to test.
* @param y The Y value of the coordinate to test.
* @return True if the coordinates are within this ellipse, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
contains(x: number, y: number): boolean;
/**
* Copies the x, y, width and height properties from any given object to this Ellipse.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The object to copy from.
* @return This Ellipse object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copyFrom(source: any): Phaser.Ellipse;
/**
* Copies the x, y, width and height properties from this Ellipse to any given object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dest The object to copy to.
* @return This dest object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copyTo(dest: any): any;
/**
* Returns the framing rectangle of the ellipse as a Phaser.Rectangle object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The bounds of the Ellipse.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getBounds(): Phaser.Rectangle;
/**
* Sets the members of the Ellipse to the specified values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The X coordinate of the upper-left corner of the framing rectangle of this ellipse.
* @param y The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.
* @param width The overall width of this ellipse.
* @param height The overall height of this ellipse.
* @return This Ellipse object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setTo(x: number, y: number, width: number, height: number): Phaser.Ellipse;
/**
* Returns a string representation of this object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A string representation of the instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
toString(): string;
}
/**
* The Events component is a collection of events fired by the parent game object.
*
* For example to tell when a Sprite has been added to a new group:
*
* `sprite.events.onAddedToGroup.add(yourFunction, this);`
*
* Where `yourFunction` is the function you want called when this event occurs.
*
* The Input-related events will only be dispatched if the Sprite has had `inputEnabled` set to `true`
* and the Animation-related events only apply to game objects with animations like {@link Phaser.Sprite}.
*/
class Events {
/**
* The Events component is a collection of events fired by the parent game object.
*
* For example to tell when a Sprite has been added to a new group:
*
* `sprite.events.onAddedToGroup.add(yourFunction, this);`
*
* Where `yourFunction` is the function you want called when this event occurs.
*
* The Input-related events will only be dispatched if the Sprite has had `inputEnabled` set to `true`
* and the Animation-related events only apply to game objects with animations like {@link Phaser.Sprite}.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite A reference to the game object / Sprite that owns this Events object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(sprite: Phaser.Sprite);
/**
* The Sprite that owns these events.
*/
parent: Phaser.Sprite;
/**
* This signal is dispatched when the parent is added to a new Group.
*/
onAddedToGroup: Phaser.Signal;
/**
* This signal is dispatched when the parent is removed from a Group.
*/
onRemovedFromGroup: Phaser.Signal;
/**
* This signal is dispatched if this item or any of its parents are removed from the game world.
*/
onRemovedFromWorld: Phaser.Signal;
/**
* This signal is dispatched when the parent is killed.
*/
onKilled: Phaser.Signal;
/**
* This signal is dispatched when the parent is revived.
*/
onRevived: Phaser.Signal;
/**
* This signal is dispatched when the parent leaves the world bounds (only if Sprite.checkWorldBounds is true).
*/
onOutOfBounds: Phaser.Signal;
/**
* This signal is dispatched when the parent returns within the world bounds (only if Sprite.checkWorldBounds is true).
*/
onEnterBounds: Phaser.Signal;
/**
* This signal is dispatched if the parent is inputEnabled and receives an over event from a Pointer.
*/
onInputOver: Phaser.Signal;
/**
* This signal is dispatched if the parent is inputEnabled and receives an out event from a Pointer.
*/
onInputOut: Phaser.Signal;
/**
* This signal is dispatched if the parent is inputEnabled and receives a down event from a Pointer.
*/
onInputDown: Phaser.Signal;
/**
* This signal is dispatched if the parent is inputEnabled and receives an up event from a Pointer.
*/
onInputUp: Phaser.Signal;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This signal is dispatched when the parent is destroyed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onDestroy: Phaser.Signal;
/**
* This signal is dispatched if the parent is inputEnabled and receives a drag start event from a Pointer.
*/
onDragStart: Phaser.Signal;
/**
* This signal is dispatched if the parent is inputEnabled and receives a drag stop event from a Pointer.
*/
onDragStop: Phaser.Signal;
/**
* This signal is dispatched when the parent has an animation that is played.
*/
onAnimationStart: Phaser.Signal;
/**
* This signal is dispatched when the parent has an animation that finishes playing.
*/
onAnimationComplete: Phaser.Signal;
/**
* This signal is dispatched when the parent has an animation that loops playback.
*/
onAnimationLoop: Phaser.Signal;
/**
* Removes all events.
*/
destroy(): void;
}
/**
* This is a base Filter class to use for any Phaser filter development.
*/
class Filter extends PIXI.AbstractFilter {
/**
* This is a base Filter class to use for any Phaser filter development.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param uniforms Uniform mappings object
* @param fragmentSrc The fragment shader code.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, ...args: any[]);
/**
* Internal PIXI var.
* Default: true
*/
dirty: boolean;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* The height (resolution uniform)
*/
height: number;
/**
* The fragment shader code.
*/
fragmentSrc: any[];
/**
* Internal PIXI var.
* Default: 0
*/
padding: number;
/**
* The previous position of the pointer (we don't update the uniform if the same)
*/
prevPoint: Phaser.Point;
/**
* The const type of this object, either Phaser.WEBGL_FILTER or Phaser.CANVAS_FILTER.
*/
type: number;
/**
* Default uniform mappings. Compatible with ShaderToy and GLSLSandbox.
*/
uniforms: any;
/**
* The width (resolution uniform)
*/
width: number;
apply(frameBuffer: WebGLFramebuffer): void;
/**
* Clear down this Filter and null out references
*/
destroy(): void;
/**
* Should be over-ridden.
*/
init(...args: any[]): void;
/**
* Set the resolution uniforms on the filter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of the display.
* @param height The height of the display.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setResolution(width: number, height: number): void;
syncUniforms(): void;
/**
* Updates the filter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointer A Pointer object to use for the filter. The coordinates are mapped to the mouse uniform.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(pointer?: Phaser.Pointer): void;
}
module Filter {
class BinarySerpents extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number, march?: number, maxDistance?: number);
fog: number;
}
class BlurX extends Phaser.Filter {
blur: number;
}
class BlurY extends Phaser.Filter {
blur: number;
}
class CausticLight extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number, divisor?: number);
init(width: number, height: number, divisor?: number): void;
}
class CheckerWave extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number);
alpha: number;
cameraX: number;
cameraY: number;
cameraZ: number;
init(width: number, height: number): void;
setColor1(red: number, green: number, blue: number): void;
setColor2(red: number, green: number, blue: number): void;
}
class ColorBars extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number);
alpha: number;
init(width: number, height: number): void;
}
class Fire extends Phaser.Filter {
constructor(width: number, height: number, alpha?: number, shift?: number);
alpha: number;
shift: number;
speed: number;
init(width: number, height: number, alpha?: number, shift?: number): void;
}
class Gray extends Phaser.Filter {
gray: number;
}
class HueRotate extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number, texture: any);
alpha: number;
init(width: number, height: number, texture: any): void;
}
class LazerBeam extends Phaser.Filter {
init(width: number, height: number, divisor?: number): void;
}
class LightBeam extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number);
alpha: number;
blue: number;
green: number;
red: number;
thickness: number;
speed: number;
init(width: number, height: number): void;
}
class Marble extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number, speed?: number, intensity?: number);
alpha: number;
intensity: number;
speed: number;
init(width: number, height: number, speed?: number, intensity?: number): void;
}
class Pixelate extends Phaser.Filter {
size: number;
}
class Plasma extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number, alpha?: number, size?: number);
alpha: number;
blueShift: number;
greenShift: number;
redShift: number;
size: number;
init(width: number, height: number, alpha?: number, size?: number): void;
}
class SampleFilter extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number, divisor?: number);
init(width: number, height: number, divisor?: number): void;
}
class Tunnel extends Phaser.Filter {
constructor(game: Phaser.Game, width: number, height: number, texture: any);
alpha: number;
origin: number;
init(width: number, height: number, texture: any): void;
}
}
/**
* WARNING: This is an EXPERIMENTAL class. The API will change significantly in the coming versions and is incomplete.
* Please try to avoid using in production games with a long time to build.
* This is also why the documentation is incomplete.
*
* FlexGrid is a a responsive grid manager that works in conjunction with the ScaleManager RESIZE scaling mode and FlexLayers
* to provide for game object positioning in a responsive manner.
*/
class FlexGrid {
/**
* WARNING: This is an EXPERIMENTAL class. The API will change significantly in the coming versions and is incomplete.
* Please try to avoid using in production games with a long time to build.
* This is also why the documentation is incomplete.
*
* FlexGrid is a a responsive grid manager that works in conjunction with the ScaleManager RESIZE scaling mode and FlexLayers
* to provide for game object positioning in a responsive manner.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param manager The ScaleManager.
* @param width The width of the game.
* @param height The height of the game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(manager: Phaser.ScaleManager, width: number, height: number);
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* A reference to the ScaleManager.
*/
manager: Phaser.ScaleManager;
width: number;
height: number;
boundsCustom: Phaser.Rectangle;
boundsFluid: Phaser.Rectangle;
boundsFull: Phaser.Rectangle;
boundsNone: Phaser.Rectangle;
customWidth: number;
customHeight: number;
customOffsetX: number;
customOffsetY: number;
/**
* -
*/
positionCustom: Phaser.Point;
positionFluid: Phaser.Point;
positionFull: Phaser.Point;
positionNone: Phaser.Point;
/**
* The scale factor based on the game dimensions vs. the scaled dimensions.
*/
scaleCustom: Phaser.Point;
scaleFluid: Phaser.Point;
scaleFluidInversed: Phaser.Point;
scaleFull: Phaser.Point;
scaleNone: Phaser.Point;
ratioH: number;
ratioV: number;
multiplier: number;
/**
* A custom layer is centered on the game and maintains its aspect ratio as it scales up and down.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width Width of this layer in pixels.
* @param height Height of this layer in pixels.
* @param children An array of children that are used to populate the FlexLayer.
* @return The Layer object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createCustomLayer(width: number, height: number, children?: PIXI.DisplayObject[], addToWorld?: boolean): Phaser.FlexLayer;
/**
* A fluid layer is centered on the game and maintains its aspect ratio as it scales up and down.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param children An array of children that are used to populate the FlexLayer.
* @return The Layer object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createFluidLayer(children: PIXI.DisplayObject[]): Phaser.FlexLayer;
/**
* A full layer is placed at 0,0 and extends to the full size of the game. Children are scaled according to the fluid ratios.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param children An array of children that are used to populate the FlexLayer.
* @return The Layer object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createFullLayer(children: PIXI.DisplayObject[]): Phaser.FlexLayer;
/**
* A fixed layer is centered on the game and is the size of the required dimensions and is never scaled.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param children An array of children that are used to populate the FlexLayer.
* @return The Layer object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createFixedLayer(children: PIXI.DisplayObject[]): Phaser.FlexLayer;
/**
* Call in the render function to output the bounds rects.
*/
debug(): void;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Fits a sprites width to the bounds.
*
* @param sprite The Sprite to fit.
*/
fitSprite(sprite: Phaser.Sprite): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Called when the game container changes dimensions.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The new width of the game container.
* @param height The new height of the game container.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onResize(width: number, height: number): void;
/**
* Updates all internal vars such as the bounds and scale values.
*/
refresh(): void;
/**
* Resets the layer children references
*/
reset(): void;
/**
* Sets the core game size. This resets the w/h parameters and bounds.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The new dimensions.
* @param height The new dimensions.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setSize(width: number, height: number): void;
}
/**
* WARNING: This is an EXPERIMENTAL class. The API will change significantly in the coming versions and is incomplete.
* Please try to avoid using in production games with a long time to build.
* This is also why the documentation is incomplete.
*
* A responsive grid layer.
*/
class FlexLayer extends Phaser.Group {
/**
* WARNING: This is an EXPERIMENTAL class. The API will change significantly in the coming versions and is incomplete.
* Please try to avoid using in production games with a long time to build.
* This is also why the documentation is incomplete.
*
* A responsive grid layer.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param manager The FlexGrid that owns this FlexLayer.
* @param position A reference to the Point object used for positioning.
* @param bounds A reference to the Rectangle used for the layer bounds.
* @param scale A reference to the Point object used for layer scaling.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(manager: Phaser.ScaleManager, position: Phaser.Point, bounds: Phaser.Rectangle, scale: Phaser.Point);
/**
* A reference to the FlexGrid that owns this layer.
*/
grid: Phaser.FlexGrid;
/**
* A reference to the ScaleManager.
*/
manager: Phaser.ScaleManager;
bottomLeft: Phaser.Point;
bottomMiddle: Phaser.Point;
bottomRight: Phaser.Point;
bounds: Phaser.Rectangle;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Should the FlexLayer remain through a State swap?
*/
persist: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
position: Phaser.Point;
scale: Phaser.Point;
topLeft: Phaser.Point;
topMiddle: Phaser.Point;
topRight: Phaser.Point;
/**
* Debug.
*/
debug(): void;
/**
* Resize.
*/
resize(): void;
}
/**
* A Frame is a single frame of an animation and is part of a FrameData collection.
*/
class Frame {
/**
* A Frame is a single frame of an animation and is part of a FrameData collection.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The index of this Frame within the FrameData set it is being added to.
* @param x X position of the frame within the texture image.
* @param y Y position of the frame within the texture image.
* @param width Width of the frame within the texture image.
* @param height Height of the frame within the texture image.
* @param name The name of the frame. In Texture Atlas data this is usually set to the filename.
* @param uuid Internal UUID key.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(index: number, x: number, y: number, width: number, height: number, name: string, uuid: string);
/**
* The bottom of the frame (y + height).
*/
bottom: number;
/**
* Center X position within the image to cut from.
*/
centerX: number;
/**
* Center Y position within the image to cut from.
*/
centerY: number;
/**
* The distance from the top left to the bottom-right of this Frame.
*/
distance: number;
/**
* Height of the frame.
*/
height: number;
/**
* The index of this Frame within the FrameData set it is being added to.
*/
index: number;
/**
* Useful for Texture Atlas files (is set to the filename value).
*/
name: string;
/**
* The right of the Frame (x + width).
*/
right: number;
/**
* Rotated? (not yet implemented)
* Default: false
*/
rotated: boolean;
/**
* Either 'cw' or 'ccw', rotation is always 90 degrees.
* Default: 'cw'
*/
rotationDirection: string;
/**
* Height of the original sprite.
*/
sourceSizeH: number;
/**
* Width of the original sprite.
*/
sourceSizeW: number;
/**
* Height of the trimmed sprite.
* Default: 0
*/
spriteSourceSizeH: number;
/**
* Width of the trimmed sprite.
* Default: 0
*/
spriteSourceSizeW: number;
/**
* X position of the trimmed sprite inside original sprite.
* Default: 0
*/
spriteSourceSizeX: number;
/**
* Y position of the trimmed sprite inside original sprite.
* Default: 0
*/
spriteSourceSizeY: number;
/**
* Was it trimmed when packed?
* Default: false
*/
trimmed: boolean;
/**
* DEPRECATED: A link to the PIXI.TextureCache entry.
*/
uuid: string;
/**
* Width of the frame.
*/
width: number;
/**
* X position within the image to cut from.
*/
x: number;
/**
* Y position within the image to cut from.
*/
y: number;
/**
* Clones this Frame into a new Phaser.Frame object and returns it.
* Note that all properties are cloned, including the name, index and UUID.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return An exact copy of this Frame object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clone(): Phaser.Frame;
/**
* Returns a Rectangle set to the dimensions of this Frame.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param out A rectangle to copy the frame dimensions to.
* @return A rectangle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getRect(out?: Phaser.Rectangle): Phaser.Rectangle;
/**
* If the frame was trimmed when added to the Texture Atlas this records the trim and source data.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param trimmed If this frame was trimmed or not.
* @param actualWidth The width of the frame before being trimmed.
* @param actualHeight The height of the frame before being trimmed.
* @param destX The destination X position of the trimmed frame for display.
* @param destY The destination Y position of the trimmed frame for display.
* @param destWidth The destination width of the trimmed frame for display.
* @param destHeight The destination height of the trimmed frame for display.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setTrim(trimmed: boolean, actualWidth: number, actualHeight: number, destX: number, destY: number, destWidth: number, destHeight: number): void;
}
/**
* FrameData is a container for Frame objects, which are the internal representation of animation data in Phaser.
*/
class FrameData {
/**
* The total number of frames in this FrameData set.
*/
total: number;
/**
* Adds a new Frame to this FrameData collection. Typically called by the Animation.Parser and not directly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frame The frame to add to this FrameData set.
* @return The frame that was just added.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addFrame(frame: Frame): Phaser.Frame;
/**
* Check if there is a Frame with the given name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the frame you want to check.
* @return True if the frame is found, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkFrameName(name: string): boolean;
/**
* Makes a copy of this FrameData including copies (not references) to all of the Frames it contains.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A clone of this object, including clones of the Frame objects it contains.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clone(): Phaser.FrameData;
/**
* Get a Frame by its numerical index.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The index of the frame you want to get.
* @return The frame, if found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrame(index: number): Phaser.Frame;
/**
* Get a Frame by its frame name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the frame you want to get.
* @return The frame, if found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrameByName(name: string): Phaser.Frame;
/**
* Returns all of the Frame indexes in this FrameData set.
* The frames indexes are returned in the output array, or if none is provided in a new Array object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frames An Array containing the indexes of the frames to retrieve. If the array is empty then all frames in the FrameData are returned.
* @param useNumericIndex Are the given frames using numeric indexes (default) or strings? (false) - Default: true
* @param output If given the results will be appended to the end of this array otherwise a new array will be created.
* @return An array of all Frame indexes matching the given names or IDs.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrameIndexes(frames: number[], useNumericIndex?: boolean, output?: number[]): number[];
/**
* Returns a range of frames based on the given start and end frame indexes and returns them in an Array.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param start The starting frame index.
* @param end The ending frame index.
* @param output If given the results will be appended to the end of this array otherwise a new array will be created.
* @return An array of Frames between the start and end index values, or an empty array if none were found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrameRange(start: number, end: number, output: Phaser.Frame[]): Phaser.Frame[];
/**
* Returns all of the Frames in this FrameData set where the frame index is found in the input array.
* The frames are returned in the output array, or if none is provided in a new Array object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frames An Array containing the indexes of the frames to retrieve. If the array is empty then all frames in the FrameData are returned.
* @param useNumericIndex Are the given frames using numeric indexes (default) or strings? (false) - Default: true
* @param output If given the results will be appended to the end of this array otherwise a new array will be created.
* @return An array of all Frames in this FrameData set matching the given names or IDs.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFrames(frames: number[], useNumericIndex?: boolean, output?: Phaser.Frame[]): Phaser.Frame[];
}
interface IGameConfig {
enableDebug?: boolean;
width?: number;
height?: number;
renderer?: number;
parent?: any;
transparent?: boolean;
antialias?: boolean;
preserveDrawingBuffer?: boolean;
physicsConfig?: any;
seed?: string;
state?: Phaser.State;
}
/**
* This is where the magic happens. The Game object is the heart of your game,
* providing quick access to common functions and handling the boot process.
*
* "Hell, there are no rules here - we're trying to accomplish something."
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Thomas A. Edison
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class Game {
/**
* This is where the magic happens. The Game object is the heart of your game,
* providing quick access to common functions and handling the boot process.
*
* "Hell, there are no rules here - we're trying to accomplish something."
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Thomas A. Edison
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given. - Default: 800
* @param height The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given. - Default: 600
* @param renderer Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all). - Default: Phaser.AUTO
* @param parent The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself. - Default: ''
* @param state The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null. - Default: null
* @param transparent Use a transparent canvas background or not. - Default: false
* @param antialias Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art. - Default: true
* @param physicsConfig A physics configuration object to pass to the Physics world on creation. - Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
constructor(width?: number|string, height?: number|string, renderer?: number, parent?: any, state?: any, transparent?: boolean, antialias?: boolean, physicsConfig?: any);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* This is where the magic happens. The Game object is the heart of your game,
* providing quick access to common functions and handling the boot process.
*
* "Hell, there are no rules here - we're trying to accomplish something."
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Thomas A. Edison
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given. - Default: 800
* @param height The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given. - Default: 600
* @param renderer Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all). - Default: Phaser.AUTO
* @param parent The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself. - Default: ''
* @param state The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null. - Default: null
* @param transparent Use a transparent canvas background or not. - Default: false
* @param antialias Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art. - Default: true
* @param physicsConfig A physics configuration object to pass to the Physics world on creation. - Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(config: IGameConfig);
/**
* Reference to the Phaser.GameObjectFactory.
*/
add: Phaser.GameObjectFactory;
/**
* Anti-alias graphics. By default scaled images are smoothed in Canvas and WebGL, set anti-alias to false to disable this globally.
* Default: true
*/
antialias: boolean;
/**
* Reference to the assets cache.
*/
cache: Phaser.Cache;
/**
* A handy reference to world.camera.
*/
camera: Phaser.Camera;
/**
* A handy reference to renderer.view, the canvas that the game is being rendered in to.
*/
canvas: HTMLCanvasElement;
/**
* The Phaser.Game configuration object.
*/
config: IGameConfig;
/**
* A handy reference to renderer.context (only set for CANVAS games, not WebGL)
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
context: CanvasRenderingContext2D;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
count: number;
/**
* A set of useful debug utilitie.
*/
debug: Phaser.Utils.Debug;
/**
* Contains device information and capabilities.
*/
device: Phaser.Device;
/**
* Should the game loop force a logic update, regardless of the delta timer? Set to true if you know you need this. You can toggle it on the fly.
*/
forceSingleUpdate: boolean;
/**
* If the game is struggling to maintain the desired FPS, this signal will be dispatched.
* The desired/chosen FPS should probably be closer to the {@link Phaser.Time#suggestedFps} value.
*/
fpsProblemNotifier: Phaser.Signal;
/**
* The current Game Height in pixels.
*
* _Do not modify this property directly:_ use {@link Phaser.ScaleManager#setGameSize} - eg. `game.scale.setGameSize(width, height)` - instead.
* Default: 600
*/
height: number;
/**
* Phaser Game ID (for when Pixi supports multiple instances).
*/
id: number;
/**
* Reference to the input manager
*/
input: Phaser.Input;
/**
* Whether the game engine is booted, aka available.
*/
isBooted: boolean;
/**
* Is game running or paused?
*/
isRunning: boolean;
/**
* Reference to the assets loader.
*/
load: Phaser.Loader;
/**
* If `false` Phaser will automatically render the display list every update. If `true` the render loop will be skipped.
* You can toggle this value at run-time to gain exact control over when Phaser renders. This can be useful in certain types of game or application.
* Please note that if you don't render the display list then none of the game object transforms will be updated, so use this value carefully.
* Default: false
*/
lockRender: boolean;
/**
* Reference to the GameObject Creator.
*/
make: Phaser.GameObjectCreator;
/**
* Reference to the math helper.
*/
math: Phaser.Math;
/**
* Reference to the network class.
*/
net: Phaser.Net;
/**
* This event is fired when the game no longer has focus (typically on page hide).
*/
onBlur: Phaser.Signal;
/**
* This event is fired when the game has focus (typically on page show).
*/
onFocus: Phaser.Signal;
/**
* This event is fired when the game pauses.
*/
onPause: Phaser.Signal;
/**
* This event is fired when the game resumes from a paused state.
*/
onResume: Phaser.Signal;
/**
* The Games DOM parent.
*/
parent: HTMLElement;
/**
* The Particle Manager.
*/
particles: Phaser.Particles;
/**
* The paused state of the Game. A paused game doesn't update any of its subsystems.
* When a game is paused the onPause event is dispatched. When it is resumed the onResume event is dispatched. Gets and sets the paused state of the Game.
*/
paused: boolean;
/**
* An internal property used by enableStep, but also useful to query from your own game objects.
* Default: false
*/
pendingStep: boolean;
/**
* Reference to the physics manager.
*/
physics: Phaser.Physics;
/**
* The Phaser.Physics.World configuration object.
*/
physicsConfig: any;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Reference to the plugin manager.
*/
plugins: PluginManager;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.
* Default: false
*/
preserveDrawingBuffer: Boolean;
/**
* Automatically handles the core game loop via requestAnimationFrame or setTimeout
*/
raf: Phaser.RequestAnimationFrame;
/**
* The Pixi Renderer.
*/
renderer: number;
/**
* The Renderer this game will use. Either Phaser.AUTO, Phaser.CANVAS or Phaser.WEBGL.
*/
renderType: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The resolution of your game. This value is read only, but can be changed at start time it via a game configuration object.
* Default: 1
*/
resolution: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Instance of repeatable random data generator helper.
*/
rnd: Phaser.RandomDataGenerator;
/**
* The game scale manager.
*/
scale: Phaser.ScaleManager;
scratch: Phaser.BitmapData;
/**
* Reference to the sound manager.
*/
sound: Phaser.SoundManager;
/**
* Reference to the stage.
*/
stage: Phaser.Stage;
/**
* The StateManager.
*/
state: Phaser.StateManager;
/**
* When stepping is enabled this contains the current step cycle.
* Default: 0
*/
stepCount: number;
/**
* Enable core loop stepping with Game.enableStep().
* Default: false
*/
stepping: boolean;
/**
* Reference to the core game clock.
*/
time: Phaser.Time;
/**
* Use a transparent canvas background or not.
* Default: false
*/
transparent: boolean;
/**
* Reference to the tween manager.
*/
tweens: Phaser.TweenManager;
/**
* The ID of the current/last logic update applied this render frame, starting from 0.
* The first update is `currentUpdateID === 0` and the last update is `currentUpdateID === updatesThisFrame.`
*/
currentUpdateID: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Number of logic updates expected to occur this render frame; will be 1 unless there are catch-ups required (and allowed).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updatesThisFrame: number;
/**
* The current Game Width in pixels.
*
* _Do not modify this property directly:_ use {@link Phaser.ScaleManager#setGameSize} - eg. `game.scale.setGameSize(width, height)` - instead.
* Default: 800
*/
width: number;
/**
* Reference to the world.
*/
world: Phaser.World;
/**
* Initialize engine sub modules and start the game.
*/
boot(): void;
/**
* Nukes the entire game from orbit.
*/
destroy(): void;
/**
* Disables core game loop stepping.
*/
disableStep(): void;
/**
* Enable core game loop stepping. When enabled you must call game.step() directly (perhaps via a DOM button?)
* Calling step will advance the game loop by one frame. This is extremely useful for hard to track down errors!
*/
enableStep(): void;
/**
* Called by the Stage visibility handler.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The DOM event that caused the game to pause, if any.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
focusGain(event: any): void;
/**
* Called by the Stage visibility handler.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The DOM event that caused the game to pause, if any.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
focusLoss(event: any): void;
/**
* Called by the Stage visibility handler.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The DOM event that caused the game to pause, if any.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
gamePaused(event: any): void;
/**
* Called by the Stage visibility handler.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The DOM event that caused the game to pause, if any.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
gameResumed(event: any): void;
/**
* Parses a Game configuration object.
*/
parseConfig(config: any): void;
removeFromDOM(canvas: HTMLCanvasElement): void;
/**
* Checks if the device is capable of using the requested renderer and sets it up or an alternative if not.
*/
setUpRenderer(): void;
/**
* Displays a Phaser version debug header in the console.
*/
showDebugHeader(): void;
/**
* When stepping is enabled you must call this function directly (perhaps via a DOM button?) to advance the game loop by one frame.
* This is extremely useful to hard to track down errors! Use the internal stepCount property to monitor progress.
*/
step(): void;
/**
* The core game loop.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param time The current time as provided by RequestAnimationFrame.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(time: number): void;
/**
* Updates all logic subsystems in Phaser. Called automatically by Game.update.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param timeStep The current timeStep value as determined by Game.update.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateLogic(timeStep: number): void;
/**
* Runs the Render cycle.
* It starts by calling State.preRender. In here you can do any last minute adjustments of display objects as required.
* It then calls the renderer, which renders the entire display list, starting from the Stage object and working down.
* It then calls plugin.render on any loaded plugins, in the order in which they were enabled.
* After this State.render is called. Any rendering that happens here will take place on-top of the display list.
* Finally plugin.postRender is called on any loaded plugins, in the order in which they were enabled.
* This method is called automatically by Game.update, you don't need to call it directly.
* Should you wish to have fine-grained control over when Phaser renders then use the `Game.lockRender` boolean.
* Phaser will only render when this boolean is `false`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param elapsedTime The time elapsed since the last update.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateRender(timeStep: number): void;
}
/**
* The GameObjectCreator is a quick way to create common game objects _without_ adding them to the game world.
* The object creator can be accessed with {@linkcode Phaser.Game#make `game.make`}.
*/
class GameObjectCreator {
/**
* The GameObjectCreator is a quick way to create common game objects _without_ adding them to the game world.
* The object creator can be accessed with {@linkcode Phaser.Game#make `game.make`}.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* A reference to the game world.
*/
world: Phaser.World;
/**
* Creates a new Sound object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The Game.cache key of the sound that this object will use.
* @param volume The volume at which the sound will be played. - Default: 1
* @param loop Whether or not the sound will loop. - Default: false
* @param connect Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio. - Default: true
* @return The newly created text object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
audio(key: string, volume?: number, loop?: boolean, connect?: boolean): Phaser.Sound;
/**
* Creates a new AudioSprite object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The Game.cache key of the sound that this object will use.
* @return The newly created AudioSprite object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
audioSprite(key: string): Phaser.AudioSprite;
/**
* Create a BitmpaData object.
*
* A BitmapData object can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of the BitmapData in pixels. - Default: 256
* @param height The height of the BitmapData in pixels. - Default: 256
* @param key Asset key for the BitmapData when stored in the Cache (see addToCache parameter). - Default: ''
* @param addToCache Should this BitmapData be added to the Game.Cache? If so you can retrieve it with Cache.getBitmapData(key) - Default: false
* @return The newly created BitmapData object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
bitmapData(width?: number, height?: number, key?: string, addToCache?: boolean): Phaser.BitmapData;
/**
* Create a new BitmapText object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new bitmapText object.
* @param y Y position of the new bitmapText object.
* @param font The key of the BitmapText font as stored in Game.Cache.
* @param text The actual text that will be rendered. Can be set later via BitmapText.text.
* @param size The size the font will be rendered in, in pixels.
* @return The newly created bitmapText object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
bitmapText(x: number, y: number, font: string, text?: string, size?: number): Phaser.BitmapText;
/**
* Creates a new Button object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new button object.
* @param y Y position of the new button object.
* @param key The image key as defined in the Game.Cache to use as the texture for this button.
* @param callback The function to call when this button is pressed
* @param callbackContext The context in which the callback will be called (usually 'this')
* @param overFrame This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.
* @param outFrame This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.
* @param downFrame This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.
* @param upFrame This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
* @return The newly created button object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
button(x?: number, y?: number, key?: string, callback?: Function, callbackContext?: any, overFrame?: any, outFrame?: any, downFrame?: any, upFrame?: any): Phaser.Button;
/**
* Creat a new Emitter.
*
* An Emitter is a lightweight particle emitter. It can be used for one-time explosions or for
* continuous effects like rain and fire. All it really does is launch Particle objects out
* at set intervals, and fixes their positions and velocities accorindgly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate within the Emitter that the particles are emitted from. - Default: 0
* @param y The y coordinate within the Emitter that the particles are emitted from. - Default: 0
* @param maxParticles The total number of particles in this emitter. - Default: 50
* @return The newly created emitter object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
emitter(x?: number, y?: number, maxParticles?: number): Phaser.Particles.Arcade.Emitter;
/**
* A WebGL shader/filter that can be applied to Sprites.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param filter The name of the filter you wish to create, for example HueRotate or SineWave.
* @param undefined Whatever parameters are needed to be passed to the filter init function.
* @return The newly created Phaser.Filter object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
filter(filter: any, ...args: any[]): Phaser.Filter;
/**
* Creates a new Graphics object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new graphics object.
* @param y Y position of the new graphics object.
* @return The newly created graphics object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
graphics(x: number, y: number): Phaser.Graphics;
/**
* A Group is a container for display objects that allows for fast pooling, recycling and collision checks.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param parent The parent Group or DisplayObjectContainer that will hold this group, if any.
* @param name A name for this Group. Not used internally but useful for debugging. - Default: 'group'
* @param addToStage If set to true this Group will be added directly to the Game.Stage instead of Game.World. - Default: false
* @param enableBody If true all Sprites created with `Group.create` or `Group.createMulitple` will have a physics body created on them. Change the body type with physicsBodyType. - Default: false
* @param physicsBodyType If enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc. - Default: 0
* @return The newly created Group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
group(parent?: any, name?: string, addToStage?: boolean, enableBody?: boolean, physicsBodyType?: number): Phaser.Group;
/**
* Create a new Image object.
*
* An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
* It can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the image.
* @param y Y position of the image.
* @param key This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.
* @return the newly created sprite object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
image(x: number, y: number, key?: any, frame?: any): Phaser.Image;
/**
* A dynamic initially blank canvas to which images can be drawn.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width the width of the RenderTexture. - Default: 100
* @param height the height of the RenderTexture. - Default: 100
* @param key Asset key for the RenderTexture when stored in the Cache (see addToCache parameter). - Default: ''
* @param addToCache Should this RenderTexture be added to the Game.Cache? If so you can retrieve it with Cache.getTexture(key) - Default: false
* @return The newly created RenderTexture object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
renderTexture(width?: number, height?: number, key?: any, addToCache?: boolean): Phaser.RenderTexture;
/**
* Create a new RetroFont object.
*
* A RetroFont can be used as a texture for an Image or Sprite and optionally add it to the Cache.
* A RetroFont uses a bitmap which contains fixed with characters for the font set. You use character spacing to define the set.
* If you need variable width character support then use a BitmapText object instead. The main difference between a RetroFont and a BitmapText
* is that a RetroFont creates a single texture that you can apply to a game object, where-as a BitmapText creates one Sprite object per letter of text.
* The texture can be asssigned or one or multiple images/sprites, but note that the text the RetroFont uses will be shared across them all,
* i.e. if you need each Image to have different text in it, then you need to create multiple RetroFont objects.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param font The key of the image in the Game.Cache that the RetroFont will use.
* @param characterWidth The width of each character in the font set.
* @param characterHeight The height of each character in the font set.
* @param chars The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.
* @param charsPerRow The number of characters per row in the font set.
* @param xSpacing If the characters in the font set have horizontal spacing between them set the required amount here. - Default: 0
* @param ySpacing If the characters in the font set have vertical spacing between them set the required amount here. - Default: 0
* @param xOffset If the font set doesn't start at the top left of the given image, specify the X coordinate offset here. - Default: 0
* @param yOffset If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here. - Default: 0
* @return The newly created RetroFont texture which can be applied to an Image or Sprite.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
retroFont(font: string, characterWidth: number, characterHeight: number, chars: string, charsPerRow: number, xSpacing?: number, ySpacing?: number, xOffset?: number, yOffset?: number): Phaser.RetroFont;
/**
* Creates a new Rope object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate (in world space) to position the Rope at.
* @param y The y coordinate (in world space) to position the Rope at.
* @param width The width of the Rope.
* @param height The height of the Rope.
* @param key This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If this Rope is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
* @return The newly created rope object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
rope(x: number, y: number, key: any, frame?: any, points?: Phaser.Point[]): Phaser.Rope;
/**
* Creates a new Sound object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The Game.cache key of the sound that this object will use.
* @param volume The volume at which the sound will be played. - Default: 1
* @param loop Whether or not the sound will loop. - Default: false
* @param connect Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio. - Default: true
* @return The newly created text object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
sound(key: string, volume?: number, loop?: boolean, connect?: boolean): Phaser.Sound;
/**
* Create a new Sprite with specific position and sprite sheet key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new sprite.
* @param y Y position of the new sprite.
* @param key This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.
* @return the newly created sprite object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
sprite(x: number, y: number, key?: any, frame?: any): Phaser.Sprite;
/**
* Create a new SpriteBatch.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param parent The parent Group or DisplayObjectContainer that will hold this group, if any.
* @param name A name for this Group. Not used internally but useful for debugging. - Default: 'group'
* @param addToStage If set to true this Group will be added directly to the Game.Stage instead of Game.World. - Default: false
* @return The newly created group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
spriteBatch(parent: any, name?: String, addToStage?: boolean): Phaser.SpriteBatch;
/**
* Creates a new Text object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new text object.
* @param y Y position of the new text object.
* @param text The actual text that will be written.
* @param style The style object containing style attributes like font, font size , etc.
* @return The newly created text object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
text(x: number, y: number, text?: string, style?: any): Phaser.Text;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Creates a new Phaser.Tilemap object.
*
* The map can either be populated with data from a Tiled JSON file or from a CSV file.
* To do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key.
* When using CSV data you must provide the key and the tileWidth and tileHeight parameters.
* If creating a blank tilemap to be populated later, you can either specify no parameters at all and then use `Tilemap.create` or pass the map and tile dimensions here.
* Note that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.
*
* @param key The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass `null`.
* @param tileWidth The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @param tileHeight The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @param width The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. - Default: 10
* @param height The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. - Default: 10
*/
tilemap(key: string, tileWidth?: number, tileHeight?: number, width?: number, height?: number): Phaser.Tilemap;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Creates a new TileSprite object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate (in world space) to position the TileSprite at.
* @param y The y coordinate (in world space) to position the TileSprite at.
* @param width The width of the TileSprite.
* @param height The height of the TileSprite.
* @param key This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
* @return The newly created tileSprite object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
tileSprite(x: number, y: number, width: number, height: number, key: any, frame: any): Phaser.TileSprite;
/**
* Create a tween object for a specific object.
*
* The object can be any JavaScript object or Phaser object such as Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param obj Object the tween will be run on.
* @return The Tween object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
tween(obj: any): Phaser.Tween;
}
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The GameObjectFactory is a quick way to create many common game objects
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* using {@linkcode Phaser.Game#add `game.add`}.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Created objects are _automatically added_ to the appropriate Manager, World, or manually specified parent Group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class GameObjectFactory {
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The GameObjectFactory is a quick way to create many common game objects
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* using {@linkcode Phaser.Game#add `game.add`}.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Created objects are _automatically added_ to the appropriate Manager, World, or manually specified parent Group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* A reference to the game world.
*/
world: Phaser.World;
/**
* Creates a new Sound object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The Game.cache key of the sound that this object will use.
* @param volume The volume at which the sound will be played. - Default: 1
* @param loop Whether or not the sound will loop. - Default: false
* @param connect Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio. - Default: true
* @return The newly created text object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
audio(key: string, volume?: number, loop?: boolean, connect?: boolean): Phaser.Sound;
/**
* Creates a new AudioSprite object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The Game.cache key of the sound that this object will use.
* @return The newly created AudioSprite object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
audioSprite(key: string): Phaser.AudioSprite;
/**
* Create a BitmapData object.
*
* A BitmapData object can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of the BitmapData in pixels. - Default: 256
* @param height The height of the BitmapData in pixels. - Default: 256
* @param key Asset key for the BitmapData when stored in the Cache (see addToCache parameter). - Default: ''
* @param addToCache Should this BitmapData be added to the Game.Cache? If so you can retrieve it with Cache.getBitmapData(key) - Default: false
* @return The newly created BitmapData object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
bitmapData(width?: number, height?: number, key?: string, addToCache?: boolean): Phaser.BitmapData;
/**
* Create a new BitmapText object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new bitmapText object.
* @param y Y position of the new bitmapText object.
* @param font The key of the BitmapText font as stored in Game.Cache.
* @param text The actual text that will be rendered. Can be set later via BitmapText.text.
* @param size The size the font will be rendered in, in pixels.
* @param group Optional Group to add the object to. If not specified it will be added to the World group.
* @return The newly created bitmapText object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
bitmapText(x: number, y: number, font: string, text?: string, size?: number, group?: Phaser.Group): Phaser.BitmapText;
/**
* Creates a new Button object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new button object.
* @param y Y position of the new button object.
* @param key The image key as defined in the Game.Cache to use as the texture for this button.
* @param callback The function to call when this button is pressed
* @param callbackContext The context in which the callback will be called (usually 'this')
* @param overFrame This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.
* @param outFrame This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.
* @param downFrame This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.
* @param upFrame This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
* @param group Optional Group to add the object to. If not specified it will be added to the World group.
* @return The newly created button object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
button(x?: number, y?: number, key?: string, callback?: Function, callbackContext?: any, overFrame?: any, outFrame?: any, downFrame?: any, upFrame?: any, group?: Phaser.Group): Phaser.Button;
/**
* Create a new Emitter.
*
* A particle emitter can be used for one-time explosions or for
* continuous effects like rain and fire. All it really does is launch Particle objects out
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* at set intervals, and fixes their positions and velocities accordingly.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate within the Emitter that the particles are emitted from. - Default: 0
* @param y The y coordinate within the Emitter that the particles are emitted from. - Default: 0
* @param maxParticles The total number of particles in this emitter. - Default: 50
* @return The newly created emitter object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
emitter(x?: number, y?: number, maxParticles?: number): Phaser.Particles.Arcade.Emitter;
/**
* Adds an existing object to the game world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object An instance of Phaser.Sprite, Phaser.Button or any other display object..
* @return The child that was added to the Group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
existing(object: any): any;
/**
* A WebGL shader/filter that can be applied to Sprites.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param filter The name of the filter you wish to create, for example HueRotate or SineWave.
* @param undefined Whatever parameters are needed to be passed to the filter init function.
* @return The newly created Phaser.Filter object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
filter(filter: string, ...args: any[]): Phaser.Filter;
/**
* Creates a new Graphics object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new graphics object.
* @param y Y position of the new graphics object.
* @param group Optional Group to add the object to. If not specified it will be added to the World group.
* @return The newly created graphics object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
graphics(x: number, y: number, group?: Phaser.Group): Phaser.Graphics;
/**
* A Group is a container for display objects that allows for fast pooling, recycling and collision checks.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param parent The parent Group or DisplayObjectContainer that will hold this group, if any. If set to null the Group won't be added to the display list. If undefined it will be added to World by default.
* @param name A name for this Group. Not used internally but useful for debugging. - Default: 'group'
* @param addToStage If set to true this Group will be added directly to the Game.Stage instead of Game.World. - Default: false
* @param enableBody If true all Sprites created with `Group.create` or `Group.createMulitple` will have a physics body created on them. Change the body type with physicsBodyType. - Default: false
* @param physicsBodyType If enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc. - Default: 0
* @return The newly created group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
group(parent?: any, name?: string, addToStage?: boolean, enableBody?: boolean, physicsBodyType?: number): Phaser.Group;
/**
* Create a new `Image` object. An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
* It can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the image.
* @param y Y position of the image.
* @param key This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.
* @param group Optional Group to add the object to. If not specified it will be added to the World group.
* @return the newly created sprite object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
image(x: number, y: number, key?: any, frame?: any, group?: Phaser.Group): Phaser.Image;
/**
* A Group is a container for display objects that allows for fast pooling, recycling and collision checks.
* A Physics Group is the same as an ordinary Group except that is has enableBody turned on by default, so any Sprites it creates
* are automatically given a physics body.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param physicsBodyType If enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc. - Default: Phaser.Physics.ARCADE
* @param parent The parent Group or DisplayObjectContainer that will hold this group, if any. If set to null the Group won't be added to the display list. If undefined it will be added to World by default.
* @param name A name for this Group. Not used internally but useful for debugging. - Default: 'group'
* @param addToStage If set to true this Group will be added directly to the Game.Stage instead of Game.World. - Default: false
* @return The newly created group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
physicsGroup(physicsBodyType: number, parent?: any, name?: string, addToStage?: boolean): Phaser.Group;
/**
* Add a new Plugin into the PluginManager.
*
* The Plugin must have 2 properties: `game` and `parent`. Plugin.game is set to the game reference the PluginManager uses, and parent is set to the PluginManager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param plugin The Plugin to add into the PluginManager. This can be a function or an existing object.
* @param args Additional parameters that will be passed to the Plugin.init method.
* @return The Plugin that was added to the manager.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
plugin(plugin: Phaser.Plugin, ...parameter: any[]): Phaser.Plugin;
/**
* A dynamic initially blank canvas to which images can be drawn.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width the width of the RenderTexture. - Default: 100
* @param height the height of the RenderTexture. - Default: 100
* @param key Asset key for the RenderTexture when stored in the Cache (see addToCache parameter). - Default: ''
* @param addToCache Should this RenderTexture be added to the Game.Cache? If so you can retrieve it with Cache.getTexture(key) - Default: false
* @return The newly created RenderTexture object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
renderTexture(width?: number, height?: number, key?: string, addToCache?: boolean): Phaser.RenderTexture;
/**
* Create a new RetroFont object.
*
* A RetroFont can be used as a texture for an Image or Sprite and optionally add it to the Cache.
* A RetroFont uses a bitmap which contains fixed with characters for the font set. You use character spacing to define the set.
* If you need variable width character support then use a BitmapText object instead. The main difference between a RetroFont and a BitmapText
* is that a RetroFont creates a single texture that you can apply to a game object, where-as a BitmapText creates one Sprite object per letter of text.
* The texture can be asssigned or one or multiple images/sprites, but note that the text the RetroFont uses will be shared across them all,
* i.e. if you need each Image to have different text in it, then you need to create multiple RetroFont objects.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param font The key of the image in the Game.Cache that the RetroFont will use.
* @param characterWidth The width of each character in the font set.
* @param characterHeight The height of each character in the font set.
* @param chars The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.
* @param charsPerRow The number of characters per row in the font set.
* @param xSpacing If the characters in the font set have horizontal spacing between them set the required amount here. - Default: 0
* @param ySpacing If the characters in the font set have vertical spacing between them set the required amount here. - Default: 0
* @param xOffset If the font set doesn't start at the top left of the given image, specify the X coordinate offset here. - Default: 0
* @param yOffset If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here. - Default: 0
* @return The newly created RetroFont texture which can be applied to an Image or Sprite.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
retroFont(font: string, characterWidth: number, characterHeight: number, chars: string, charsPerRow: number, xSpacing?: number, ySpacing?: number, xOffset?: number, yOffset?: number): Phaser.RetroFont;
/**
* Creates a new Rope object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate (in world space) to position the TileSprite at.
* @param y The y coordinate (in world space) to position the TileSprite at.
* @param key This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
* @param points An array of {Phaser.Point}.
* @param group Optional Group to add the object to. If not specified it will be added to the World group.
* @return The newly created tileSprite object.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Example usage: https://github.com/codevinsky/phaser-rope-demo/blob/master/dist/demo.js
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
rope(x: number, y: number, key: any, frame?: any, points?: Phaser.Point[]): Phaser.Rope;
/**
* Creates a new Sound object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The Game.cache key of the sound that this object will use.
* @param volume The volume at which the sound will be played. - Default: 1
* @param loop Whether or not the sound will loop. - Default: false
* @param connect Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio. - Default: true
* @return The newly created text object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
sound(key: string, volume?: number, loop?: number, connect?: boolean): Phaser.Sound;
/**
* Create a new Sprite with specific position and sprite sheet key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new sprite.
* @param y Y position of the new sprite.
* @param key This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.
* @param group Optional Group to add the object to. If not specified it will be added to the World group.
* @return the newly created sprite object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
sprite(x: number, y: number, key?: any, frame?: any, group?: Phaser.Group): Phaser.Sprite;
/**
* A SpriteBatch is a really fast version of a Phaser Group built solely for speed.
* Use when you need a lot of sprites or particles all sharing the same texture.
* The speed gains are specifically for WebGL. In Canvas mode you won't see any real difference.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param parent The parent Group that will hold this Sprite Batch. Set to `undefined` or `null` to add directly to game.world.
* @param name A name for this Sprite Batch. Not used internally but useful for debugging. - Default: 'group'
* @param addToStage If set to true this Sprite Batch will be added directly to the Game.Stage instead of the parent. - Default: false
* @return The newly created group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
spriteBatch(parent: any, name?: string, addToStage?: boolean): Phaser.Group;
/**
* Creates a new Text object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the new text object.
* @param y Y position of the new text object.
* @param text The actual text that will be written.
* @param style The style object containing style attributes like font, font size , etc.
* @param group Optional Group to add the object to. If not specified it will be added to the World group.
* @return The newly created text object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
text(x: number, y: number, text: string, style: any, group?: Phaser.Group): Phaser.Text;
/**
* Creates a new Phaser.Tilemap object.
*
* The map can either be populated with data from a Tiled JSON file or from a CSV file.
* To do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key.
* When using CSV data you must provide the key and the tileWidth and tileHeight parameters.
* If creating a blank tilemap to be populated later, you can either specify no parameters at all and then use `Tilemap.create` or pass the map and tile dimensions here.
* Note that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass `null`.
* @param tileWidth The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @param tileHeight The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @param width The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. - Default: 10
* @param height The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. - Default: 10
* @return The newly created tilemap object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
tilemap(key?: string, tileWidth?: number, tileHeight?: number, width?: number, height?: number): Phaser.Tilemap;
/**
* Creates a new TileSprite object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate (in world space) to position the TileSprite at.
* @param y The y coordinate (in world space) to position the TileSprite at.
* @param width The width of the TileSprite.
* @param height The height of the TileSprite.
* @param key This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
* @param group Optional Group to add the object to. If not specified it will be added to the World group.
* @return The newly created tileSprite object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
tileSprite(x: number, y: number, width: number, height: number, key?: any, frame?: any, group?: Phaser.Group): Phaser.TileSprite;
/**
* Create a tween on a specific object. The object can be any JavaScript object or Phaser object such as Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param obj Object the tween will be run on.
* @return The newly created Phaser.Tween object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
tween(obj: any): Phaser.Tween;
}
/**
* The Gamepad class handles gamepad input and dispatches gamepad events.
*
* Remember to call `gamepad.start()`.
*
* HTML5 GAMEPAD API SUPPORT IS AT AN EXPERIMENTAL STAGE!
* At moment of writing this (end of 2013) only Chrome supports parts of it out of the box. Firefox supports it
* via prefs flags (about:config, search gamepad). The browsers map the same controllers differently.
* This class has constants for Windows 7 Chrome mapping of XBOX 360 controller.
*/
class Gamepad {
/**
* The Gamepad class handles gamepad input and dispatches gamepad events.
*
* Remember to call `gamepad.start()`.
*
* HTML5 GAMEPAD API SUPPORT IS AT AN EXPERIMENTAL STAGE!
* At moment of writing this (end of 2013) only Chrome supports parts of it out of the box. Firefox supports it
* via prefs flags (about:config, search gamepad). The browsers map the same controllers differently.
* This class has constants for Windows 7 Chrome mapping of XBOX 360 controller.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
static BUTTON_0: number;
static BUTTON_1: number;
static BUTTON_2: number;
static BUTTON_3: number;
static BUTTON_4: number;
static BUTTON_5: number;
static BUTTON_6: number;
static BUTTON_7: number;
static BUTTON_8: number;
static BUTTON_9: number;
static BUTTON_10: number;
static BUTTON_11: number;
static BUTTON_12: number;
static BUTTON_13: number;
static BUTTON_14: number;
static BUTTON_15: number;
static AXIS_0: number;
static AXIS_1: number;
static AXIS_2: number;
static AXIS_3: number;
static AXIS_4: number;
static AXIS_5: number;
static AXIS_6: number;
static AXIS_7: number;
static AXIS_8: number;
static AXIS_9: number;
static XBOX360_A: number;
static XBOX360_B: number;
static XBOX360_X: number;
static XBOX360_Y: number;
static XBOX360_LEFT_BUMPER: number;
static XBOX360_RIGHT_BUMPER: number;
static XBOX360_LEFT_TRIGGER: number;
static XBOX360_RIGHT_TRIGGER: number;
static XBOX360_BACK: number;
static XBOX360_START: number;
static XBOX360_STICK_LEFT_BUTTON: number;
static XBOX360_STICK_RIGHT_BUTTON: number;
static XBOX360_DPAD_LEFT: number;
static XBOX360_DPAD_RIGHT: number;
static XBOX360_DPAD_UP: number;
static XBOX360_DPAD_DOWN: number;
static XBOX360_STICK_LEFT_X: number;
static XBOX360_STICK_LEFT_Y: number;
static XBOX360_STICK_RIGHT_X: number;
static XBOX360_STICK_RIGHT_Y: number;
static PS3XC_X: number;
static PS3XC_CIRCLE: number;
static PS3XC_SQUARE: number;
static PS3XC_TRIANGLE: number;
static PS3XC_L1: number;
static PS3XC_R1: number;
static PS3XC_L2: number;
static PS3XC_R2: number;
static PS3XC_SELECT: number;
static PS3XC_START: number;
static PS3XC_STICK_LEFT_BUTTON: number;
static PS3XC_STICK_RIGHT_BUTTON: number;
static PS3XC_DPAD_UP: number;
static PS3XC_DPAD_DOWN: number;
static PS3XC_DPAD_LEFT: number;
static PS3XC_DPAD_RIGHT: number;
static PS3XC_STICK_LEFT_X: number;
static PS3XC_STICK_LEFT_Y: number;
static PS3XC_STICK_RIGHT_X: number;
static PS3XC_STICK_RIGHT_Y: number;
/**
* If the gamepad input is active or not - if not active it should not be updated from Input.js
*/
active: boolean;
/**
* The context under which the callbacks are run.
*/
callbackContext: any;
disabled: boolean;
/**
* Gamepad input will only be processed if enabled.
* Default: true
*/
enabled: boolean;
/**
* Local reference to game.
*/
game: Phaser.Game;
onAxisCallBack: Function;
/**
* This callback is invoked every time any gamepad is connected
*/
onConnectCallback: Function;
/**
* This callback is invoked every time any gamepad is disconnected
*/
onDisconnectCallback: Function;
/**
* This callback is invoked every time any gamepad button is pressed down.
*/
onDownCallback: Function;
/**
* This callback is invoked every time any gamepad button is changed to a value where value > 0 and value < 1.
*/
onFloatCallback: Function;
/**
* This callback is invoked every time any gamepad button is released.
*/
onUpCallback: Function;
/**
* Gamepad #1
*/
pad1: Phaser.SinglePad;
/**
* Gamepad #2
*/
pad2: Phaser.SinglePad;
/**
* Gamepad #3
*/
pad3: Phaser.SinglePad;
/**
* Gamepad #4
*/
pad4: Phaser.SinglePad;
/**
* How many live gamepads are currently connected.
*/
padsConnected: number;
/**
* Whether or not gamepads are supported in current browser.
*/
supported: boolean;
/**
* Add callbacks to the main Gamepad handler to handle connect/disconnect/button down/button up/axis change/float value buttons.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context under which the callbacks are run.
* @param callbacks Object that takes six different callback methods:
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* onConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addCallbacks(context: any, callbacks: any): void;
/**
* Returns true if the button is currently pressed down, on ANY gamepad.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode The buttonCode of the button to check for.
* @return True if a button is currently down.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isDown(buttonCode: number): boolean;
/**
* Returns the "just pressed" state of a button from ANY gamepad connected. Just pressed is considered true if the button was pressed down within the duration given (default 250ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode The buttonCode of the button to check for.
* @param duration The duration below which the button is considered as being just pressed. - Default: 250
* @return True if the button is just pressed otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justPressed(buttonCode: number, duration?: number): boolean;
justReleased(buttonCode: number, duration?: number): boolean;
/**
* Reset all buttons/axes of all gamepads
*/
reset(): void;
/**
* Sets the deadZone variable for all four gamepads
*/
setDeadZones(value: any): void;
/**
* Starts the Gamepad event handling.
* This MUST be called manually before Phaser will start polling the Gamepad API.
*/
start(): void;
/**
* Stops the Gamepad event handling.
*/
stop(): void;
/**
* Main gamepad update loop. Should not be called manually.
*/
update(): void;
}
/**
* If you need more fine-grained control over the handling of specific buttons you can create and use Phaser.GamepadButton objects.
*/
class GamepadButton {
/**
* If you need more fine-grained control over the handling of specific buttons you can create and use Phaser.GamepadButton objects.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pad A reference to the gamepad that owns this button.
* @param buttonCode The button code this GamepadButton is responsible for.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(pad: Phaser.SinglePad, buttonCode: number);
/**
* The buttoncode of this button.
*/
buttonCode: number;
/**
* If the button is down this value holds the duration of that button press and is constantly updated.
* If the button is up it holds the duration of the previous down session. The number of milliseconds this button has been held down for.
* Default: 0
*/
duration: number;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* The "down" state of the button.
* Default: false
*/
isDown: boolean;
/**
* The "up" state of the button.
* Default: true
*/
isUp: boolean;
/**
* This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).
*/
onDown: Phaser.Signal;
/**
* This Signal is dispatched every time this GamepadButton changes floating value (between (but not exactly) 0 and 1)
*/
onFloat: Phaser.Signal;
/**
* This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).
*/
onUp: Phaser.Signal;
/**
* A reference to the gamepad that owns this button.
*/
pad: Phaser.Gamepad;
/**
* If a button is held down this holds down the number of times the button has 'repeated'.
* Default: 0
*/
repeats: number;
/**
* The timestamp when the button was last pressed down.
* Default: 0
*/
timeDown: number;
/**
* The timestamp when the button was last released.
* Default: 0
*/
timeUp: number;
/**
* Button value. Mainly useful for checking analog buttons (like shoulder triggers)
* Default: 0
*/
value: number;
/**
* Destroys this GamepadButton, this disposes of the onDown, onUp and onFloat signals and clears the pad and game references.
*/
destroy(): void;
/**
* Returns the "just pressed" state of this button. Just pressed is considered true if the button was pressed down within the duration given (default 250ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration The duration below which the button is considered as being just pressed. - Default: 250
* @return True if the button is just pressed otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justPressed(duration?: number): boolean;
justReleased(duration?: number): boolean;
/**
* Called automatically by Phaser.SinglePad.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value Button value
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processButtonDown(value: number): void;
/**
* Called automatically by Phaser.SinglePad.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value Button value
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processButtonFloat(value: number): void;
/**
* Called automatically by Phaser.SinglePad.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value Button value
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processButtonUp(value: number): void;
/**
* Resets this GamepadButton, changing it to an isUp state and resetting the duration and repeats counters.
*/
reset(): void;
}
/**
* Creates a new `Graphics` object.
*/
class Graphics extends PIXI.Graphics {
/**
* Creates a new `Graphics` object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Current game instance.
* @param x X position of the new graphics object.
* @param y Y position of the new graphics object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, x: number, y: number);
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angle property is the rotation of the Game Object in *degrees* from its original orientation.
*
* Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
*
* Values outside this range are added to or subtracted from 360 to obtain a value within the range.
* For example, the statement player.angle = 450 is the same as player.angle = 90.
*
* If you wish to work in radians instead of degrees you can use the property `rotation` instead.
* Working in radians is slightly faster as it doesn't have to perform any calculations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if `fixedToCamera` is true.
*
* The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraOffset: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* As a Game Object runs through its destroy method this flag is set to true,
* and can be checked in any sub-systems or plugins it is being destroyed from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroyPhase: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Controls if this Game Object is processed by the core game loop.
* If this Game Object has a physics body it also controls if its physics body is updated or not.
* When `exists` is set to `false` it will remove its physics body from the physics world if it has one.
* It also toggles the `visible` property to false as well.
*
* Setting `exists` to true will add its physics body back in to the physics world, if it has one.
* It will also set the `visible` property to `true`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
exists: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object that is "fixed" to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.
*
* The values are adjusted at the rendering stage, overriding the Game Objects actual world position.
*
* The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
* the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
* regardless where in the world the camera is.
*
* The offsets are stored in the `cameraOffset` property.
*
* Note that the `cameraOffset` values are in addition to any parent of this Game Object on the display list.
*
* Be careful not to set `fixedToCamera` on Game Objects which are in Groups that already have `fixedToCamera` enabled on them.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fixedToCamera: boolean;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
*/
height: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A user defined name given to this Game Object.
* This value isn't ever used internally by Phaser, it is meant as a game level property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
name: string;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The const physics body type of this object.
*/
physicsType: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The coordinate of the object relative to the local coordinates of the parent.
*/
position: Phaser.Point;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The position the Game Object was located in the previous frame.
*/
previousPosition: Point;
/**
* The rotation the Game Object was in set to in the previous frame. Value is in radians.
*/
previousRotation: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The const type of this object.
*/
type: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The world coordinates of this Game Object in pixels.
* Depending on where in the display list this Game Object is placed this value can differ from `position`,
* which contains the x/y coordinates relative to the Game Objects parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
world: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The z depth of this Game Object within its parent Group.
* No two objects in a Group can have the same z value.
* This value is adjusted automatically whenever the Group hierarchy changes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
z: number;
/**
* Destroy this Graphics instance.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param destroyChildren Should every child of this object have its destroy method called? - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(): void;
drawTriangle(points: Phaser.Point[], cull?: boolean): void;
drawTriangles(vertices: any[], indices?: number[], cull?: boolean): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Internal method called by the World postUpdate cycle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
postUpdate(): void;
/**
* Automatically called by World.preUpdate.
*/
preUpdate(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Override this method in your own custom objects to handle any update requirements.
* It is called immediately after `preUpdate` and before `postUpdate`.
* Remember if this Game Object has any children you should call update on those too.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(): void;
}
/**
* A Group is a container for {@link DisplayObject display objects} including {@link Phaser.Sprite Sprites} and {@link Phaser.Image Images}.
*
* Groups form the logical tree structure of the display/scene graph where local transformations are applied to children.
* For instance, all children are also moved/rotated/scaled when the group is moved/rotated/scaled.
*
* In addition, Groups provides support for fast pooling and object recycling.
*
* Groups are also display objects and can be nested as children within other Groups.
*/
class Group extends PIXI.DisplayObjectContainer {
/**
* A Group is a container for {@link DisplayObject display objects} including {@link Phaser.Sprite Sprites} and {@link Phaser.Image Images}.
*
* Groups form the logical tree structure of the display/scene graph where local transformations are applied to children.
* For instance, all children are also moved/rotated/scaled when the group is moved/rotated/scaled.
*
* In addition, Groups provides support for fast pooling and object recycling.
*
* Groups are also display objects and can be nested as children within other Groups.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param parent The parent Group (or other {@link DisplayObject}) that this group will be added to.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* If undefined/unspecified the Group will be added to the {@link Phaser.Game#world Game World}; if null the Group will not be added to any parent. - Default: (game world)
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name A name for this group. Not used internally but useful for debugging. - Default: 'group'
* @param addToStage If true this group will be added directly to the Game.Stage instead of Game.World. - Default: false
* @param enableBody If true all Sprites created with {@link #create} or {@link #createMulitple} will have a physics body created on them. Change the body type with {@link #physicsBodyType}. - Default: false
* @param physicsBodyType The physics body type to use when physics bodies are automatically added. See {@link #physicsBodyType} for values. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, parent?: PIXI.DisplayObjectContainer, name?: string, addToStage?: boolean, enableBody?: boolean, physicsBodyType?: number);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A returnType value, as specified in {@link Phaser.Group#iterate iterate} eg.
*/
static RETURN_CHILD: number;
/**
* A returnType value, as specified in {@link Phaser.Group#iterate iterate} eg.
*/
static RETURN_NONE: number;
/**
* A returnType value, as specified in {@link Phaser.Group#iterate iterate} eg.
*/
static RETURN_TOTAL: number;
/**
* A sort ordering value, as specified in {@link Phaser.Group#sort sort} eg.
*/
static SORT_ASCENDING: number;
/**
* A sort ordering value, as specified in {@link Phaser.Group#sort sort} eg.
*/
static SORT_DESCENDING: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
alpha: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The angle of rotation of the group container, in degrees.
*
* This adjusts the group itself by modifying its local rotation transform.
*
* This has no impact on the rotation/angle properties of the children, but it will update their worldTransform
* and on-screen orientation and position.
*/
angle: number;
/**
* The alive property is useful for Groups that are children of other Groups and need to be included/excluded in checks like forEachAlive.
* Default: true
*/
alive: boolean;
/**
* If this object is {@link Phaser.Group#fixedToCamera fixedToCamera} then this stores the x/y position offset relative to the top-left of the camera view.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If the parent of this Group is also `fixedToCamera` then the offset here is in addition to that and should typically be disabled.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraOffset: Phaser.Point;
/**
* The type of objects that will be created when using {@link Phaser.Group#create create} or {@link Phaser.Group#createMultiple createMultiple}.
*
* Any object may be used but it should extend either Sprite or Image and accept the same constructor arguments:
* when a new object is created it is passed the following parameters to its constructor: `(game, x, y, key, frame)`.
* Default: {@link Phaser.Sprite}
*/
classType: any;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The current display object that the group cursor is pointing to, if any. (Can be set manually.)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* The cursor is a way to iterate through the children in a Group using {@link Phaser.Group#next next} and {@link Phaser.Group#previous previous}.
*/
cursor: any;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The current index of the Group cursor. Advance it with Group.next.
*/
cursorIndex: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* If true all Sprites created by, or added to this group, will have a physics body enabled on them.
*
* The default body type is controlled with {@link Phaser.Group#physicsBodyType physicsBodyType}.
*/
enableBody: boolean;
/**
* If true when a physics body is created (via {@link Phaser.Group#enableBody enableBody}) it will create a physics debug object as well.
*
* This only works for P2 bodies.
* Default: false
*/
enableBodyDebug: boolean;
/**
* If exists is true the group is updated, otherwise it is skipped.
* Default: true
*/
exists: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Group that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Note that the cameraOffset values are in addition to any parent in the display list.
* So if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fixedToCamera: boolean;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* A group with `ignoreDestroy` set to `true` ignores all calls to its `destroy` method.
* Default: false
*/
ignoreDestroy: boolean;
/**
* Total number of children in this group, regardless of exists/alive status.
*/
length: number;
/**
* A name for this group. Not used internally but useful for debugging.
*/
name: string;
/**
* This signal is dispatched when the group is destroyed.
*/
onDestroy: Phaser.Signal;
/**
* If {@link Phaser.Group#enableBody enableBody} is true this is the type of physics body that is created on new Sprites.
*
* The valid values are {@link Phaser.Physics.ARCADE}, {@link Phaser.Physics.P2}, {@link Phaser.Physics.NINJA}, etc.
*/
physicsBodyType: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The const physics body type of this object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
physicsType: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The coordinate of the object relative to the local coordinates of the parent.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
position: Phaser.Point;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
rotation: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The scale of the group container.
*/
scale: Phaser.Point;
/**
* Total number of existing children in the group.
*/
total: number;
/**
* Internal Phaser Type value.
*/
type: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
visible: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The z-depth value of this object within its parent container/Group - the World is a Group as well.
* This value must be unique for each child in a Group.
*/
z: number;
/**
* Adds an existing object as the top child in this group.
*
* The child is automatically added to the top of the group and is displayed on top of every previous child.
*
* Use {@link Phaser.Group#addAt addAt} to control where a child is added. Use {@link Phaser.Group#create create} to create and add a new child.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The display object to add as a child.
* @param silent If true the child will not dispatch the `onAddedToGroup` event. - Default: false
* @return The child that was added to the group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(child: any, silent?: boolean): any;
/**
* Adds the amount to the given property on all children in this group.
*
* `Group.addAll('x', 10)` will add 10 to the child.x value for each child.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param property The property to increment, for example 'body.velocity.x' or 'angle'.
* @param amount The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.
* @param checkAlive If true the property will only be changed if the child is alive.
* @param checkVisible If true the property will only be changed if the child is visible.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addAll(property: string, amount: number, checkAlive: boolean, checkVisible: boolean): void;
/**
* Adds an existing object to this group.
*
* The child is added to the group at the location specified by the index value, this allows you to control child ordering.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The display object to add as a child.
* @param index The index within the group to insert the child to. - Default: 0
* @param silent If true the child will not dispatch the `onAddedToGroup` event. - Default: false
* @return The child that was added to the group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addAt(child: any, index: number, silent?: boolean): any;
/**
* Adds an array of existing display objects to this group.
*
* The children are automatically added to the top of the group, so render on-top of everything else within the group.
*
* TODO: Add ability to pass the children as parameters rather than having to be an array.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param children An array of display objects to add as children.
* @param silent If true the children will not dispatch the `onAddedToGroup` event. - Default: false
* @return The array of children that were added to the group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addMultiple(children: any[], silent?: boolean): any[];
/**
* Brings the given child to the top of this group so it renders above all other children.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to bring to the top of this group.
* @return The child that was moved.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Fix some errors in the definitions files for Phaser.Group
2015-04-01 22:35:08 +00:00
bringToTop(child: any): any;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Calls a function, specified by name, on all on children.
*
* The function is called for all children regardless if they are dead or alive (see callAllExists for different options).
* After the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param method Name of the function on the child to call. Deep property lookup is supported.
* @param context A string containing the context under which the method will be executed. Set to null to default to the child. - Default: null
* @param args Additional parameters that will be passed to the method.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
callAll(method: string, context: any, ...parameters: any[]): void;
/**
* Calls a function, specified by name, on all children in the group who exist (or do not exist).
*
* After the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback Name of the function on the children to call.
* @param existsValue Only children with exists=existsValue will be called.
* @param parameter Additional parameters that will be passed to the callback.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
callAllExists(callback: Function, existsValue: boolean, ...parameters: any[]): void;
/**
* Returns a reference to a function that exists on a child of the group based on the given callback array.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The object to inspect.
* @param callback The array of function names.
* @param length The size of the array (pre-calculated in callAll).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
callbackFromArray(child: any, callback: Function, length: number): void;
/**
* Quickly check that the same property across all children of this group is equal to the given value.
*
* This call doesn't descend down children, so if you have a Group inside of this group, the property will be checked on the group but not its children.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The property, as a string, to be set. For example: 'body.velocity.x'
* @param value The value that will be checked.
* @param checkAlive If set then only children with alive=true will be checked. This includes any Groups that are children. - Default: false
* @param checkVisible If set then only children with visible=true will be checked. This includes any Groups that are children. - Default: false
* @param force If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkAll(key: string[], value: any, checkAlive?: boolean, checkVisible?: boolean, force?: boolean): boolean;
/**
* Checks a property for the given value on the child.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to check the property value on.
* @param key An array of strings that make up the property that will be set.
* @param value The value that will be checked.
* @param force If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned. - Default: false
* @return True if the property was was equal to value, false if not.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkProperty(child: any, key: string[], value: any, force?: boolean): boolean;
/**
* Get the number of dead children in this group.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The number of children flagged as dead.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
countDead(): number;
/**
* Get the number of living children in this group.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The number of children flagged as alive.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
countLiving(): number;
/**
* Creates a new Phaser.Sprite object and adds it to the top of this group.
*
* Use {@link Phaser.Group#classType classType} to change the type of object creaded.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate to display the newly created Sprite at. The value is in relation to the group.x point.
* @param y The y coordinate to display the newly created Sprite at. The value is in relation to the group.y point.
* @param key The Game.cache key of the image that this Sprite will use.
* @param frame If the Sprite image contains multiple frames you can specify which one to use here.
* @param exists The default exists state of the Sprite. - Default: true
* @return The child that was created: will be a {@link Phaser.Sprite} unless {@link #classType} has been changed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
create(x: number, y: number, key: string, frame?: any, exists?: boolean): any;
/**
* Creates multiple Phaser.Sprite objects and adds them to the top of this group.
*
* Useful if you need to quickly generate a pool of identical sprites, such as bullets.
*
* By default the sprites will be set to not exist and will be positioned at 0, 0 (relative to the group.x/y).
* Use {@link Phaser.Group#classType classType} to change the type of object creaded.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param quantity The number of Sprites to create.
* @param key The Game.cache key of the image that this Sprite will use.
* @param frame If the Sprite image contains multiple frames you can specify which one to use here.
* @param exists The default exists state of the Sprite. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createMultiple(quantity: number, key: string, frame?: any, exists?: boolean): void;
/**
* Sort the children in the group according to custom sort function.
*
* The `sortHandler` is provided the two parameters: the two children involved in the comparison (a and b).
* It should return -1 if `a > b`, 1 if `a < b` or 0 if `a === b`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sortHandler The custom sort function.
* @param context The context in which the sortHandler is called. - Default: undefined
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
customSort(sortHandler: Function, context?: any): void;
/**
* Destroys this group.
*
* Removes all children, then removes this group from its parent and nulls references.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param destroyChildren If true `destroy` will be invoked on each removed child. - Default: true
* @param soft A 'soft destroy' (set to true) doesn't remove this group from its parent or null the game reference. Set to false and it does. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(destroyChildren?: boolean, soft?: boolean): void;
/**
* Divides the given property by the amount on all children in this group.
*
* `Group.divideAll('x', 2)` will half the child.x value for each child.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param property The property to divide, for example 'body.velocity.x' or 'angle'.
* @param amount The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.
* @param checkAlive If true the property will only be changed if the child is alive.
* @param checkVisible If true the property will only be changed if the child is visible.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
divideAll(property: string, amount: number, checkAlive?: boolean, checkVisible?: boolean): void;
/**
* Call a function on each child in this group.
*
* Additional arguments for the callback can be specified after the `checkExists` parameter. For example,
*
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Group.forEach(awardBonusGold, this, true, 100, 500)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* would invoke `awardBonusGold` function with the parameters `(child, 100, 500)`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Note: This check will skip any children which are Groups themselves.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The function that will be called for each applicable child. The child will be passed as the first argument.
* @param callbackContext The context in which the function should be called (usually 'this').
* @param checkExists If set only children matching for which `exists` is true will be passed to the callback, otherwise all children will be passed. - Default: false
* @param args Additional arguments to pass to the callback function, after the child item. - Default: (none)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
forEach(callback: Function, callbackContext: any, checkExists?: boolean, ...args: any[]): void;
/**
* Call a function on each alive child in this group.
*
* See {@link Phaser.Group#forEach forEach} for details.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The function that will be called for each applicable child. The child will be passed as the first argument.
* @param callbackContext The context in which the function should be called (usually 'this').
* @param args Additional arguments to pass to the callback function, after the child item. - Default: (none)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
forEachAlive(callback: Function, callbackContext: any, ...args: any[]): void;
/**
* Call a function on each dead child in this group.
*
* See {@link Phaser.Group#forEach forEach} for details.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The function that will be called for each applicable child. The child will be passed as the first argument.
* @param callbackContext The context in which the function should be called (usually 'this').
* @param args Additional arguments to pass to the callback function, after the child item. - Default: (none)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
forEachDead(callback: Function, callbackContext: any, ...args: any[]): void;
/**
* Call a function on each existing child in this group.
*
* See {@link Phaser.Group#forEach forEach} for details.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The function that will be called for each applicable child. The child will be passed as the first argument.
* @param callbackContext The context in which the function should be called (usually 'this').
* @param args Additional arguments to pass to the callback function, after the child item. - Default: (none)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
forEachExists(callback: Function, callbackContext: any): void;
/**
* Find children matching a certain predicate.
*
* For example:
*
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* var healthyList = Group.filter(function(child, index, children) {
* return child.health > 10 ? true : false;
* }, true);
* healthyList.callAll('attack');
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* Note: Currently this will skip any children which are Groups themselves.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param predicate The function that each child will be evaluated against. Each child of the group will be passed to it as its first parameter, the index as the second, and the entire child array as the third
* @param checkExists If true, only existing can be selected; otherwise all children can be selected and will be passed to the predicate. - Default: false
* @return Returns an array list containing all the children that the predicate returned true for
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
filter(predicate: Function, checkExists?: boolean): ArraySet;
/**
* Returns the child found at the given index within this group.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The index to return the child from.
* @return The child that was found at the given index, or -1 for an invalid index.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getAt(index: number): any;
/**
* Returns the child at the bottom of this group.
*
* The bottom child the child being displayed (rendered) below every other child.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The child at the bottom of the Group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getBottom(): any;
/**
* Get the first child that is alive (`child.alive === true`).
*
* This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The first alive child, or null if none found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFirstAlive(): any;
/**
* Get the first child that is dead (`child.alive === false`).
*
* This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The first dead child, or null if none found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFirstDead(): any;
/**
* Get the first display object that exists, or doesn't exist.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param exists If true, find the first existing child; otherwise find the first non-existing child. - Default: true
* @return The first child, or null if none found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFirstExists(exists: boolean): any;
/**
* Get the index position of the given child in this group, which should match the child's `z` property.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to get the index for.
* @return The index of the child or -1 if it's not a member of this group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getIndex(child: any): number;
/**
* Returns a random child from the group.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param startIndex Offset from the front of the front of the group (lowest child). - Default: 0
* @param length Restriction on the number of values you want to randomly select from. - Default: (to top)
* @return A random child of this Group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getRandom(startIndex?: number, length?: number): any;
/**
* Return the child at the top of this group.
*
* The top child is the child displayed (rendered) above every other child.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The child at the top of the Group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTop(): any;
/**
* Checks if the child has the given property.
*
* Will scan up to 4 levels deep only.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to check for the existance of the property on.
* @param key An array of strings that make up the property.
* @return True if the child has the property, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
hasProperty(child: any, key: string[]): boolean;
/**
* Iterates over the children of the group performing one of several actions for matched children.
*
* A child is considered a match when it has a property, named `key`, whose value is equal to `value`
* according to a strict equality comparison.
*
* The result depends on the `returnType`:
*
* - {@link Phaser.Group.RETURN_TOTAL RETURN_TOTAL}:
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* The callback, if any, is applied to all matching children. The number of matched children is returned.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* - {@link Phaser.Group.RETURN_NONE RETURN_NONE}:
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* The callback, if any, is applied to all matching children. No value is returned.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* - {@link Phaser.Group.RETURN_CHILD RETURN_CHILD}:
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* The callback, if any, is applied to the *first* matching child and the *first* matched child is returned.
* If there is no matching child then null is returned.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* If `args` is specified it must be an array. The matched child will be assigned to the first
* element and the entire array will be applied to the callback function.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The child property to check, i.e. 'exists', 'alive', 'health'
* @param value A child matches if `child[key] === value` is true.
* @param returnType How to iterate the children and what to return.
* @param callback Optional function that will be called on each matching child. The matched child is supplied as the first argument. - Default: null
* @param callbackContext The context in which the function should be called (usually 'this').
* @param args The arguments supplied to to the callback; the first array index (argument) will be replaced with the matched child. - Default: (none)
* @return Returns either an integer (for RETURN_TOTAL), the first matched child (for RETURN_CHILD), or null.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
iterate(key: string, value: any, returnType: number, callback?: Function, callbackContext?: any, ...args: any[]): any;
/**
* Moves the given child down one place in this group unless it's already at the bottom.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to move down in the group.
* @return The child that was moved.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Fix some errors in the definitions files for Phaser.Group
2015-04-01 22:35:08 +00:00
moveDown(child: any): any;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Moves the given child up one place in this group unless it's already at the top.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to move up in the group.
* @return The child that was moved.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveUp(child: any): any;
/**
* Multiplies the given property by the amount on all children in this group.
*
* `Group.multiplyAll('x', 2)` will x2 the child.x value for each child.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param property The property to multiply, for example 'body.velocity.x' or 'angle'.
* @param amount The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.
* @param checkAlive If true the property will only be changed if the child is alive.
* @param checkVisible If true the property will only be changed if the child is visible.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
multiplyAll(property: string, amount: number, checkAlive: boolean, checkVisible: boolean): void;
/**
* Advances the group cursor to the next (higher) object in the group.
*
* If the cursor is at the end of the group (top child) it is moved the start of the group (bottom child).
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The child the cursor now points to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
next(): void;
/**
* The core postUpdate - as called by World.
*/
postUpdate(): void;
/**
* The core preUpdate - as called by World.
*/
preUpdate(): void;
/**
* Moves the group cursor to the previous (lower) child in the group.
*
* If the cursor is at the start of the group (bottom child) it is moved to the end (top child).
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The child the cursor now points to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
previous(): void;
/**
* Removes the given child from this group.
*
* This will dispatch an `onRemovedFromGroup` event from the child (if it has one), and optionally destroy the child.
*
* If the group cursor was referring to the removed child it is updated to refer to the next child.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to remove.
* @param destroy If true `destroy` will be invoked on the removed child. - Default: false
* @param silent If true the the child will not dispatch the `onRemovedFromGroup` event. - Default: false
* @return true if the child was removed from this group, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(child: any, destroy?: boolean, silent?: boolean): boolean;
/**
* Removes all children from this group, but does not remove the group from its parent.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param destroy If true `destroy` will be invoked on each removed child. - Default: false
* @param silent If true the children will not dispatch their `onRemovedFromGroup` events. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeAll(destroy?: boolean, silent?: boolean): void;
/**
* Removes all children from this group whose index falls beteen the given startIndex and endIndex values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param startIndex The index to start removing children from.
* @param endIndex The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the group.
* @param destroy If true `destroy` will be invoked on each removed child. - Default: false
* @param silent If true the children will not dispatch their `onRemovedFromGroup` events. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeBetween(startIndex: number, endIndex?: number, destroy?: boolean, silent?: boolean): void;
/**
* Replaces a child of this group with the given newChild. The newChild cannot be a member of this group.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param oldChild The child in this group that will be replaced.
* @param newChild The child to be inserted into this group.
* @return Returns the oldChild that was replaced within this group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
replace(oldChild: any, newChild: any): any;
/**
* Sets the group cursor to the first child in the group.
*
* If the optional index parameter is given it sets the cursor to the object at that index instead.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index Set the cursor to point to a specific index. - Default: 0
* @return The child the cursor now points to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
resetCursor(index?: number): any;
/**
* Reverses all children in this group.
*
* This operaation applies only to immediate children and does not propagate to subgroups.
*/
reverse(): void;
/**
* Sends the given child to the bottom of this group so it renders below all other children.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to send to the bottom of this group.
* @return The child that was moved.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
sendToBack(child: any): any;
/**
* Quickly set a property on a single child of this group to a new value.
*
* The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to set the property on.
* @param key The property, as a string, to be set. For example: 'body.velocity.x'
* @param value The value that will be set.
* @param checkAlive If set then the child will only be updated if alive=true. - Default: false
* @param checkVisible If set then the child will only be updated if visible=true. - Default: false
* @param operation Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it. - Default: 0
* @param force If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set. - Default: false
* @return True if the property was set, false if not.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
set(child: any, key: string[], value: any, operation?: number, force?: boolean): boolean;
/**
* Quickly set the same property across all children of this group to a new value.
*
* This call doesn't descend down children, so if you have a Group inside of this group, the property will be set on the group but not its children.
* If you need that ability please see `Group.setAllChildren`.
*
* The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The property, as a string, to be set. For example: 'body.velocity.x'
* @param value The value that will be set.
* @param checkAlive If set then only children with alive=true will be updated. This includes any Groups that are children. - Default: false
* @param checkVisible If set then only children with visible=true will be updated. This includes any Groups that are children. - Default: false
* @param operation Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it. - Default: 0
* @param force If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
setAll(key: string, value: any, checkAlive?: boolean, checkVisible?: boolean, operation?: number, force?: boolean): void;
/**
* Quickly set the same property across all children of this group, and any child Groups, to a new value.
*
* If this group contains other Groups then the same property is set across their children as well, iterating down until it reaches the bottom.
* Unlike with `setAll` the property is NOT set on child Groups itself.
*
* The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.
*
* @param key The property, as a string, to be set. For example: 'body.velocity.x'
* @param value The value that will be set.
* @param checkAlive If set then only children with alive=true will be updated. This includes any Groups that are children. - Default: false
* @param checkVisible If set then only children with visible=true will be updated. This includes any Groups that are children. - Default: false
* @param operation Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it. - Default: 0
* @param force If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set. - Default: false
*/
setAllChildren(key: string, value: any, checkAlive?: boolean, checkVisible?: boolean, operation?: number, force?: boolean): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Sets a property to the given value on the child. The operation parameter controls how the value is set.
*
* The operations are:
* - 0: set the existing value to the given value; if force is `true` a new property will be created if needed
* - 1: will add the given value to the value already present.
* - 2: will subtract the given value from the value already present.
* - 3: will multiply the value already present by the given value.
* - 4: will divide the value already present by the given value.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child The child to set the property value on.
* @param key An array of strings that make up the property that will be set.
* @param value The value that will be set.
* @param operation Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it. - Default: 0
* @param force If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set. - Default: false
* @return True if the property was set, false if not.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setProperty(child: any, key: string[], value: any, operation?: number, force?: boolean): boolean;
/**
* Sort the children in the group according to a particular key and ordering.
*
* Call this function to sort the group according to a particular key value and order.
* For example to depth sort Sprites for Zelda-style game you might call `group.sort('y', Phaser.Group.SORT_ASCENDING)` at the bottom of your `State.update()`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The name of the property to sort on. Defaults to the objects z-depth value. - Default: 'z'
* @param order Order ascending ({@link Phaser.Group.SORT_ASCENDING SORT_ASCENDING}) or descending ({@link Phaser.Group.SORT_DESCENDING SORT_DESCENDING}). - Default: Phaser.Group.SORT_ASCENDING
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
sort(key?: string, order?: number): void;
/**
* Subtracts the amount from the given property on all children in this group.
*
* `Group.subAll('x', 10)` will minus 10 from the child.x value for each child.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param property The property to decrement, for example 'body.velocity.x' or 'angle'.
* @param amount The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.
* @param checkAlive If true the property will only be changed if the child is alive.
* @param checkVisible If true the property will only be changed if the child is visible.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
subAll(property: string, amount: number, checkAlive: boolean, checkVisible: boolean): void;
/**
* Swaps the position of two children in this group.
*
* Both children must be in this group, a child cannot be swapped with itself, and unparented children cannot be swapped.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param child1 The first child to swap.
* @param child2 The second child to swap.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
swap(child1: any, child2: any): boolean;
/**
* The core update - as called by World.
*/
update(): void;
/**
* Internal method that re-applies all of the childrens Z values.
*
* This must be called whenever children ordering is altered so that their `z` indices are correctly updated.
*/
updateZ(): void;
/**
* Positions the child found at the given index within this group to the given x and y coordinates.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The index of the child in the group to set the position of.
* @param x The new x position of the child.
* @param y The new y position of the child.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
xy(index: number, x: number, y: number): void;
}
/**
* An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
* It can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.
*/
class Image extends PIXI.Sprite {
/**
* An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
* It can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param x The x coordinate of the Image. The coordinate is relative to any parent container this Image may be in.
* @param y The y coordinate of the Image. The coordinate is relative to any parent container this Image may be in.
* @param key The texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
* @param frame If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, x: number, y: number, key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture, frame: string|number);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A useful flag to control if the Game Object is alive or dead.
*
* This is set automatically by the Health components `damage` method should the object run out of health.
* Or you can toggle it via your game code.
*
* This property is mostly just provided to be used by your game - it doesn't effect rendering or logic updates.
* However you can use `Group.getFirstAlive` in conjunction with this property for fast object pooling and recycling.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: true
*/
alive: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angle property is the rotation of the Game Object in *degrees* from its original orientation.
*
* Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
*
* Values outside this range are added to or subtracted from 360 to obtain a value within the range.
* For example, the statement player.angle = 450 is the same as player.angle = 90.
*
* If you wish to work in radians instead of degrees you can use the property `rotation` instead.
* Working in radians is slightly faster as it doesn't have to perform any calculations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle: number;
/**
* The anchor sets the origin point of the texture.
* The default is 0,0 this means the texture's origin is the top left
* Setting than anchor to 0.5,0.5 means the textures origin is centered
* Setting the anchor to 1,1 would mean the textures origin points will be the bottom right corner
*/
anchor: Phaser.Point;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance.
* Through it you can create, play, pause and stop animations.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
animations: Phaser.AnimationManager;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object with `autoCull` set to true will check its bounds against the World Camera every frame.
* If it is not intersecting the Camera bounds at any point then it has its `renderable` property set to `false`.
* This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.
*
* This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
* or you have tested performance and find it acceptable.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: false
*/
autoCull: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The sum of the y and height properties.
* This is the same as `y + height - offsetY`.
*/
bottom: number;
/**
* The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if `fixedToCamera` is true.
*
* The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraOffset: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The Rectangle used to crop the texture this Game Object uses.
* Set this property via `crop`.
* If you modify this property directly you must call `updateCrop` in order to have the change take effect.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: null
*/
cropRect: Phaser.Rectangle;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A debug flag designed for use with `Game.enableStep`.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
* Default: false
*/
debug: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
deltaX: number;
deltaY: number;
deltaZ: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* As a Game Object runs through its destroy method this flag is set to true,
* and can be checked in any sub-systems or plugins it is being destroyed from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroyPhase: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
* Game Object, or any of its components.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
events: Phaser.Events;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Controls if this Game Object is processed by the core game loop.
* If this Game Object has a physics body it also controls if its physics body is updated or not.
* When `exists` is set to `false` it will remove its physics body from the physics world if it has one.
* It also toggles the `visible` property to false as well.
*
* Setting `exists` to true will add its physics body back in to the physics world, if it has one.
* It will also set the `visible` property to `true`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
exists: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object that is "fixed" to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.
*
* The values are adjusted at the rendering stage, overriding the Game Objects actual world position.
*
* The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
* the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
* regardless where in the world the camera is.
*
* The offsets are stored in the `cameraOffset` property.
*
* Note that the `cameraOffset` values are in addition to any parent of this Game Object on the display list.
*
* Be careful not to set `fixedToCamera` on Game Objects which are in Groups that already have `fixedToCamera` enabled on them.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fixedToCamera: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Gets or sets the current frame index of the texture being used to render this Game Object.
*
* To change the frame set `frame` to the index of the new frame in the sprite sheet you wish this Game Object to use,
* for example: `player.frame = 4`.
*
* If the frame index given doesn't exist it will revert to the first frame found in the texture.
*
* If you are using a texture atlas then you should use the `frameName` property instead.
*
* If you wish to fully replace the texture being used see `loadTexture`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
frame: string|number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Gets or sets the current frame name of the texture being used to render this Game Object.
*
* To change the frame set `frameName` to the name of the new frame in the texture atlas you wish this Game Object to use,
* for example: `player.frameName = "idle"`.
*
* If the frame name given doesn't exist it will revert to the first frame found in the texture and throw a console warning.
*
* If you are using a sprite sheet then you should use the `frame` property instead.
*
* If you wish to fully replace the texture being used see `loadTexture`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
frameName: string;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* A Game Object is considered `fresh` if it has just been created or reset and is yet to receive a renderer transform update.
* This property is mostly used internally by the physics systems, but is exposed for the use of plugins.
*/
fresh: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Checks if the Game Objects bounds intersect with the Game Camera bounds.
* Returns `true` if they do, otherwise `false` if fully outside of the Cameras bounds.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inCamera: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The Input Handler for this Game Object.
*
* By default it is disabled. If you wish this Game Object to process input events you should enable it with: `inputEnabled = true`.
*
* After you have done this, this property will be a reference to the Phaser InputHandler.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
input: Phaser.InputHandler;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* By default a Game Object won't process any input events. By setting `inputEnabled` to true a Phaser.InputHandler is created
* for this Game Object and it will then start to process click / touch events and more.
*
* You can then access the Input Handler via `this.input`.
*
* Note that Input related events are dispatched from `this.events`, i.e.: `events.onInputDown`.
*
* If you set this property to false it will stop the Input Handler from processing any more input events.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inputEnabled: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
inWorld: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The key of the image or texture used by this Game Object during rendering.
* If it is a string it's the string used to retrieve the texture from the Phaser.Cache.
* It can also be an instance of a RenderTexture, BitmapData or PIXI.Texture.
* If a Game Object is created without a key it is automatically assigned the key `__default` which is a 32x32 transparent PNG stored within the Cache.
* If a Game Object is given a key which doesn't exist in the Cache it is re-assigned the key `__missing` which is a 32x32 PNG of a green box with a line through it.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The left coordinate of the Game Object.
* This is the same as `x - offsetX`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
left: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A user defined name given to this Game Object.
* This value isn't ever used internally by Phaser, it is meant as a game level property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
name: string;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The amount the Game Object is visually offset from its x coordinate.
* This is the same as `width * anchor.x`.
* It will only be > 0 if anchor.x is not equal to zero.
*/
offsetX: number;
/**
* The amount the Game Object is visually offset from its y coordinate.
* This is the same as `height * anchor.y`.
* It will only be > 0 if anchor.y is not equal to zero.
*/
offsetY: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The coordinate of the object relative to the local coordinates of the parent.
*/
position: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The position the Game Object was located in the previous frame.
*/
previousPosition: Phaser.Point;
/**
* The rotation the Game Object was in set to in the previous frame. Value is in radians.
*/
previousRotation: number;
/**
* The render order ID is used internally by the renderer and Input Manager and should not be modified.
* This property is mostly used internally by the renderers, but is exposed for the use of plugins.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
renderOrderID: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The right coordinate of the Game Object.
* This is the same as `x + width - offsetX`.
*/
right: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The scale factor of the object.
*/
scale: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Enable or disable texture smoothing for this Game Object.
*
* It only takes effect if the Game Object is using an image based texture.
*
* Smoothing is enabled by default.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
smoothed: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The y coordinate of the Game Object.
* This is the same as `y - offsetY`.
*/
top: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The const type of this object.
*/
type: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The world coordinates of this Game Object in pixels.
* Depending on where in the display list this Game Object is placed this value can differ from `position`,
* which contains the x/y coordinates relative to the Game Objects parent.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
world: Phaser.Point;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The z depth of this Game Object within its parent Group.
* No two objects in a Group can have the same z value.
* This value is adjusted automatically whenever the Group hierarchy changes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
z: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Brings this Game Object to the top of its parents display list.
* Visually this means it will render over the top of any old child in the same Group.
*
* If this Game Object hasn't been added to a custom Group then this method will bring it to the top of the Game World,
* because the World is the root Group from which all Game Objects descend.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
bringToTop(): Phaser.Image;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Crop allows you to crop the texture being used to display this Game Object.
* Setting a crop rectangle modifies the core texture frame. The Game Object width and height properties will be adjusted accordingly.
*
* Cropping takes place from the top-left and can be modified in real-time either by providing an updated rectangle object to this method,
* or by modifying `cropRect` property directly and then calling `updateCrop`.
*
* The rectangle object given to this method can be either a `Phaser.Rectangle` or any other object
* so long as it has public `x`, `y`, `width`, `height`, `right` and `bottom` properties.
*
* A reference to the rectangle is stored in `cropRect` unless the `copy` parameter is `true`,
* in which case the values are duplicated to a local object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rect The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param copy If false `cropRect` will be stored as a reference to the given rect. If true it will copy the rect values into a local Phaser Rectangle object stored in cropRect. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
crop(rect: Phaser.Rectangle, copy?: boolean): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Destroy this DisplayObject.
* Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(destroyChildren?: boolean): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Kills a Game Object. A killed Game Object has its `alive`, `exists` and `visible` properties all set to false.
*
* It will dispatch the `onKilled` event. You can listen to `events.onKilled` for the signal.
*
* Note that killing a Game Object is a way for you to quickly recycle it in an object pool,
* it doesn't destroy the object or free it up from memory.
*
* If you don't need this Game Object any more you should call `destroy` instead.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
kill(): Phaser.Image;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the `frame` or `frameName` properties instead.
*
* You should only use `loadTexture` if you want to replace the base texture entirely.
*
* Calling this method causes a WebGL texture update, so use sparingly or in low-intensity portions of your game, or if you know the new texture is already on the GPU.
*
* @param key This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
* @param frame If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
* @param stopAnimation If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
loadTexture(key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture, frame: string|number): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Internal method called by the World postUpdate cycle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
postUpdate(): void;
/**
* Automatically called by World.preUpdate.
*/
preUpdate(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Resets the Game Object.
*
* This moves the Game Object to the given x/y world coordinates and sets `fresh`, `exists`,
* `visible` and `renderable` to true.
*
* If this Game Object has the LifeSpan component it will also set `alive` to true and `health` to the given value.
*
* If this Game Object has a Physics Body it will reset the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param x The x coordinate (in world space) to position the Game Object at.
* @param y The y coordinate (in world space) to position the Game Object at.
* @param health The health to give the Game Object if it has the Health component. - Default: 1
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(x: number, y: number): Phaser.Image;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Resets the texture frame dimensions that the Game Object uses for rendering.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
resetFrame(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Brings a 'dead' Game Object back to life, optionally resetting its health value in the process.
*
* A resurrected Game Object has its `alive`, `exists` and `visible` properties all set to true.
*
* It will dispatch the `onRevived` event. Listen to `events.onRevived` for the signal.
*
* @param health The health to give the Game Object. Only set if the GameObject has the Health component. - Default: 1
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
revive(): Phaser.Image;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Sets the texture frame the Game Object uses for rendering.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This is primarily an internal method used by `loadTexture`, but is exposed for the use of plugins and custom classes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param frame The Frame to be used by the texture.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setFrame(frame: Phaser.Frame): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
setScaleMinMax(minX?: number, minY?: number, maxX?: number, maxY?: number): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Override this method in your own custom objects to handle any update requirements.
* It is called immediately after `preUpdate` and before `postUpdate`.
* Remember if this Game Object has any children you should call update on those too.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If you have set a crop rectangle on this Game Object via `crop` and since modified the `cropRect` property,
* or the rectangle it references, then you need to update the crop frame by calling this method.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateCrop(): void;
}
/**
* Phaser.Input is the Input Manager for all types of Input across Phaser, including mouse, keyboard, touch and MSPointer.
* The Input manager is updated automatically by the core game loop.
*/
class Input {
/**
* Phaser.Input is the Input Manager for all types of Input across Phaser, including mouse, keyboard, touch and MSPointer.
* The Input manager is updated automatically by the core game loop.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Current game instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* The maximum number of pointers that can be added. This excludes the mouse pointer.
*/
static MAX_POINTERS: number;
static MOUSE_OVERRIDES_TOUCH: number;
static MOUSE_TOUCH_COMBINE: number;
static TOUCH_OVERRIDES_MOUSE: number;
/**
* The most recently active Pointer object.
* When you've limited max pointers to 1 this will accurately be either the first finger touched or mouse.
*/
activePointer: Phaser.Pointer;
/**
* A Circle object centered on the x/y screen coordinates of the Input.
* Default size of 44px (Apples recommended "finger tip" size) but can be changed to anything.
*/
circle: Phaser.Circle;
/**
* The current number of active Pointers.
*/
currentPointers: number;
disabled: boolean;
/**
* When enabled, input (eg. Keyboard, Mouse, Touch) will be processed - as long as the individual sources are enabled themselves.
*
* When not enabled, _all_ input sources are ignored. To disable just one type of input; for example, the Mouse, use `input.mouse.enabled = false`.
* Default: true
*/
enabled: boolean;
/**
* The number of milliseconds between taps of the same Pointer for it to be considered a double tap / click.
* Default: 300
*/
doubleTapRate: number;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* The Gamepad Input manager.
*/
gamepad: Phaser.Gamepad;
/**
* The canvas to which single pixels are drawn in order to perform pixel-perfect hit detection.
* Default: null
*/
hitCanvas: HTMLCanvasElement;
/**
* The context of the pixel perfect hit canvas.
* Default: null
*/
hitContext: CanvasRenderingContext2D;
/**
* The number of milliseconds that the Pointer has to be pressed down for it to fire a onHold event.
* Default: 2000
*/
holdRate: number;
/**
* A list of interactive objects. The InputHandler components add and remove themselves from this list.
*/
interactiveItems: Phaser.ArraySet;
/**
* The number of milliseconds below which the Pointer is considered justPressed.
* Default: 200
*/
justPressedRate: number;
/**
* The number of milliseconds below which the Pointer is considered justReleased .
* Default: 200
*/
justReleasedRate: number;
/**
* The Keyboard Input manager.
*/
keyboard: Phaser.Keyboard;
/**
* The maximum number of Pointers allowed to be active at any one time. A value of -1 is only limited by the total number of pointers. For lots of games it's useful to set this to 1.
* Default: -1 (Limited by total pointers.)
*/
maxPointers: number;
/**
* You can tell all Pointers to ignore any object with a priorityID lower than the minPriorityID. Useful when stacking UI layers. Set to zero to disable.
* Default: 0
*/
minPriorityID: number;
/**
* The Mouse Input manager.
*/
mouse: Phaser.Mouse;
/**
* The mouse has its own unique Phaser.Pointer object which you can use if making a desktop specific game.
*/
mousePointer: Phaser.Pointer;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* An optional callback that will be fired every time the activePointer receives a move event from the DOM. Set to null to disable.
*/
moveCallback: (pointer: Phaser.Pointer, x: number, y: number) => void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* An array of callbacks that will be fired every time the activePointer receives a move event from the DOM.
*/
moveCallbacks: (pointer: Phaser.Pointer, x: number, y: number) => void[];
/**
* The context in which the moveCallback will be sent. Defaults to Phaser.Input but can be set to any valid JS object.
*/
moveCallbackContext: any;
/**
* The MSPointer Input manager.
*/
mspointer: Phaser.MSPointer;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Controls the expected behavior when using a mouse and touch together on a multi-input device.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
multiInputOverride: number;
/**
* A Signal that is dispatched each time a pointer is pressed down.
*/
onDown: Phaser.Signal;
/**
* A Signal that is dispatched each time a pointer is held down.
*/
onHold: Phaser.Signal;
/**
* A Signal that is dispatched each time a pointer is tapped.
*/
onTap: Phaser.Signal;
/**
* A Signal that is dispatched each time a pointer is released.
*/
onUp: Phaser.Signal;
/**
* A Pointer object.
*/
pointer1: Phaser.Pointer;
/**
* A Pointer object.
*/
pointer2: Phaser.Pointer;
/**
* A Pointer object.
*/
pointer3: Phaser.Pointer;
/**
* A Pointer object.
*/
pointer4: Phaser.Pointer;
/**
* A Pointer object.
*/
pointer5: Phaser.Pointer;
/**
* A Pointer object.
*/
pointer6: Phaser.Pointer;
/**
* A Pointer object.
*/
pointer7: Phaser.Pointer;
/**
* A Pointer object.
*/
pointer8: Phaser.Pointer;
/**
* A Pointer object.
*/
pointer9: Phaser.Pointer;
/**
* A Pointer object.
*/
pointer10: Phaser.Pointer;
/**
* True if the Input is currently poll rate locked.
*/
pollLocked: boolean;
/**
* How often should the input pointers be checked for updates? A value of 0 means every single frame (60fps); a value of 1 means every other frame (30fps) and so on.
* Default: 0
*/
pollRate: number;
/**
* A point object representing the current position of the Pointer.
* Default: null
*/
position: Phaser.Point;
pointer: Phaser.Pointer[];
/**
* The total number of entries that can be recorded into the Pointer objects tracking history.
* If the Pointer is tracking one event every 100ms; then a trackLimit of 100 would store the last 10 seconds worth of history.
* Default: 100
*/
recordLimit: number;
/**
* Sets if the Pointer objects should record a history of x/y coordinates they have passed through.
* The history is cleared each time the Pointer is pressed down.
* The history is updated at the rate specified in Input.pollRate
* Default: false
*/
recordPointerHistory: boolean;
/**
* The rate in milliseconds at which the Pointer objects should update their tracking history.
* Default: 100
*/
recordRate: number;
/**
* If the Input Manager has been reset locked then all calls made to InputManager.reset, such as from a State change, are ignored.
* Default: false
*/
resetLocked: boolean;
/**
* The scale by which all input coordinates are multiplied; calculated by the ScaleManager. In an un-scaled game the values will be x = 1 and y = 1.
*/
scale: Phaser.Point;
/**
* A point object representing the speed of the Pointer. Only really useful in single Pointer games; otherwise see the Pointer objects directly.
*/
speed: Phaser.Point;
/**
* The number of milliseconds that the Pointer has to be pressed down and then released to be considered a tap or click.
* Default: 200
*/
tapRate: number;
/**
* The total number of active Pointers, not counting the mouse pointer.
*/
totalActivePointers: number;
/**
* The total number of inactive Pointers.
*/
totalInactivePointers: number;
/**
* the Touch Input manager.
*/
touch: Phaser.Touch;
/**
* The world X coordinate of the most recently active pointer.
*/
worldX: number;
/**
* The world Y coordinate of the most recently active pointer.
*/
worldY: number;
/**
* The X coordinate of the most recently active pointer.
* This value takes game scaling into account automatically. See Pointer.screenX/clientX for source values.
*/
x: number;
/**
* The Y coordinate of the most recently active pointer.
* This value takes game scaling into account automatically. See Pointer.screenY/clientY for source values.
*/
y: number;
/**
* Add a new Pointer object to the Input Manager.
* By default Input creates 3 pointer objects: `mousePointer` (not include in part of general pointer pool), `pointer1` and `pointer2`.
* This method adds an additional pointer, up to a maximum of Phaser.Input.MAX_POINTERS (default of 10).
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The new Pointer object that was created; null if a new pointer could not be added.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addPointer(): Phaser.Pointer;
/**
* Adds a callback that is fired every time the activePointer receives a DOM move event such as a mousemove or touchmove.
*
* The callback will be sent 4 parameters: The Pointer that moved, the x position of the pointer, the y position and the down state.
* It will be called every time the activePointer moves, which in a multi-touch game can be a lot of times, so this is best
* to only use if you've limited input to a single pointer (i.e. mouse or touch).
* The callback is added to the Phaser.Input.moveCallbacks array and should be removed with Phaser.Input.deleteMoveCallback.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The callback that will be called each time the activePointer receives a DOM move event.
* @param context The context in which the callback will be called.
* @return The index of the callback entry. Use this index when calling Input.deleteMoveCallback.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addMoveCallback(callback: Function, context: any): number;
/**
* Starts the Input Manager running.
*/
boot(): void;
countActivePointers(limit?: number): number;
/**
* Removes the callback at the defined index from the Phaser.Input.moveCallbacks array
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The index of the callback to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deleteMoveCallback(index: number): void;
/**
* Stops all of the Input Managers from running.
*/
destroy(): void;
/**
* This will return the local coordinates of the specified displayObject based on the given Pointer.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The DisplayObject to get the local coordinates for.
* @param pointer The Pointer to use in the check against the displayObject.
* @return A point containing the coordinates of the Pointer position relative to the DisplayObject.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getLocalPosition(displayObject: any, pointer: Phaser.Pointer): Phaser.Point;
/**
* Get the first Pointer with the given active state.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param isActive The state the Pointer should be in - active or innactive? - Default: false
* @return A Pointer object or null if no Pointer object matches the requested state.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getPointer(isActive?: boolean): Phaser.Pointer;
/**
* Get the Pointer object whos `pointerId` property matches the given value.
*
* The pointerId property is not set until the Pointer has been used at least once, as its populated by the DOM event.
* Also it can change every time you press the pointer down if the browser recycles it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointerId The `pointerId` (not 'id') value to search for.
* @return A Pointer object or null if no Pointer object matches the requested identifier.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getPointerFromId(pointerID: number): Phaser.Pointer;
/**
* Get the Pointer object whos `identifier` property matches the given identifier value.
*
* The identifier property is not set until the Pointer has been used at least once, as its populated by the DOM event.
* Also it can change every time you press the pointer down, and is not fixed once set.
* Note: Not all browsers set the identifier property and it's not part of the W3C spec, so you may need getPointerFromId instead.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param identifier The Pointer.identifier value to search for.
* @return A Pointer object or null if no Pointer object matches the requested identifier.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getPointerFromIdentifier(identifier: number): Phaser.Pointer;
/**
* Tests if the pointer hits the given object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The displayObject to test for a hit.
* @param pointer The pointer to use for the test.
* @param localPoint The local translated point.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
hitTest(displayObject: PIXI.DisplayObject, pointer: Phaser.Pointer, localPoint: Phaser.Point): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Reset all of the Pointers and Input states.
*
* The optional `hard` parameter will reset any events or callbacks that may be bound.
* Input.reset is called automatically during a State change or if a game loses focus / visibility.
* To control control the reset manually set {@link Phaser.InputManager.resetLocked} to `true`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param hard A soft reset won't reset any events or callbacks that are bound. A hard reset will. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(hard?: boolean): void;
/**
* Resets the speed and old position properties.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x Sets the oldPosition.x value.
* @param y Sets the oldPosition.y value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
resetSpeed(x: number, y: number): void;
/**
* Find the first free Pointer object and start it, passing in the event data.
* This is called automatically by Phaser.Touch and Phaser.MSPointer.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The event data from the Touch event.
* @return The Pointer object that was started or null if no Pointer object is available.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
startPointer(event: any): Phaser.Pointer;
/**
* Stops the matching Pointer object, passing in the event data.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The event data from the Touch event.
* @return The Pointer object that was stopped or null if no Pointer object is available.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
stopPointer(event: any): Phaser.Pointer;
/**
* Updates the Input Manager. Called by the core Game loop.
*/
update(): void;
/**
* Updates the matching Pointer object, passing in the event data.
* This is called automatically and should not normally need to be invoked.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The event data from the Touch event.
* @return The Pointer object that was updated; null if no pointer was updated.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updatePointer(event: any): Phaser.Pointer;
}
/**
* The Input Handler is bound to a specific Sprite and is responsible for managing all Input events on that Sprite.
*/
class InputHandler {
/**
* The Input Handler is bound to a specific Sprite and is responsible for managing all Input events on that Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The Sprite object to which this Input Handler belongs.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(sprite: Phaser.Sprite);
/**
* Controls if the Sprite is allowed to be dragged horizontally.
* Default: true
*/
allowHorizontalDrag: boolean;
/**
* Controls if the Sprite is allowed to be dragged vertically.
* Default: true
*/
allowVerticalDrag: boolean;
/**
* A region of the game world within which the sprite is restricted during drag.
* Default: null
*/
boundsRect: Phaser.Rectangle;
/**
* A Sprite the bounds of which this sprite is restricted during drag.
* Default: null
*/
boundsSprite: Phaser.Sprite;
/**
* If true when this Sprite is clicked or dragged it will automatically be bought to the top of the Group it is within.
* Default: false
*/
bringToTop: boolean;
/**
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
* If this object is set to consume the pointer event then it will stop all propagation from this object on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* For example if you had a stack of 6 sprites with the same priority IDs and one consumed the event, none of the others would receive it.
* Default: false
*/
consumePointerEvent: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The offset from the Sprites position that dragging takes place from.
*/
dragOffset: Phaser.Point;
/**
* Is the Sprite dragged from its center, or the point at which the Pointer was pressed down upon it?
*/
dragFromCenter: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Is this sprite allowed to be dragged by the mouse? true = yes, false = no
* Default: false
*/
draggable: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The Point from which the most recent drag started from. Useful if you need to return an object to its starting position.
*/
dragStartPoint: Phaser.Point;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* If enabled the Input Handler will process input requests and monitor pointer activity.
* Default: false
*/
enabled: boolean;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* Warning: EXPERIMENTAL
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
globalToLocalX(x: number): number;
/**
* Warning: EXPERIMENTAL
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param y
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
globalToLocalY(y: number): number;
/**
* true if the Sprite is being currently dragged.
* Default: false
*/
isDragged: boolean;
/**
* The alpha tolerance threshold. If the alpha value of the pixel matches or is above this value, it's considered a hit.
* Default: 255
*/
pixelPerfectAlpha: number;
/**
* Set to true to use pixel perfect hit detection when checking if the pointer is over this Sprite when it's clicked or touched.
* The x/y coordinates of the pointer are tested against the image in combination with the InputHandler.pixelPerfectAlpha value.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This feature only works for display objects with image based textures such as Sprites. It won't work on BitmapText or Rope.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Warning: This is expensive so only enable if you really need it. Use a pixel perfect check when testing for clicks or touches on the Sprite.
* Default: false
*/
pixelPerfectClick: boolean;
/**
* Set to true to use pixel perfect hit detection when checking if the pointer is over this Sprite.
* The x/y coordinates of the pointer are tested against the image in combination with the InputHandler.pixelPerfectAlpha value.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This feature only works for display objects with image based textures such as Sprites. It won't work on BitmapText or Rope.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Warning: This is expensive, especially on mobile (where it's not even needed!) so only enable if required. Also see the less-expensive InputHandler.pixelPerfectClick. Use a pixel perfect check when testing for pointer over.
* Default: false
*/
pixelPerfectOver: boolean;
/**
* The priorityID is used to determine which game objects should get priority when input events occur. For example if you have
* several Sprites that overlap, by default the one at the top of the display list is given priority for input events. You can
* stop this from happening by controlling the priorityID value. The higher the value, the more important they are considered to the Input events.
* Default: 0
*/
priorityID: number;
/**
* EXPERIMENTAL: Please do not use this property unless you know what it does. Likely to change in the future.
*/
scaleLayer: boolean;
/**
* A Point object that contains by how far the Sprite snap is offset.
* Default: null
*/
snapOffset: Phaser.Point;
/**
* This defines the top-left X coordinate of the snap grid.
* Default: 0
*/
snapOffsetX: number;
/**
* This defines the top-left Y coordinate of the snap grid..
* Default: 0
*/
snapOffsetY: number;
/**
* When the Sprite is dragged this controls if the center of the Sprite will snap to the pointer on drag or not.
* Default: false
*/
snapOnDrag: boolean;
/**
* When the Sprite is dragged this controls if the Sprite will be snapped on release.
* Default: false
*/
snapOnRelease: boolean;
/**
* When a Sprite has snapping enabled this holds the width of the snap grid.
* Default: 0
*/
snapX: number;
/**
* When a Sprite has snapping enabled this holds the height of the snap grid.
* Default: 0
*/
snapY: number;
/**
* The Sprite object to which this Input Handler belongs.
*/
sprite: Phaser.Sprite;
/**
* On a desktop browser you can set the 'hand' cursor to appear when moving over the Sprite.
* Default: false
*/
useHandCursor: boolean;
/**
* Bounds Rect check for the sprite drag
*/
checkBoundsRect(): void;
/**
* Parent Sprite Bounds check for the sprite drag.
*/
checkBoundsSprite(): void;
/**
* Runs a pixel perfect check against the given x/y coordinates of the Sprite this InputHandler is bound to.
* It compares the alpha value of the pixel and if >= InputHandler.pixelPerfectAlpha it returns true.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate to check.
* @param y The y coordinate to check.
* @param pointer The pointer to get the x/y coordinate from if not passed as the first two parameters.
* @return true if there is the alpha of the pixel is >= InputHandler.pixelPerfectAlpha
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkPixel(x: number, y: number, pointer?: Phaser.Pointer): boolean;
/**
* Checks if the given pointer is both down and over the Sprite this InputHandler belongs to.
* Use the `fastTest` flag is to quickly check just the bounding hit area even if `InputHandler.pixelPerfectOver` is `true`.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param fastTest Force a simple hit area check even if `pixelPerfectOver` is true for this object? - Default: false
* @return True if the pointer is down, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkPointerDown(pointer: Phaser.Pointer, fastTest?: boolean): boolean;
/**
* Checks if the given pointer is over the Sprite this InputHandler belongs to.
* Use the `fastTest` flag is to quickly check just the bounding hit area even if `InputHandler.pixelPerfectOver` is `true`.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param fastTest Force a simple hit area check even if `pixelPerfectOver` is true for this object? - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkPointerOver(pointer: Phaser.Pointer, fastTest?: boolean): boolean;
/**
* Clean up memory.
*/
destroy(): void;
/**
* Stops this sprite from being able to be dragged. If it is currently the target of an active drag it will be stopped immediately. Also disables any set callbacks.
*/
disableDrag(): void;
/**
* Stops the sprite from snapping to a grid during drag or release.
*/
disableSnap(): void;
/**
* If the pointer is currently over this Sprite this returns how long it has been there for in milliseconds.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The number of milliseconds the pointer has been pressed down on the Sprite, or -1 if not over.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
downDuration(pointer: Phaser.Pointer): number;
/**
* Make this Sprite draggable by the mouse. You can also optionally set mouseStartDragCallback and mouseStopDragCallback
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param lockCenter If false the Sprite will drag from where you click it minus the dragOffset. If true it will center itself to the tip of the mouse pointer. - Default: false
* @param bringToTop If true the Sprite will be bought to the top of the rendering list in its current Group. - Default: false
* @param pixelPerfect If true it will use a pixel perfect test to see if you clicked the Sprite. False uses the bounding box. - Default: false
* @param alphaThreshold If using pixel perfect collision this specifies the alpha level from 0 to 255 above which a collision is processed. - Default: 255
* @param boundsRect If you want to restrict the drag of this sprite to a specific Rectangle, pass the Phaser.Rectangle here, otherwise it's free to drag anywhere. - Default: null
* @param boundsSprite If you want to restrict the drag of this sprite to within the bounding box of another sprite, pass it here. - Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enableDrag(lockCenter?: boolean, bringToTop?: boolean, pixelPerfect?: boolean, alphaThreshold?: number, boundsRect?: Phaser.Rectangle, boundsSprite?: Phaser.Sprite): void;
/**
* Make this Sprite snap to the given grid either during drag or when it's released.
* For example 16x16 as the snapX and snapY would make the sprite snap to every 16 pixels.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param snapX The width of the grid cell to snap to.
* @param snapY The height of the grid cell to snap to.
* @param onDrag If true the sprite will snap to the grid while being dragged. - Default: true
* @param onRelease If true the sprite will snap to the grid when released. - Default: false
* @param snapOffsetX Used to offset the top-left starting point of the snap grid. - Default: 0
* @param snapOffsetX Used to offset the top-left starting point of the snap grid. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enableSnap(snapX: number, snapY: number, onDrag?: boolean, onRelease?: boolean, snapOffsetX?: number, snapOffsetY?: number): void;
/**
* Is this object using pixel perfect checking?
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if the this InputHandler has either `pixelPerfectClick` or `pixelPerfectOver` set to `true`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isPixelPerfect(): boolean;
/**
* Returns true if the pointer has left the Sprite within the specified delay time (defaults to 500ms, half a second)
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param delay The time below which the pointer is considered as just out.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justOut(pointer: number, delay: number): boolean;
/**
* Returns true if the pointer has entered the Sprite within the specified delay time (defaults to 500ms, half a second)
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param delay The time below which the pointer is considered as just over.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justOver(pointer: number, delay: number): boolean;
/**
* Returns true if the pointer has touched or clicked on the Sprite within the specified delay time (defaults to 500ms, half a second)
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param delay The time below which the pointer is considered as just over.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justPressed(pointer: number, delay: number): boolean;
/**
* Returns true if the pointer was touching this Sprite, but has been released within the specified delay time (defaults to 500ms, half a second)
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param delay The time below which the pointer is considered as just out.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justReleased(pointer: number, delay: number): boolean;
/**
* If the pointer is currently over this Sprite this returns how long it has been there for in milliseconds.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The number of milliseconds the pointer has been over the Sprite, or -1 if not over.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
overDuration(pointer: Phaser.Pointer): number;
/**
* If the Pointer is down this returns true. Please note that it only checks if the Pointer is down, not if it's down over any specific Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointer The index of the pointer to check. You can get this from Phaser.Pointer.id.
* @return - True if the given pointer is down, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerDown(pointer: number): boolean;
/**
* Is this sprite being dragged by the mouse or not?
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if the pointer is dragging an object, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerDragged(pointer: Phaser.Pointer): boolean;
/**
* Is the Pointer outside of this Sprite?
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The ID number of a Pointer to check. If you don't provide a number it will check all Pointers.
* @return True if the given pointer (if a index was given, or any pointer if not) is out of this object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerOut(index: number): boolean;
/**
* Is the Pointer over this Sprite?
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The ID number of a Pointer to check. If you don't provide a number it will check all Pointers.
* @return - True if the given pointer (if a index was given, or any pointer if not) is over this object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerOver(index: number): boolean;
/**
* A timestamp representing when the Pointer first touched the touchscreen.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointer The index of the pointer to check. You can get this from Phaser.Pointer.id.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerTimeDown(pointer: Phaser.Pointer): number;
/**
* A timestamp representing when the Pointer left the touchscreen.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerTimeOut(pointer: Phaser.Pointer): number;
/**
* A timestamp representing when the Pointer first touched the touchscreen.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerTimeOver(pointer: number): number;
/**
* A timestamp representing when the Pointer left the touchscreen.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerTimeUp(pointer: number): number;
/**
* If the Pointer is up this returns true. Please note that it only checks if the Pointer is up, not if it's up over any specific Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointer The index of the pointer to check. You can get this from Phaser.Pointer.id.
* @return - True if the given pointer is up, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerUp(pointer: number): boolean;
/**
* The x coordinate of the Input pointer, relative to the top-left of the parent Sprite.
* This value is only set when the pointer is over this Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointer The index of the pointer to check. You can get this from Phaser.Pointer.id.
* @return The x coordinate of the Input pointer.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerX(pointer: number): number;
/**
* The y coordinate of the Input pointer, relative to the top-left of the parent Sprite
* This value is only set when the pointer is over this Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointer The index of the pointer to check. You can get this from Phaser.Pointer.id.
* @return The y coordinate of the Input pointer.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerY(pointer: number): number;
/**
* Resets the Input Handler and disables it.
*/
reset(): void;
/**
* Restricts this sprite to drag movement only on the given axis. Note: If both are set to false the sprite will never move!
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param allowHorizontal To enable the sprite to be dragged horizontally set to true, otherwise false. - Default: true
* @param allowVertical To enable the sprite to be dragged vertically set to true, otherwise false. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setDragLock(allowHorizontal?: boolean, allowVertical?: boolean): void;
/**
* Starts the Input Handler running. This is called automatically when you enable input on a Sprite, or can be called directly if you need to set a specific priority.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param priority Higher priority sprites take click priority over low-priority sprites when they are stacked on-top of each other.
* @param useHandCursor If true the Sprite will show the hand cursor on mouse-over (doesn't apply to mobile browsers)
* @return The Sprite object to which the Input Handler is bound.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
start(priority: number, useHandCursor: boolean): Phaser.Sprite;
/**
* Called by Pointer when drag starts on this Sprite. Should not usually be called directly.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
startDrag(pointer: Phaser.Pointer): void;
/**
* Stops the Input Handler from running.
*/
stop(): void;
/**
* Called by Pointer when drag is stopped on this Sprite. Should not usually be called directly.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
stopDrag(pointer: Phaser.Pointer): void;
/**
* Update.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(pointer: Phaser.Pointer): void;
/**
* Updates the Pointer drag on this Sprite.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param pointer
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateDrag(pointer: Phaser.Pointer): boolean;
/**
* Checks if the object this InputHandler is bound to is valid for consideration in the Pointer move event.
* This is called by Phaser.Pointer and shouldn't typically be called directly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param highestID The highest ID currently processed by the Pointer.
* @param highestRenderID The highest Render Order ID currently processed by the Pointer.
* @param includePixelPerfect If this object has `pixelPerfectClick` or `pixelPerfectOver` set should it be considered as valid? - Default: true
* @return True if the object this InputHandler is bound to should be considered as valid for input detection.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
validForInput(highestID: number, highestRenderID: number, includePixelPerfect?: boolean): boolean;
}
/**
* If you need more fine-grained control over the handling of specific keys you can create and use Phaser.Key objects.
*/
class Key {
/**
* If you need more fine-grained control over the handling of specific keys you can create and use Phaser.Key objects.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Current game instance.
* @param keycode The key code this Key is responsible for.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, keycode: number);
/**
* The down state of the ALT key, if pressed at the same time as this key.
* Default: false
*/
altKey: boolean;
/**
* The down state of the CTRL key, if pressed at the same time as this key.
* Default: false
*/
ctrlKey: boolean;
/**
* If the key is down this value holds the duration of that key press and is constantly updated.
* If the key is up it holds the duration of the previous down session. The number of milliseconds this key has been held down for.
* Default: 0
*/
duration: number;
enabled: boolean;
/**
* Stores the most recent DOM event.
*/
event: any;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* The "down" state of the key. This will remain `true` for as long as the keyboard thinks this key is held down.
* Default: false
*/
isDown: boolean;
/**
* The "up" state of the key. This will remain `true` for as long as the keyboard thinks this key is up.
* Default: true
*/
isUp: boolean;
/**
* True if the key has just been pressed (NOTE: requires to be reset, see justDown getter)
*/
_justDown: boolean;
justDown: boolean;
/**
* True if the key has just been pressed (NOTE: requires to be reset, see justDown getter)
*/
_justUp: boolean;
justUp: boolean;
/**
* The keycode of this key.
*/
keyCode: number;
/**
* This Signal is dispatched every time this Key is pressed down. It is only dispatched once (until the key is released again).
*/
onDown: Phaser.Signal;
/**
* A callback that is called while this Key is held down. Warning: Depending on refresh rate that could be 60+ times per second.
*/
onHoldCallback: Function;
/**
* The context under which the onHoldCallback will be called.
*/
onHoldContext: any;
/**
* This Signal is dispatched every time this Key is pressed down. It is only dispatched once (until the key is released again).
*/
onUp: Phaser.Signal;
/**
* If a key is held down this holds down the number of times the key has 'repeated'.
* Default: 0
*/
repeats: number;
/**
* The down state of the SHIFT key, if pressed at the same time as this key.
* Default: false
*/
shiftKey: boolean;
/**
* The timestamp when the key was last pressed down. This is based on Game.time.now.
*/
timeDown: number;
/**
* The timestamp when the key was last released. This is based on Game.time.now.
*/
timeUp: number;
/**
* Returns `true` if the Key was pressed down within the `duration` value given, or `false` if it either isn't down,
* or was pressed down longer ago than then given duration.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration The duration within which the key is considered as being just pressed. Given in ms. - Default: 50
* @return True if the key was pressed down within the given duration.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
downDuration(duration?: number): boolean;
/**
* Called automatically by Phaser.Keyboard.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The DOM event that triggered this.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processKeyDown(event: KeyboardEvent): void;
/**
* Called automatically by Phaser.Keyboard.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The DOM event that triggered this.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processKeyUp(event: KeyboardEvent): void;
/**
* Resets the state of this Key.
*
* This sets isDown to false, isUp to true, resets the time to be the current time, and _enables_ the key.
* In addition, if it is a "hard reset", it clears clears any callbacks associated with the onDown and onUp events and removes the onHoldCallback.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param hard A soft reset won't reset any events or callbacks; a hard reset will. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(hard?: boolean): void;
/**
* Called automatically by Phaser.Keyboard.
*/
update(): void;
/**
* Returns `true` if the Key was pressed down within the `duration` value given, or `false` if it either isn't down,
* or was pressed down longer ago than then given duration.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration The duration within which the key is considered as being just released. Given in ms. - Default: 50
* @return True if the key was released within the given duration.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
upDuration(duration?: number): boolean;
}
/**
* The Keyboard class monitors keyboard input and dispatches keyboard events.
*
* _Be aware_ that many keyboards are unable to process certain combinations of keys due to hardware
* limitations known as ghosting. Full details here: http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/
*/
class Keyboard {
/**
* The Keyboard class monitors keyboard input and dispatches keyboard events.
*
* _Be aware_ that many keyboards are unable to process certain combinations of keys due to hardware
* limitations known as ghosting. Full details here: http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
static A: number;
static B: number;
static C: number;
static D: number;
static E: number;
static F: number;
static G: number;
static H: number;
static I: number;
static J: number;
static K: number;
static L: number;
static M: number;
static N: number;
static O: number;
static P: number;
static Q: number;
static R: number;
static S: number;
static T: number;
static U: number;
static V: number;
static W: number;
static X: number;
static Y: number;
static Z: number;
static ZERO: number;
static ONE: number;
static TWO: number;
static THREE: number;
static FOUR: number;
static FIVE: number;
static SIX: number;
static SEVEN: number;
static EIGHT: number;
static NINE: number;
static NUMPAD_0: number;
static NUMPAD_1: number;
static NUMPAD_2: number;
static NUMPAD_3: number;
static NUMPAD_4: number;
static NUMPAD_5: number;
static NUMPAD_6: number;
static NUMPAD_7: number;
static NUMPAD_8: number;
static NUMPAD_9: number;
static NUMPAD_MULTIPLY: number;
static NUMPAD_ADD: number;
static NUMPAD_ENTER: number;
static NUMPAD_SUBTRACT: number;
static NUMPAD_DECIMAL: number;
static NUMPAD_DIVIDE: number;
static F1: number;
static F2: number;
static F3: number;
static F4: number;
static F5: number;
static F6: number;
static F7: number;
static F8: number;
static F9: number;
static F10: number;
static F11: number;
static F12: number;
static F13: number;
static F14: number;
static F15: number;
static COLON: number;
static EQUALS: number;
static UNDERSCORE: number;
static QUESTION_MARK: number;
static TILDE: number;
static OPEN_BRACKET: number;
static BACKWARD_SLASH: number;
static CLOSED_BRACKET: number;
static QUOTES: number;
static BACKSPACE: number;
static TAB: number;
static CLEAR: number;
static ENTER: number;
static SHIFT: number;
static CONTROL: number;
static ALT: number;
static CAPS_LOCK: number;
static ESC: number;
static SPACEBAR: number;
static PAGE_UP: number;
static PAGE_DOWN: number;
static END: number;
static HOME: number;
static LEFT: number;
static UP: number;
static RIGHT: number;
static DOWN: number;
static INSERT: number;
static DELETE: number;
static HELP: number;
static NUM_LOCK: number;
static PLUS: number;
static MINUS: number;
/**
* The context under which the callbacks are run.
*/
callbackContext: any;
disabled: boolean;
/**
* Keyboard input will only be processed if enabled.
* Default: true
*/
enabled: boolean;
/**
* The most recent DOM event from keydown or keyup. This is updated every time a new key is pressed or released.
*/
event: any;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* Returns the string value of the most recently pressed key.
*/
lastChar: string;
/**
* Returns the most recently pressed Key. This is a Phaser.Key object and it changes every time a key is pressed.
*/
lastKey: Phaser.Key;
/**
* This callback is invoked every time a key is pressed down, including key repeats when a key is held down.
*/
onDownCallback: Function;
/**
* This callback is invoked every time a DOM onkeypress event is raised, which is only for printable keys.
*/
onPressCallback: Function;
/**
* This callback is invoked every time a key is released.
*/
onUpCallback: Function;
/**
* The most recent DOM event from keypress.
*/
pressEvent: any;
/**
* Add callbacks to the Keyboard handler so that each time a key is pressed down or released the callbacks are activated.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context under which the callbacks are run.
* @param onDown This callback is invoked every time a key is pressed down. - Default: null
* @param onUp This callback is invoked every time a key is released. - Default: null
* @param onPress This callback is invoked every time the onkeypress event is raised. - Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addCallbacks(context: any, onDown?: Function, onUp?: Function, onPress?: Function): void;
/**
* If you need more fine-grained control over a Key you can create a new Phaser.Key object via this method.
* The Key object can then be polled, have events attached to it, etc.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param keycode The keycode of the key, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
* @return The Key object which you can store locally and reference directly.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addKey(keycode: number): Phaser.Key;
/**
* By default when a key is pressed Phaser will not stop the event from propagating up to the browser.
* There are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.
* You can use addKeyCapture to consume the keyboard event for specific keys so it doesn't bubble up to the the browser.
* Pass in either a single keycode or an array/hash of keycodes.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param keycode Either a single numeric keycode or an array/hash of keycodes: [65, 67, 68].
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addKeyCapture(keycode: any): void;
/**
* Creates and returns an object containing 4 hotkeys for Up, Down, Left and Right.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return An object containing properties: up, down, left and right. Which can be polled like any other Phaser.Key object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createCursorKeys(): Phaser.CursorKeys;
/**
* Clear all set key captures.
*/
clearCaptures(): void;
/**
* Stops the Keyboard event listeners from running (keydown and keyup). They are removed from the window.
* Also clears all key captures and currently created Key objects.
*/
destroy(): void;
/**
* Returns `true` if the Key was pressed down within the `duration` value given, or `false` if it either isn't down,
* or was pressed down longer ago than then given duration.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param keycode The keycode of the key to check, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
* @param duration The duration within which the key is considered as being just pressed. Given in ms. - Default: 50
* @return True if the key was pressed down within the given duration, false if not or null if the Key wasn't found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
downDuration(keycode: number, duration?: number): boolean;
/**
* Returns true of the key is currently pressed down. Note that it can only detect key presses on the web browser.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param keycode The keycode of the key to check, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
* @return True if the key is currently down, false if not or null if the Key wasn't found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isDown(keycode: number): boolean;
/**
* Process the keydown event.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param event
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processKeyDown(event: KeyboardEvent): void;
/**
* Process the keypress event.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param event
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processKeyPress(event: KeyboardEvent): void;
/**
* Process the keyup event.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param event
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processKeyUp(event: KeyboardEvent): void;
/**
* Removes a Key object from the Keyboard manager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param keycode The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeKey(keycode: number): void;
/**
* Removes an existing key capture.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param keycode
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeKeyCapture(keycode: number): void;
/**
* Resets all Keys.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param hard A soft reset won't reset any events or callbacks that are bound to the Keys. A hard reset will. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(hard?: boolean): void;
/**
* Starts the Keyboard event listeners running (keydown and keyup). They are attached to the window.
* This is called automatically by Phaser.Input and should not normally be invoked directly.
*/
start(): void;
/**
* Stops the Keyboard event listeners from running (keydown, keyup and keypress). They are removed from the window.
*/
stop(): void;
/**
* Updates all currently defined keys.
*/
update(): void;
/**
* Returns `true` if the Key was pressed down within the `duration` value given, or `false` if it either isn't down,
* or was pressed down longer ago than then given duration.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param keycode The keycode of the key to check, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
* @param duration The duration within which the key is considered as being just released. Given in ms. - Default: 50
* @return True if the key was released within the given duration, false if not or null if the Key wasn't found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
upDuration(keycode: number, duration?: number): boolean;
}
/**
* Creates a new Line object with a start and an end point.
*/
class Line {
/**
* Creates a new Line object with a start and an end point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x1 The x coordinate of the start of the line. - Default: 0
* @param y1 The y coordinate of the start of the line. - Default: 0
* @param x2 The x coordinate of the end of the line. - Default: 0
* @param y2 The y coordinate of the end of the line. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(x1?: number, y1?: number, x2?: number, y2?: number);
/**
* Gets the angle of the line.
*/
angle: number;
/**
* The end point of the line.
*/
end: Phaser.Point;
/**
* Gets the height of this bounds of this line.
*/
height: number;
/**
* Gets the left-most point of this line.
*/
left: number;
/**
* Gets the length of the line segment.
*/
length: number;
/**
* Gets the angle in radians of the normal of this line (line.angle - 90 degrees.)
*/
normalAngle: number;
/**
* Gets the x component of the left-hand normal of this line.
*/
normalX: number;
/**
* Gets the y component of the left-hand normal of this line.
*/
normalY: number;
/**
* Gets the perpendicular slope of the line (x/y).
*/
perpSlope: number;
/**
* Gets the right-most point of this line.
*/
right: number;
/**
* Gets the slope of the line (y/x).
*/
slope: number;
/**
* The start point of the line.
*/
start: Phaser.Point;
/**
* Gets the top-most point of this line.
*/
top: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The const type of this object.
*/
type: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Gets the width of this bounds of this line.
*/
width: number;
/**
* Gets the x coordinate of the top left of the bounds around this line.
*/
x: number;
/**
* Gets the y coordinate of the top left of the bounds around this line.
*/
y: number;
/**
* Checks for intersection between two lines as defined by the given start and end points.
* If asSegment is true it will check for line segment intersection. If asSegment is false it will check for line intersection.
* Returns the intersection segment of AB and EF as a Point, or null if there is no intersection.
* Adapted from code by Keith Hair
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The start of the first Line to be checked.
* @param b The end of the first line to be checked.
* @param e The start of the second Line to be checked.
* @param f The end of the second line to be checked.
* @param asSegment If true it will check for segment intersection, otherwise full line intersection. - Default: true
* @param result A Point object to store the result in, if not given a new one will be created.
* @return The intersection segment of the two lines as a Point, or null if there is no intersection.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static intersectsPoints(a: Phaser.Point, b: Phaser.Point, e: Phaser.Point, f: Phaser.Point, asSegment?: boolean, result?: Phaser.Point): Phaser.Point;
/**
* Checks for intersection between this line and another Line.
* If asSegment is true it will check for segment intersection. If asSegment is false it will check for line intersection.
* Returns the intersection segment of AB and EF as a Point, or null if there is no intersection.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param line The line to check against this one.
* @param asSegment If true it will check for segment intersection, otherwise full line intersection. - Default: true
* @param result A Point object to store the result in, if not given a new one will be created.
* @return The intersection segment of the two lines as a Point, or null if there is no intersection.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static intersects(a: Phaser.Line, b: Phaser.Line, asSegment?: boolean, result?: Phaser.Point): Phaser.Point;
/**
* Returns the reflected angle between two lines.
* This is the outgoing angle based on the angle of this line and the normalAngle of the given line.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param line The line to reflect off this line.
* @return The reflected angle in radians.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static reflect(a: Phaser.Line, b: Phaser.Line): number;
/**
* Returns a new Line object with the same values for the start and end properties as this Line object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param output Optional Line object. If given the values will be set into the object, otherwise a brand new Line object will be created and returned.
* @return The cloned Line object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clone(output: Phaser.Line): Phaser.Line;
/**
* Using Bresenham's line algorithm this will return an array of all coordinates on this line.
* The start and end points are rounded before this runs as the algorithm works on integers.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param stepRate How many steps will we return? 1 = every coordinate on the line, 2 = every other coordinate, etc. - Default: 1
* @param results The array to store the results in. If not provided a new one will be generated.
* @return An array of coordinates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
coordinatesOnLine(stepRate: number, results: any[]): any[];
/**
* Sets this line to start at the given `x` and `y` coordinates and for the segment to extend at `angle` for the given `length`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the start of the line.
* @param y The y coordinate of the start of the line.
* @param angle The angle of the line in radians.
* @param length The length of the line in pixels.
* @return This line object
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fromAngle(x: number, y: number, angle: number, length: number): Phaser.Line;
/**
* Sets the line to match the x/y coordinates of the two given sprites.
* Can optionally be calculated from their center coordinates.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param startSprite The coordinates of this Sprite will be set to the Line.start point.
* @param endSprite The coordinates of this Sprite will be set to the Line.start point.
* @param useCenter If true it will use startSprite.center.x, if false startSprite.x. Note that Sprites don't have a center property by default, so only enable if you've over-ridden your Sprite with a custom class. - Default: false
* @return This line object
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fromSprite(startSprite: Phaser.Sprite, endSprite: Phaser.Sprite, useCenter?: boolean): Phaser.Line;
/**
* Checks for intersection between this line and another Line.
* If asSegment is true it will check for segment intersection. If asSegment is false it will check for line intersection.
* Returns the intersection segment of AB and EF as a Point, or null if there is no intersection.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param line The line to check against this one.
* @param asSegment If true it will check for segment intersection, otherwise full line intersection. - Default: true
* @param result A Point object to store the result in, if not given a new one will be created.
* @return The intersection segment of the two lines as a Point, or null if there is no intersection.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
intersects(line: Phaser.Line, asSegment?: boolean, result?: Phaser.Point): Phaser.Point;
/**
* Tests if the given coordinates fall on this line. See pointOnSegment to test against just the line segment.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The line to check against this one.
* @param y The line to check against this one.
* @return True if the point is on the line, false if not.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointOnLine(x: number, y: number): boolean;
/**
* Tests if the given coordinates fall on this line and within the segment. See pointOnLine to test against just the line.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The line to check against this one.
* @param y The line to check against this one.
* @return True if the point is on the line and segment, false if not.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointOnSegment(x: number, y: number): boolean;
/**
* Returns the reflected angle between two lines.
* This is the outgoing angle based on the angle of this line and the normalAngle of the given line.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param line The line to reflect off this line.
* @return The reflected angle in radians.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reflect(line: Phaser.Line): number;
/**
* Sets the components of the Line to the specified values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x1 The x coordinate of the start of the line. - Default: 0
* @param y1 The y coordinate of the start of the line. - Default: 0
* @param x2 The x coordinate of the end of the line. - Default: 0
* @param y2 The y coordinate of the end of the line. - Default: 0
* @return This line object
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setTo(x1?: number, y1?: number, x2?: number, y2?: number): Phaser.Line;
}
/**
* A basic Linked List data structure.
*
* This implementation _modifies_ the `prev` and `next` properties of each item added:
* - The `prev` and `next` properties must be writable and should not be used for any other purpose.
* - Items _cannot_ be added to multiple LinkedLists at the same time.
* - Only objects can be added.
*/
class LinkedList {
/**
* First element in the list.
* Default: null
*/
first: any;
/**
* Last element in the list.
* Default: null
*/
last: any;
/**
* Next element in the list.
* Default: null
*/
next: any;
/**
* Previous element in the list.
* Default: null
*/
prev: any;
/**
* Number of elements in the list.
* Default: 0
*/
total: number;
/**
* Adds a new element to this linked list.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param item The element to add to this list. Can be a Phaser.Sprite or any other object you need to quickly iterate through.
* @return The item that was added.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(item: any): any;
/**
* Calls a function on all members of this list, using the member as the context for the callback.
* The function must exist on the member.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The function to call.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
callAll(callback: Function): void;
/**
* Removes the given element from this linked list if it exists.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param item The item to be removed from the list.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(item: any): void;
/**
* Resets the first, last, next and previous node pointers in this list.
*/
reset(): void;
}
/**
* The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
*
* The loader uses a combination of tag loading (eg. Image elements) and XHR and provides progress and completion callbacks.
*
* Parallel loading (see {@link Phaser.Loader#enableParallel enableParallel}) is supported and enabled by default.
* Load-before behavior of parallel resources is controlled by synchronization points as discussed in {@link Phaser.Loader#withSyncPoint withSyncPoint}.
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Texture Atlases can be created with tools such as [Texture Packer](https://www.codeandweb.com/texturepacker/phaser) and
* [Shoebox](http://renderhjs.net/shoebox/)
*/
class Loader {
/**
* The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
*
* The loader uses a combination of tag loading (eg. Image elements) and XHR and provides progress and completion callbacks.
*
* Parallel loading (see {@link Phaser.Loader#enableParallel enableParallel}) is supported and enabled by default.
* Load-before behavior of parallel resources is controlled by synchronization points as discussed in {@link Phaser.Loader#withSyncPoint withSyncPoint}.
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Texture Atlases can be created with tools such as [Texture Packer](https://www.codeandweb.com/texturepacker/phaser) and
* [Shoebox](http://renderhjs.net/shoebox/)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
static PHYSICS_LIME_CORONA_JSON: number;
static PHYSICS_PHASER_JSON: number;
static TEXTURE_ATLAS_JSON_ARRAY: number;
static TEXTURE_ATLAS_JSON_HASH: number;
static TEXTURE_ATLAS_XML_STARLING: number;
/**
* If you want to append a URL before the path of any asset you can set this here.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Useful if allowing the asset base url to be configured outside of the game code.
* The string _must_ end with a "/".
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
baseURL: string;
/**
* The crossOrigin value applied to loaded images. Very often this needs to be set to 'anonymous'.
* Default: false
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
crossOrigin: boolean|string;
/**
* If true (the default) then parallel downloading will be enabled.
*
* To disable all parallel downloads this must be set to false prior to any resource being loaded.
*/
enableParallel: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* True if all assets in the queue have finished loading.
* Default: false
*/
hasLoaded: boolean;
/**
* True if the Loader is in the process of loading the queue.
* Default: false
*/
isLoading: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The number of concurrent / parallel resources to try and fetch at once.
*
* Many current browsers limit 6 requests per domain; this is slightly conservative.
*/
maxParallelDownloads: number;
/**
* This event is dispatched immediately before a file starts loading.
* It's possible the file may fail (eg. download error, invalid format) after this event is sent.
*
* Params: `(progress, file key, file url)`
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onFileStart: Phaser.Signal;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This event is dispatched when a file has either loaded or failed to load.
*
* Params: `(progress, file key, success?, total loaded files, total files)`
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onFileComplete: Phaser.Signal;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This event is dispatched when a file (or pack) errors as a result of the load request.
*
* For files it will be triggered before `onFileComplete`. For packs it will be triggered before `onPackComplete`.
*
* Params: `(file key, file)`
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onFileError: Phaser.Signal;
/**
* This event is dispatched when the final file in the load queue has either loaded or failed.
*/
onLoadComplete: Phaser.Signal;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This event is dispatched when the loading process starts: before the first file has been requested,
* but after all the initial packs have been loaded.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onLoadStart: Phaser.Signal;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This event is dispatched when an asset pack has either loaded or failed to load.
*
* This is called when the asset pack manifest file has loaded and successfully added its contents to the loader queue.
*
* Params: `(pack key, success?, total packs loaded, total packs)`
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onPackComplete: Phaser.Signal;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* You can optionally link a progress sprite with {@link Phaser.Loader#setPreloadSprite setPreloadSprite}.
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* This property is an object containing: sprite, rect, direction, width and height
*/
preloadSprite: any;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The rounded load progress percentage value (from 0 to 100). See {@link Phaser.Loader#progressFloat}.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
progress: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The non-rounded load progress value (from 0.0 to 100.0).
*
* A general indicator of the progress.
* It is possible for the progress to decrease, after `onLoadStart`, if more files are dynamically added.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
progressFloat: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If true all calls to Loader.reset will be ignored. Useful if you need to create a load queue before swapping to a preloader state.
* Default: false
*/
resetLocked: boolean;
/**
* If true and if the browser supports XDomainRequest, it will be used in preference for XHR.
*
* This is only relevant for IE 9 and should _only_ be enabled for IE 9 clients when required by the server/CDN.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
useXDomainRequest: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Informs the loader that the given file resource has been fetched and processed;
* or such a request has failed.
*
* @param file
* @param error The error message, if any. No message implies no error. - Default: ''
*/
asyncComplete(file: any, errorMessage?: string): void;
addSyncPoint(type: string, key: string): Phaser.Loader;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Internal function that adds a new entry to the file list. Do not call directly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param type The type of resource to add to the list (image, audio, xml, etc).
* @param key The unique Cache ID key of this resource.
* @param url The URL the asset will be loaded from.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param properties Any additional properties needed to load the file. These are added directly to the added file object and overwrite any defaults. - Default: (none)
* @param overwrite If true then this will overwrite a file asset of the same type/key. Otherwise it will will only add a new asset. If overwrite is true, and the asset is already being loaded (or has been loaded), then it is appended instead. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
addToFileList(type: string, key: string, url: string, properties: any, overwrite: boolean): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new texture atlas ('textureatlas') to the loader.
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Texture Atlases can be created with tools such as [Texture Packer](https://www.codeandweb.com/texturepacker/phaser) and
* [Shoebox](http://renderhjs.net/shoebox/)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the texture atlas file.
* @param textureURL The url of the texture atlas image file.
* @param atlasURL The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.
* @param atlasData A JSON or XML data object. You don't need this if the data is being loaded from a URL.
* @param format A value describing the format of the data, the default is Phaser.Loader.TEXTURE_ATLAS_JSON_ARRAY.
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
atlas(key: string, textureURL: string, atlasURL?: string, atlasData?: any, format?: number): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new texture atlas ('textureatlas') to the loader. This atlas uses the JSON Array data format.
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Texture Atlases can be created with tools such as [Texture Packer](https://www.codeandweb.com/texturepacker/phaser) and
* [Shoebox](http://renderhjs.net/shoebox/)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the texture atlas file.
* @param textureURL The url of the texture atlas image file.
* @param atlasURL The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.
* @param atlasData A JSON or XML data object. You don't need this if the data is being loaded from a URL.
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
atlasJSONArray(key: string, textureURL: string, atlasURL?: string, atlasData?: any): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new texture atlas ('textureatlas') to the loader. This atlas uses the JSON Hash data format.
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Texture Atlases can be created with tools such as [Texture Packer](https://www.codeandweb.com/texturepacker/phaser) and
* [Shoebox](http://renderhjs.net/shoebox/)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the texture atlas file.
* @param textureURL The url of the texture atlas image file.
* @param atlasURL The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.
* @param atlasData A JSON or XML data object. You don't need this if the data is being loaded from a URL.
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
atlasJSONHash(key: string, textureURL: string, atlasURL?: string, atlasData?: any): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new texture atlas ('textureatlas') to the loader. This atlas uses the Starling XML data format.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the texture atlas file.
* @param textureURL The url of the texture atlas image file.
* @param atlasURL The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.
* @param atlasData A JSON or XML data object. You don't need this if the data is being loaded from a URL.
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
atlasXML(key: string, textureURL: string, atlasURL?: string, atlasData?: any): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new 'audio' file to the loader.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the audio file.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param urls Either a single string or an array of URIs or pairs of `{uri: .., type: ..}`.
* If an array is specified then the first URI (or URI + mime pair) that is device-compatible will be selected.
* For example: `"jump.mp3"`, `['jump.mp3', 'jump.ogg', 'jump.m4a']`, or `[{uri: "data:<opus_resource>", type: 'opus'}, 'fallback.mp3']`.
* BLOB and DATA URIs can be used but only support automatic detection when used in the pair form; otherwise the format must be manually checked before adding the resource.
* @param autoDecode When using Web Audio the audio files can either be decoded at load time or run-time.
* Audio files can't be played until they are decoded and, if specified, this enables immediate decoding. Decoding is a non-blocking async process. - Default: true
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
audio(key: string, urls: string|string[]|any, autoDecode?: boolean): Phaser.Loader;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new audiosprite file to the loader.
*
* Audio Sprites are a combination of audio files and a JSON configuration.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the audio file.
* @param urls An array containing the URLs of the audio files, i.e.: [ 'audiosprite.mp3', 'audiosprite.ogg', 'audiosprite.m4a' ] or a single string containing just one URL.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param jsonURL The URL of the audiosprite configuration JSON object. If you wish to pass the data directly set this parameter to null. - Default: null
* @param jsonData A JSON object or string containing the audiosprite configuration data. This is ignored if jsonURL is not null. - Default: null
* @param autoDecode When using Web Audio the audio files can either be decoded at load time or run-time.
* Audio files can't be played until they are decoded and, if specified, this enables immediate decoding. Decoding is a non-blocking async process. - Default: true
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
audiosprite(key: string, urls: string[], jsonURL?: string, jsonData?: string|any, autoDecode?: boolean): Phaser.Loader;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a 'binary' file to the Loader.
*
* It will be loaded via xhr with a responseType of "arraybuffer". You can specify an optional callback to process the file after load.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* When the callback is called it will be passed 2 parameters: the key of the file and the file data.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
*
* WARNING: If a callback is specified the data will be set to whatever it returns. Always return the data object, even if you didn't modify it.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the binary file.
* @param url URL of the binary file.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param callback Optional callback that will be passed the file after loading, so you can perform additional processing on it. - Default: (none)
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callbackContext The context under which the callback will be applied. If not specified it will use the callback itself as the context.
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
binary(key: string, url: string, callback?: Function, callbackContext?: any): Phaser.Loader;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new bitmap font ('bitmapfont') loading request.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the bitmap font.
* @param textureURL The url of the font image file.
* @param xmlURL The url of the font data file (xml/fnt)
* @param xmlData An optional XML data object.
* @param xSpacing If you'd like to add additional horizontal spacing between the characters then set the pixel value here. - Default: 0
* @param ySpacing If you'd like to add additional vertical spacing between the lines then set the pixel value here. - Default: 0
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
bitmapFont(key: string, textureURL: string, xmlURL?: string, xmlData?: any, xSpacing?: number, ySpacing?: number): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Check whether a file/asset with a specific key is queued to be loaded.
*
* To access a loaded asset use Phaser.Cache, eg. {@link Phaser.Cache#checkImageKey}
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param type The type asset you want to check.
* @param key Key of the asset you want to check.
* @return Return true if exists, otherwise return false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkKeyExists(type: string, key: string): boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Successfully loaded a CSV file - only used for certain types.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param file File associated with this request
* @param xhr
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
csvLoadComplete(file: any, xhr: XMLHttpRequest): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Called when a file/resources had been downloaded and needs to be processed further.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param file File loaded
* @param xhr XHR request, unspecified if loaded via other means (eg. tags)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
fileComplete(file: any, xhr: XMLHttpRequest): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Error occurred when loading a file.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param file
* @param xhr XHR request, unspecified if loaded via other means (eg. tags)
* @param reason
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
fileError(file: any, xhr: XMLHttpRequest, reason: string): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The loading is all finished.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param abnormal True if the loading finished abnormally. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
finishedLoading(abnormal?: boolean): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Find a file/asset with a specific key.
*
* Only assets in the download file queue will be found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param type The type asset you want to check.
* @param key Key of the asset you want to check.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @return Returns an object if found that has 2 properties: `index` and `file`; otherwise a non-true value is returned.
* The index may change and should only be used immediately following this call.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getAsset(type: string, key: string): any;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Get the queue-index of the file/asset with a specific key.
*
* Only assets in the download file queue will be found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param type The type asset you want to check.
* @param key Key of the asset you want to check.
* @return The index of this key in the filelist, or -1 if not found.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The index may change and should only be used immediately following this call
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getAssetIndex(type: string, key: string): number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Give a bunch of URLs, return the first URL that has an extension this device thinks it can play.
*
* It is assumed that the device can play "blob:" or "data:" URIs - There is no mime-type checking on data URIs.
*
* @param urls See {@link #audio} for format.
* @return The URL to try and fetch; or null.
*/
getAudioURL(urls: any[]): void;
/**
* Add an 'image' to the Loader.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of this image file.
* @param url URL of image file.
* @param overwrite If an unloaded file with a matching key already exists in the queue, this entry will overwrite it. - Default: false
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
image(key: string, url: string, overwrite?: boolean): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a 'json' file to the Loader.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the json file.
* @param url URL of the json file.
* @param overwrite If an unloaded file with a matching key already exists in the queue, this entry will overwrite it. - Default: false
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
json(key: string, url: string, overwrite?: boolean): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Successfully loaded a JSON file - only used for certain types.
*
* @param file File associated with this request
* @param xhr
*/
jsonLoadComplete(file: any, xhr: XMLHttpRequest): void;
/**
* Continue async loading through an Audio tag.
*/
loadAudioTag(file: any): void;
/**
* Start fetching a resource.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* All code paths, async or otherwise, from this function must return to `asyncComplete`.
*
* @param file
*/
loadFile(file: any): void;
/**
* Continue async loading through an Image tag.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
loadImageTag(file: any): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a JSON resource pack ('packfile') to the Loader.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Packs are always put before the first non-pack file that is not loaded/loading.
* This means that all packs added before any loading has started are added to the front
* of the file/asset list, in order added.
*
* @param key Unique asset key of this resource pack.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param url URL of the Asset Pack JSON file. If you wish to pass a json object instead set this to null and pass the object as the data parameter.
* @param data The Asset Pack JSON data. Use this to pass in a json data object rather than loading it from a URL. TODO
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param callbackContext Some Loader operations, like Binary and Script require a context for their callbacks. Pass the context here. - Default: (loader)
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pack(key: string, url?: string, data?: any, callbackContext?: any): Phaser.Loader;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
parseXml(data: string): XMLDocument;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new 'physics' data object loading request. If data is supplied the object is loaded immediately.
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* The data must be in Lime + Corona JSON format. Physics Editor by code'n'web exports in this format natively.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the physics json data.
* @param url The url of the map data file (csv/json)
* @param data An optional JSON data object. If given then the url is ignored and this JSON object is used for physics data instead.
* @param format The format of the physics data. - Default: Phaser.Physics.LIME_CORONA_JSON
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
physics(key: string, url?: string, data?: any, format?: string): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Process the next item(s) in the file/asset queue.
*
* Process the queue and start loading enough items to fill up the inflight queue.
*
* If a sync-file is encountered then subsequent asset processing is delayed until it completes.
* The exception to this rule is that packfiles can be downloaded (but not processed) even if
* there appear other sync files (ie. packs) - this enables multiple packfiles to be fetched in parallel.
* such as during the start phaser.
*/
processLoadQueue(): void;
/**
* Process pack data. This will usually modify the file list.
*
* @param pack
*/
processPack(pack: any): void;
/**
* Remove all file loading requests - this is _insufficient_ to stop current loading. Use `reset` instead.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeAll(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Remove a file/asset from the loading queue.
*
* A file that is loaded or has started loading cannot be removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param type The type of resource to add to the list (image, audio, xml, etc).
* @param key Key of the file you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
removeFile(type: string, key: string): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Internal function that replaces an existing entry in the file list with a new one. Do not call directly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param type The type of resource to add to the list (image, audio, xml, etc).
* @param key The unique Cache ID key of this resource.
* @param url The URL the asset will be loaded from.
* @param properties Any additional properties needed to load the file.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
replaceInFileList(type: string, key: string, url: string, properties: any): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Reset the loader and clear any queued assets. If `Loader.resetLocked` is true this operation will abort.
*
* This will abort any loading and clear any queued assets.
*
* Optionally you can clear any associated events.
*
* @param hard If true then the preload sprite and other artifacts may also be cleared. - Default: false
* @param clearEvents If true then the all Loader signals will have removeAll called on them. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
reset(hard?: boolean, clearEvents?: boolean): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Called automatically by ScaleManager when the game resizes in RESIZE scalemode.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This can be used to adjust the preloading sprite size, eg.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
resize(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a JavaScript ('script') file to the Loader.
*
* The loaded JavaScript is automatically turned into a script tag and executed, so be careful what you load!
*
* A callback, which will be invoked as the script tag has been created, can also be specified.
* The callback must return relevant `data`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the script file.
* @param url URL of the JavaScript file.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param callback Optional callback that will be called after the script tag has loaded, so you can perform additional processing. - Default: (none)
* @param callbackContext The context under which the callback will be applied. If not specified it will use the callback itself as the context. - Default: (loader)
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
script(key: string, url: String, callback?: Function, callbackContext?: any): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Set a Sprite to be a "preload" sprite by passing it to this method.
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* A "preload" sprite will have its width or height crop adjusted based on the percentage of the loader in real-time.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This allows you to easily make loading bars for games.
*
* The sprite will automatically be made visible when calling this.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The sprite or image that will be cropped during the load.
* @param direction A value of zero means the sprite will be cropped horizontally, a value of 1 means its will be cropped vertically. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setPreloadSprite(sprite: Phaser.Sprite|Phaser.Image, direction?: number): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new sprite sheet ('spritesheet') to the loader.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the sheet file.
* @param url URL of the sheet file.
* @param frameWidth Width of each single frame.
* @param frameHeight Height of each single frame.
* @param frameMax How many frames in this sprite sheet. If not specified it will divide the whole image into frames. - Default: -1
* @param margin If the frames have been drawn with a margin, specify the amount here. - Default: 0
* @param spacing If the frames have been drawn with spacing between them, specify the amount here. - Default: 0
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
spritesheet(key: string, url: string, frameWidth: number, frameHeight: number, frameMax?: number, margin?: number, spacing?: number): Phaser.Loader;
/**
* Start loading the assets. Normally you don't need to call this yourself as the StateManager will do so.
*/
start(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a 'text' file to the Loader.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the text file.
* @param url URL of the text file.
* @param overwrite If an unloaded file with a matching key already exists in the queue, this entry will overwrite it. - Default: false
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
text(key: string, url: string, overwrite?: boolean): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Add a new 'tilemap' loading request. If data is supplied the object is loaded immediately.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the tilemap data.
* @param url The url of the map data file (csv/json)
* @param data An optional JSON data object. If given then the url is ignored and this JSON object is used for map data instead.
* @param format The format of the map data. Either Phaser.Tilemap.CSV or Phaser.Tilemap.TILED_JSON. - Default: Phaser.Tilemap.CSV
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
tilemap(key: string, url?: string, data?: any, format?: number): Phaser.Loader;
/**
* Returns the number of files that have already been loaded, even if they errored.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The number of files that have already been loaded (even if they errored)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
totalLoadedFiles(): number;
/**
* Returns the number of asset packs that have already been loaded, even if they errored.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The number of asset packs that have already been loaded (even if they errored)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
totalLoadedPacks(): number;
/**
* Returns the number of files still waiting to be processed in the load queue. This value decreases as each file in the queue is loaded.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The number of files that still remain in the load queue.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
totalQueuedFiles(): number;
/**
* Returns the number of asset packs still waiting to be processed in the load queue. This value decreases as each pack in the queue is loaded.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The number of asset packs that still remain in the load queue.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
totalQueuedPacks(): number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Transforms the asset URL. The default implementation prepends the baseURL.
*/
transformUrl(url: string): string;
updateProgress(): void;
withSyncPoint(callback: Function, callbackContext?: any): Phaser.Loader;
/**
* Add an XML ('xml') file to the Loader.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Unique asset key of the xml file.
* @param url URL of the xml file.
* @param overwrite If an unloaded file with a matching key already exists in the queue, this entry will overwrite it. - Default: false
* @return This Loader instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
xml(key: string, url: string, overwrite?: boolean): Phaser.Loader;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Starts the xhr loader.
*
* This is designed specifically to use with asset file processing.
*
* @param file The file/pack to load.
* @param url The URL of the file.
* @param type The xhr responseType.
* @param onload The function to call on success. Invoked in `this` context and supplied with `(file, xhr)` arguments.
* @param onerror The function to call on error. Invoked in `this` context and supplied with `(file, xhr)` arguments. - Default: fileError
*/
xhrLoad(file: any, url: string, type: string, onload: Function, onerror?: Function): void;
xhrLoadWithXDR(file: any, url: string, type: string, onload: Function, onerror?: Function): void;
/**
* Successfully loaded an XML file - only used for certain types.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param file File associated with this request
* @param xhr
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
xmlLoadComplete(file: any, xhr: XMLHttpRequest): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
/**
* Phaser.LoaderParser parses data objects from Phaser.Loader that need more preparation before they can be inserted into the Cache.
*/
class LoaderParser {
/**
* Parse a Bitmap Font from an XML file.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the current game.
* @param xml XML data you want to parse.
* @param cacheKey The key of the texture this font uses in the cache.
* @param xSpacing Additional horizontal spacing between the characters. - Default: 0
* @param ySpacing Additional vertical spacing between the characters. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static bitmapFont(game: Phaser.Game, xml: any, cacheKey: string, xSpacing: number, ySpacing: number): Phaser.FrameData;
}
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
class Matrix extends PIXI.Matrix {
a: number;
b: number;
c: number;
d: number;
tx: number;
ty: number;
type: number;
apply(pos: Phaser.Point, newPos?: Phaser.Point): Phaser.Point;
applyInverse(pos: Phaser.Point, newPos?: Phaser.Point): Phaser.Point;
fromArray(array: number[]);
toArray(transpose: boolean): number[];
translate(x: number, y: number): Phaser.Matrix;
scale(x: number, y: number): Phaser.Matrix;
rotate(angle: number): Phaser.Matrix;
append(matrix: Phaser.Matrix): Phaser.Matrix;
identity(): Phaser.Matrix;
}
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A collection of useful mathematical functions.
*
* These are normally accessed through `game.math`.
*/
class Math {
/**
* Find the angle of a segment from (x1, y1) -> (x2, y2).
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x1
* @param y1
* @param x2
* @param y2
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The angle, in radians.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static angleBetween(x1: number, y1: number, x2: number, y2: number): number;
/**
* Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param point1
* @param point2
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The angle, in radians.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static angleBetweenPoints(point1: Phaser.Point, point2: Phaser.Point): number;
/**
* Find the angle of a segment from (x1, y1) -> (x2, y2).
* Note that the difference between this method and Math.angleBetween is that this assumes the y coordinate travels
* down the screen.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x1
* @param y1
* @param x2
* @param y2
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The angle, in radians.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static angleBetweenY(x1: number, y1: number, x2: number, y2: number): number;
/**
* Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param point1
* @param point2
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The angle, in radians.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static angleBetweenPointsY(point1: Phaser.Point, point2: Phaser.Point): number;
/**
* Keeps an angle value between the given min and max values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param angle The angle value to check. Must be between -180 and +180.
* @param min The minimum angle that is allowed (must be -180 or greater).
* @param max The maximum angle that is allowed (must be 180 or less).
* @return The new angle value, returns the same as the input angle if it was within bounds
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static angleLimit(angle: number, min: number, max: number): number;
/**
* Averages all values passed to the function and returns the result.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The average of all given values.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static average(...numbers: number[]): number;
/**
*
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param n
* @param i
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static bernstein(n: number, i: number): number;
/**
* A Bezier Interpolation Method, mostly used by Phaser.Tween.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param v The input array of values to interpolate between.
* @param k The percentage of interpolation, between 0 and 1.
* @return The interpolated value
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static bezierInterpolation(v: number[], k: number): number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Calculates a catmum rom value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param p0
* @param p1
* @param p2
* @param p3
* @param t
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static catmullRom(p0: number, p1: number, p2: number, p3: number, t: number): number;
/**
* A Catmull Rom Interpolation Method, mostly used by Phaser.Tween.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param v The input array of values to interpolate between.
* @param k The percentage of interpolation, between 0 and 1.
* @return The interpolated value
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static catmullRomInterpolation(v: number[], k: number): number;
/**
* _Do not use this function._
*
* Round to the next whole number _away_ from zero.
*
* E.g. `ceil(1.3) == 2`, and `ceil(-2.3) == -3`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value Any number.
* @return The rounded value of that number.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static ceil(value: number): number;
/**
*
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The value to round.
* @param place The place to round to.
* @param base The base to round in... default is 10 for decimal.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static ceilTo(value: number, place?: number, base?: number): number;
/**
* Generate a random bool result based on the chance value.
*
* Returns true or false based on the chance value (default 50%). For example if you wanted a player to have a 30% chance
* of getting a bonus, call chanceRoll(30) - true means the chance passed, false means it failed.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param chance The chance of receiving the value. A number between 0 and 100 (effectively 0% to 100%).
* @return True if the roll passed, or false otherwise.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static chanceRoll(chance: number): boolean;
/**
* Force a value within the boundaries by clamping `x` to the range `[a, b]`.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x
* @param a
* @param b
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static clamp(x: number, a: number, b: number): number;
/**
* Clamp `x` to the range `[a, Infinity)`.
* Roughly the same as `Math.max(x, a)`, except for NaN handling.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x
* @param a
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static clampBottom(x: number, a: number): number;
/**
* Convert degrees to radians.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param degrees Angle in degrees.
* @return Angle in radians.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static degToRad(degrees: number): number;
/**
* The (absolute) difference between two values.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param a
* @param b
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static difference(a: number, b: number): number;
/**
* Returns the euclidian distance between the two given set of coordinates.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x1
* @param y1
* @param x2
* @param y2
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The distance between the two sets of coordinates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static distance(x1: number, y1: number, x2: number, y2: number): number;
/**
* Returns the distance between the two given set of coordinates at the power given.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x1
* @param y1
* @param x2
* @param y2
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pow - Default: 2
* @return The distance between the two sets of coordinates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static distancePow(xy: number, y1: number, x2: number, y2: number, pow?: number): number;
/**
* Returns the rounded distance between the two given set of coordinates.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x1
* @param y1
* @param x2
* @param y2
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The distance between this Point object and the destination Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static distanceRounded(x1: number, y1: number, x2: number, y2: number): number;
/**
*
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value the number you want to evaluate
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static factorial(value: number): number;
/**
* _Do not use this function._
*
* Round to the next whole number _towards_ zero.
*
* E.g. `floor(1.7) == 1`, and `floor(-2.7) == -2`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value Any number.
* @return The rounded value of that number.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static floor(value: number): number;
/**
*
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The value to round.
* @param place The place to round to.
* @param base The base to round in... default is 10 for decimal.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static floorTo(value: number, place: number, base: number): number;
/**
*
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param val
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param epsilon - Default: (small value)
* @return ceiling(val-epsilon)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static fuzzyCeil(val: number, epsilon?: number): boolean;
/**
* Two number are fuzzyEqual if their difference is less than epsilon.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param a
* @param b
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param epsilon - Default: (small value)
* @return True if |a-b|<epsilon
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static fuzzyEqual(a: number, b: number, epsilon?: number): boolean;
/**
* `a` is fuzzyLessThan `b` if it is less than b + epsilon.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param a
* @param b
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param epsilon - Default: (small value)
* @return True if a<b+epsilon
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static fuzzyLessThan(a: Number, b: number, epsilon?: number): boolean;
/**
*
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param val
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param epsilon - Default: (small value)
* @return floor(val-epsilon)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static fuzzyFloor(val: number, epsilon?: number): boolean;
/**
* `a` is fuzzyGreaterThan `b` if it is more than b - epsilon.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param a
* @param b
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param epsilon - Default: (small value)
* @return True if a>b+epsilon
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static fuzzyGreaterThan(a: number, b: number, epsilon?: number): boolean;
/**
* `a` is fuzzyLessThan `b` if it is less than b + epsilon.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param a
* @param b
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param epsilon - Default: (small value)
* @return True if a<b+epsilon
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static fuzzyLessThan(a: number, b: number, epsilon?: number): boolean;
/**
* Fetch a random entry from the given array.
*
* Will return null if there are no array items that fall within the specified range
* or if there is no item for the randomly choosen index.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param objects An array of objects.
* @param startIndex Optional offset off the front of the array. Default value is 0, or the beginning of the array.
* @param length Optional restriction on the number of values you want to randomly select from.
* @return The random object that was selected.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getRandom<T>(objects: T[], startIndex?: number, length?: number): T;
/**
* A one dimensional linear interpolation of a value.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param a
* @param b
* @param weight
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static interpolateFloat(a: number, b: number, weight: number): number;
/**
* Returns true if the number given is even.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param n The number to check.
* @return True if the given number is even. False if the given number is odd.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static isEven(n: number): boolean;
/**
* Returns true if the number given is odd.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param n The number to check.
* @return True if the given number is odd. False if the given number is even.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static isOdd(n: number): boolean;
/**
* Calculates a linear (interpolation) value over t.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param p0
* @param p1
* @param t
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static linear(p0: number, p1: number, t: number): number;
/**
* A Linear Interpolation Method, mostly used by Phaser.Tween.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param v The input array of values to interpolate between.
* @param k The percentage of interpolation, between 0 and 1.
* @return The interpolated value
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static linearInterpolation(v: number[], k: number): number;
/**
* Ensures the given value is between min and max inclusive.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The value to limit.
* @param min The minimum the value can be.
* @param max The maximum the value can be.
* @return The limited value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static limitValue(value: number, min: number, max: number): number;
/**
* Linear mapping from range <a1, a2> to range <b1, b2>
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x the value to map
* @param a1 first endpoint of the range <a1, a2>
* @param a2 final endpoint of the range <a1, a2>
* @param b1 first endpoint of the range <b1, b2>
* @param b2 final endpoint of the range <b1, b2>
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static mapLinear(x: number, a1: number, a2: number, b1: number, b2: number): number;
/**
* Variation of Math.max that can be passed either an array of numbers or the numbers as parameters.
*
* Prefer the standard `Math.max` function when appropriate.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The largest value from those given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static max(...numbers: number[]): number;
/**
* Adds the given amount to the value, but never lets the value go over the specified maximum.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The value to add the amount to.
* @param amount The amount to add to the value.
* @param max The maximum the value is allowed to be.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static maxAdd(value: number, amount: number, max: number): number;
/**
* Variation of Math.max that can be passed a property and either an array of objects or the objects as parameters.
* It will find the largest matching property value from the given objects.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The largest value from those given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static maxProperty(...numbers: number[]): number;
/**
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* Variation of Math.min that can be passed either an array of numbers or the numbers as parameters.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* Prefer the standard `Math.min` function when appropriate.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The lowest value from those given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static min(...numbers: number[]): number;
/**
* Variation of Math.min that can be passed a property and either an array of objects or the objects as parameters.
* It will find the lowest matching property value from the given objects.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The lowest value from those given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static minProperty(...numbers: number[]): number;
/**
* Subtracts the given amount from the value, but never lets the value go below the specified minimum.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The base value.
* @param amount The amount to subtract from the base value.
* @param min The minimum the value is allowed to be.
* @return The new value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static minSub(value: number, amount: number, min: number): number;
/**
* Normalizes an angle to the [0,2pi) range.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param angleRad The angle to normalize, in radians.
* @return Returns the angle, fit within the [0,2pi] range, in radians.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static normalizeAngle(angle: number, radians?: boolean): number;
/**
* Normalizes a latitude to the [-90,90] range. Latitudes above 90 or below -90 are capped, not wrapped.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param lat The latitude to normalize, in degrees.
* @return Returns the latitude, fit within the [-90,90] range.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static normalizeLatitude(lat: number): number;
/**
* Normalizes a longitude to the [-180,180] range. Longitudes above 180 or below -180 are wrapped.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param lng The longitude to normalize, in degrees.
* @return Returns the longitude, fit within the [-180,180] range.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static normalizeLongitude(lng: number): number;
/**
* Create an array representing the inclusive range of numbers (usually integers) in `[start, end]`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param start The minimum value the array starts with.
* @param end The maximum value the array contains.
* @return The array of number values.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static numberArray(start: number, end: number): number[];
/**
* Create an array of numbers (positive and/or negative) progressing from `start`
* up to but not including `end` by advancing by `step`.
*
* If `start` is less than `stop` a zero-length range is created unless a negative `step` is specified.
*
* Certain values for `start` and `end` (eg. NaN/undefined/null) are coerced to 0;
* for forward compatibility make sure to pass in actual numbers.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param start The start of the range.
* @param end The end of the range.
* @param step The value to increment or decrement by. - Default: 1
* @return Returns the new array of numbers.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static numberArrayStep(start: number, end: number, step?: number): number[];
/**
* Work out what percentage value `a` is of value `b` using the given base.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The value to work out the percentage for.
* @param b The value you wish to get the percentage of.
* @param base The base value. - Default: 0
* @return The percentage a is of b, between 0 and 1.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static percent(a: number, b: number, base?: number): number;
static p2px(v: number): number;
/**
* Twice PI.
* Default: ~6.283
*/
static PI2: number;
/**
* Convert degrees to radians.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param radians Angle in radians.
* @return Angle in degrees
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static radToDeg(radians: number): number;
/**
* Randomly returns either a 1 or -1.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Either 1 or -1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static randomSign(): number;
/**
* Reverses an angle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param angleRad The angle to reverse, in radians.
* @return Returns the reverse angle, in radians.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static reverseAngle(angleRed: number): number;
/**
* Removes a random object from the given array and returns it.
*
* Will return null if there are no array items that fall within the specified range
* or if there is no item for the randomly choosen index.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param objects An array of objects.
* @param startIndex Optional offset off the front of the array. Default value is 0, or the beginning of the array.
* @param length Optional restriction on the number of values you want to randomly select from.
* @return The random object that was removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static removeRandom<T>(objects: T[], startIndex?: number, length?: number): T;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Round to the next whole number _away_ from zero.
*
* @param value Any number.
* @return The rounded value of that number.
*/
static roundAwayFromZero(value: number): number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Round to some place comparative to a `base`, default is 10 for decimal place.
* The `place` is represented by the power applied to `base` to get that place.
*
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* e.g. 2000/7 ~= 285.714285714285714285714 ~= (bin)100011101.1011011011011011
*
* roundTo(2000/7,3) === 0
* roundTo(2000/7,2) == 300
* roundTo(2000/7,1) == 290
* roundTo(2000/7,0) == 286
* roundTo(2000/7,-1) == 285.7
* roundTo(2000/7,-2) == 285.71
* roundTo(2000/7,-3) == 285.714
* roundTo(2000/7,-4) == 285.7143
* roundTo(2000/7,-5) == 285.71429
*
* roundTo(2000/7,3,2) == 288 -- 100100000
* roundTo(2000/7,2,2) == 284 -- 100011100
* roundTo(2000/7,1,2) == 286 -- 100011110
* roundTo(2000/7,0,2) == 286 -- 100011110
* roundTo(2000/7,-1,2) == 285.5 -- 100011101.1
* roundTo(2000/7,-2,2) == 285.75 -- 100011101.11
* roundTo(2000/7,-3,2) == 285.75 -- 100011101.11
* roundTo(2000/7,-4,2) == 285.6875 -- 100011101.1011
* roundTo(2000/7,-5,2) == 285.71875 -- 100011101.10111
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* Note what occurs when we round to the 3rd space (8ths place), 100100000, this is to be assumed
* because we are rounding 100011.1011011011011011 which rounds up.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The value to round.
* @param place The place to round to.
* @param base The base to round in... default is 10 for decimal.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static roundTo(value: number, place?: number, base?: number): number;
/**
*
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param n
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return n mod 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static shear(n: number): number;
/**
* Moves the element from the start of the array to the end, shifting all items in the process.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param array The array to shift/rotate. The array is modified.
* @return The shifted value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static shift(stack: any[]): any;
/**
* Shuffles the data in the given array into a new order.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param array The array to shuffle
* @return The array
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
static shuffleArray<T>(array: T[]): T[];
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A value representing the sign of the value: -1 for negative, +1 for positive, 0 if value is 0.
*
* This works differently from `Math.sign` for values of NaN and -0, etc.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return An integer in {-1, 0, 1}
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static sign(x: number): number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Generate a sine and cosine table simultaneously and extremely quickly.
* The parameters allow you to specify the length, amplitude and frequency of the wave.
* This generator is fast enough to be used in real-time.
* Code based on research by Franky of scene.at
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param length The length of the wave
* @param sinAmplitude The amplitude to apply to the sine table (default 1.0) if you need values between say -+ 125 then give 125 as the value
* @param cosAmplitude The amplitude to apply to the cosine table (default 1.0) if you need values between say -+ 125 then give 125 as the value
* @param frequency The frequency of the sine and cosine table data
* @return Returns the table data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static sinCosGenerator(length: number, sinAmplitude?: number, cosAmplitude?: number, frequency?: number): { sin: number[]; cos: number[]; };
/**
* Smootherstep function as detailed at http://en.wikipedia.org/wiki/Smoothstep
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x
* @param min
* @param max
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static smootherstep(x: number, min: number, max: number): number;
/**
* Smoothstep function as detailed at http://en.wikipedia.org/wiki/Smoothstep
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param x
* @param min
* @param max
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static smoothstep(x: number, min: number, max: number): number;
/**
* Snap a value to nearest grid slice, using rounding.
*
* Example: if you have an interval gap of 5 and a position of 12... you will snap to 10 whereas 14 will snap to 15.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param input The value to snap.
* @param gap The interval gap of the grid.
* @param start Optional starting offset for gap.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static snapTo(input: number, gap: number, start?: number): number;
/**
* Snap a value to nearest grid slice, using ceil.
*
* Example: if you have an interval gap of 5 and a position of 12... you will snap to 15. As will 14 will snap to 15... but 16 will snap to 20.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param input The value to snap.
* @param gap The interval gap of the grid.
* @param start Optional starting offset for gap.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static snapToCeil(input: number, gap: number, start?: number): number;
/**
* Snap a value to nearest grid slice, using floor.
*
* Example: if you have an interval gap of 5 and a position of 12... you will snap to 10. As will 14 snap to 10... but 16 will snap to 15
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param input The value to snap.
* @param gap The interval gap of the grid.
* @param start Optional starting offset for gap.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static snapToFloor(input: number, gap: number, start?: number): number;
/**
* Snaps a value to the nearest value in an array.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param input
* @param arr
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sort True if the array needs to be sorted.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static snapToInArray(input: number, arr: number[], sort?: boolean): number;
/**
*
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param n
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static truncate(n: number): number;
/**
* Checks if two values are within the given tolerance of each other.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The first number to check
* @param b The second number to check
* @param tolerance The tolerance. Anything equal to or less than this is considered within the range.
* @return True if a is <= tolerance of b.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static within(a: number, b: number, tolerance: number): boolean;
/**
* Ensures that the value always stays between min and max, by wrapping the value around.
*
* If `max` is not larger than `min` the result is 0.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The value to wrap.
* @param min The minimum the value is allowed to be.
* @param max The maximum the value is allowed to be, should be larger than `min`.
* @return The wrapped value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static wrap(value: number, min: number, max: number): number;
/**
* Keeps an angle value between -180 and +180; or -PI and PI if radians.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param angle The angle value to wrap
* @param radians Set to `true` if the angle is given in radians, otherwise degrees is expected. - Default: false
* @return The new angle value; will be the same as the input angle if it was within bounds.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static wrapAngle(angle: number, radians?: boolean): number;
/**
* Adds value to amount and ensures that the result always stays between 0 and max, by wrapping the value around.
*
* Values _must_ be positive integers, and are passed through Math.abs. See {@link Phaser.Math#wrap} for an alternative.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The value to add the amount to.
* @param amount The amount to add to the value.
* @param max The maximum the value is allowed to be.
* @return The wrapped value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static wrapValue(value: number, amount: number, max: number): number;
}
interface WheelEventProxy {
bindEvent(event: any): WheelEventProxy;
type: string;
deltaMode: number;
deltaX: number;
deltaY: number;
deltaZ: number;
}
/**
* The Mouse class is responsible for handling all aspects of mouse interaction with the browser.
*
* It captures and processes mouse events that happen on the game canvas object. It also adds a single `mouseup` listener to `window` which
* is used to capture the mouse being released when not over the game.
*/
class Mouse {
/**
* The Mouse class is responsible for handling all aspects of mouse interaction with the browser.
*
* It captures and processes mouse events that happen on the game canvas object. It also adds a single `mouseup` listener to `window` which
* is used to capture the mouse being released when not over the game.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
static LEFT_BUTTON: number;
static MIDDLE_BUTTON: number;
static NO_BUTTON: number;
static RIGHT_BUTTON: number;
static WHEEL_DOWN: number;
static WHEEL_UP: number;
/**
* The type of click, either: Phaser.Mouse.NO_BUTTON, Phaser.Mouse.LEFT_BUTTON, Phaser.Mouse.MIDDLE_BUTTON or Phaser.Mouse.RIGHT_BUTTON.
*/
button: number;
/**
* The context under which callbacks are called.
*/
callbackContext: any;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If true the DOM mouse events will have event.preventDefault applied to them, if false they will propagate fully.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
capture: boolean;
disabled: boolean;
/**
* Mouse input will only be processed if enabled.
* Default: true
*/
enabled: boolean;
/**
* The browser mouse DOM event. Will be null if no mouse event has ever been received.
* Access this property only inside a Mouse event handler and do not keep references to it.
* Default: null
*/
event: MouseEvent;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* If the mouse has been Pointer Locked successfully this will be set to true.
* Default: false
*/
locked: boolean;
/**
* A callback that can be fired when the mouse is pressed down.
*/
mouseDownCallback: (event: MouseEvent) => void;
/**
* A callback that can be fired when the mouse is moved.
*/
mouseMoveCallback: (event: MouseEvent) => void;
/**
* A callback that can be fired when the mouse is no longer over the game canvas.
*/
mouseOutCallback: (event: MouseEvent) => void;
/**
* A callback that can be fired when the mouse enters the game canvas (usually after a mouseout).
*/
mouseOverCallback: (event: MouseEvent) => void;
/**
* A callback that can be fired when the mouse is released from a pressed down state.
*/
mouseUpCallback: (event: MouseEvent) => void;
/**
* A callback that can be fired when the mousewheel is used.
*/
mouseWheelCallback: (event: MouseEvent) => void;
/**
* Internal event handler reference.
*/
_onMouseDown: (event: MouseEvent) => void;
/**
* Internal event handler reference.
*/
_onMouseMove: (event: MouseEvent) => void;
/**
* Internal event handler reference.
*/
_onMouseUp: (event: MouseEvent) => void;
/**
* Internal event handler reference.
*/
_onMouseOut: (event: MouseEvent) => void;
/**
* Internal event handler reference.
*/
_onMouseOver: (event: MouseEvent) => void;
/**
* Internal event handler reference.
*/
_onMouseWheel: (event: MouseEvent) => void;
/**
* Wheel proxy event object, if required. Shared for all wheel events for this mouse.
*/
_wheelEvent: WheelEventProxy;
/**
* This event is dispatched when the browser enters or leaves pointer lock state.
*/
pointerLock: Phaser.Signal;
/**
* If true Pointer.stop will be called if the mouse leaves the game canvas.
* Default: false
*/
stopOnGameOut: boolean;
/**
* The direction of the _last_ mousewheel usage 1 for up -1 for down
*/
wheelDelta: number;
/**
* The internal method that handles the mouse down event from the browser.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Mouse.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onMouseDown(event: MouseEvent): void;
/**
* The internal method that handles the mouse move event from the browser.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Mouse.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onMouseMove(event: MouseEvent): void;
/**
* The internal method that handles the mouse out event from the browser.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Mouse.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onMouseOut(event: MouseEvent): void;
/**
* The internal method that handles the mouse over event from the browser.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Mouse.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onMouseOver(event: MouseEvent): void;
/**
* The internal method that handles the mouse up event from the browser.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Mouse.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onMouseUp(event: MouseEvent): void;
/**
* The internal method that handles the mouse up event from the window.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Mouse.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onMouseUpGlobal(event: MouseEvent): void;
/**
* The internal method that handles the mouse wheel event from the browser.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onMouseWheel(event: MouseEvent): void;
/**
* Internal pointerLockChange handler.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Mouse.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointerLockChange(event: MouseEvent): void;
/**
* Internal release pointer lock handler.
*/
releasePointerLock(): void;
/**
* If the browser supports it you can request that the pointer be locked to the browser window.
* This is classically known as 'FPS controls', where the pointer can't leave the browser until the user presses an exit key.
* If the browser successfully enters a locked state the event Phaser.Mouse.pointerLock will be dispatched and the first parameter will be 'true'.
*/
requestPointerLock(): void;
/**
* Starts the event listeners running.
*/
start(): void;
/**
* Stop the event listeners.
*/
stop(): void;
}
/**
* The MSPointer class handles Microsoft touch interactions with the game and the resulting Pointer objects.
*
* It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 apps using JavaScript.
* http://msdn.microsoft.com/en-us/library/ie/hh673557(v=vs.85).aspx
*/
class MSPointer {
/**
* The MSPointer class handles Microsoft touch interactions with the game and the resulting Pointer objects.
*
* It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 apps using JavaScript.
* http://msdn.microsoft.com/en-us/library/ie/hh673557(v=vs.85).aspx
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The type of click, either: Phaser.Mouse.NO_BUTTON, Phaser.Mouse.LEFT_BUTTON, Phaser.Mouse.MIDDLE_BUTTON or Phaser.Mouse.RIGHT_BUTTON.
*/
button: number;
/**
* If true the Pointer events will have event.preventDefault applied to them, if false they will propagate fully.
*/
capture: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The context under which callbacks are called (defaults to game).
*/
callbackContext: any;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The browser MSPointer DOM event. Will be null if no event has ever been received.
* Access this property only inside a Pointer event handler and do not keep references to it.
* Default: null
*/
event: MSPointerEvent;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
disabled: boolean;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
onPointerDown: (event: MSPointerEvent) => void;
onPointerMove: (event: MSPointerEvent) => void;
onPointerUp: (event: MSPointerEvent) => void;
mouseDownCallback: (event: MSPointerEvent) => void;
mouseMoveCallback: (event: MSPointerEvent) => void;
mouseUpCallback: (event: MSPointerEvent) => void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A callback that can be fired on a MSPointerDown event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
pointerDownCallback: (event: MSPointerEvent) => void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A callback that can be fired on a MSPointerMove event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
pointerMoveCallback: (event: MSPointerEvent) => void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A callback that can be fired on a MSPointerUp event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
pointerUpCallback: (event: MSPointerEvent) => void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Starts the event listeners running.
*/
start(): void;
/**
* Stop the event listeners.
*/
stop(): void;
}
/**
* Phaser.Net handles browser URL related tasks such as checking host names, domain names and query string manipulation.
*/
class Net {
/**
* Phaser.Net handles browser URL related tasks such as checking host names, domain names and query string manipulation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
game: Phaser.Game;
/**
* Compares the given domain name against the hostname of the browser containing the game.
* If the domain name is found it returns true.
* You can specify a part of a domain, for example 'google' would match 'google.com', 'google.co.uk', etc.
* Do not include 'http://' at the start.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* @param domain
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return true if the given domain fragment can be found in the window.location.hostname
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkDomainName(domain: string): boolean;
/**
* Returns the Query String as an object.
* If you specify a parameter it will return just the value of that parameter, should it exist.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value The URI component to be decoded.
* @return The decoded value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
decodeURI(value: string): string;
/**
* Returns the hostname given by the browser.
*/
getHostName(): string;
/**
* Returns the Query String as an object.
* If you specify a parameter it will return just the value of that parameter, should it exist.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param parameter If specified this will return just the value for that key. - Default: ''
* @return An object containing the key value pairs found in the query string or just the value if a parameter was given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getQueryString(parameter?: string): string;
/**
* Updates a value on the Query String and returns it in full.
* If the value doesn't already exist it is set.
* If the value exists it is replaced with the new value given. If you don't provide a new value it is removed from the query string.
* Optionally you can redirect to the new url, or just return it as a string.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The querystring key to update.
* @param value The new value to be set. If it already exists it will be replaced.
* @param redirect If true the browser will issue a redirect to the url with the new querystring.
* @param url The URL to modify. If none is given it uses window.location.href.
* @return If redirect is false then the modified url and query string is returned.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateQueryString(key: string, value: any, redirect?: boolean, url?: string): string;
}
/**
* Create a new `Particle` object. Particles are extended Sprites that are emitted by a particle emitter such as Phaser.Particles.Arcade.Emitter.
*/
class Particle extends Phaser.Sprite {
/**
* Create a new `Particle` object. Particles are extended Sprites that are emitted by a particle emitter such as Phaser.Particles.Arcade.Emitter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param x The x coordinate (in world space) to position the Particle at.
* @param y The y coordinate (in world space) to position the Particle at.
* @param key This is the image or texture used by the Particle during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If this Particle is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, x: number, y: number, key?: any, frame?: any);
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* A Game Object is considered `fresh` if it has just been created or reset and is yet to receive a renderer transform update.
* This property is mostly used internally by the physics systems, but is exposed for the use of plugins.
*/
fresh: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Called by the Emitter when this particle is emitted. Left empty for you to over-ride as required.
*/
onEmit(): void;
/**
* Resets the Particle. This places the Particle at the given x/y world coordinates and then
* sets alive, exists, visible and renderable all to true. Also resets the outOfBounds state and health values.
* If the Particle has a physics body that too is reset.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate (in world space) to position the Particle at.
* @param y The y coordinate (in world space) to position the Particle at.
* @param health The health to give the Particle. - Default: 1
* @return (Phaser.Particle) This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(x: number, y: number, health?: number): Phaser.Particle;
/**
* Called by the Emitter if autoAlpha has been enabled. Passes over the alpha ease data and resets the alpha counter.
*/
setAlphaData(data: any[]): void;
/**
* Called by the Emitter if autoScale has been enabled. Passes over the scale ease data and resets the scale counter.
*/
setScaleData(data: any[]): void;
/**
* Updates the Particle scale or alpha if autoScale and autoAlpha are set.
*/
update(): void;
}
/**
* Phaser.Particles is the Particle Manager for the game. It is called during the game update loop and in turn updates any Emitters attached to it.
*/
class Particles {
/**
* Phaser.Particles is the Particle Manager for the game. It is called during the game update loop and in turn updates any Emitters attached to it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* Internal emitters store.
*/
emitters: any;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* -
* Default: 0
*/
ID: number;
/**
* Adds a new Particle Emitter to the Particle Manager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param emitter The emitter to be added to the particle manager.
* @return The emitter that was added.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(emitter: Phaser.Particles.Arcade.Emitter): Phaser.Particles.Arcade.Emitter;
/**
* Removes an existing Particle Emitter from the Particle Manager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param emitter The emitter to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(emitter: Phaser.Particles.Arcade.Emitter): void;
/**
* Called by the core game loop. Updates all Emitters who have their exists value set to true.
*/
update(): void;
}
module Particles {
module Arcade {
/**
* Emitter is a lightweight particle emitter that uses Arcade Physics.
* It can be used for one-time explosions or for continuous effects like rain and fire.
* All it really does is launch Particle objects out at set intervals, and fixes their positions and velocities accordingly.
*/
class Emitter extends Phaser.Group {
/**
* Emitter is a lightweight particle emitter that uses Arcade Physics.
* It can be used for one-time explosions or for continuous effects like rain and fire.
* All it really does is launch Particle objects out at set intervals, and fixes their positions and velocities accordingly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Current game instance.
* @param x The x coordinate within the Emitter that the particles are emitted from. - Default: 0
* @param y The y coordinate within the Emitter that the particles are emitted from. - Default: 0
* @param maxParticles The total number of particles in this emitter. - Default: 50
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, x?: number, y?: number, maxParticles?: number);
/**
* An array of the calculated alpha easing data applied to particles with alphaRates > 0.
*/
alphaData: any[];
/**
* When a new Particle is emitted this controls if it will automatically change alpha. Use Emitter.setAlpha to configure.
*/
autoAlpha: boolean;
/**
* When a new Particle is emitted this controls if it will automatically scale in size. Use Emitter.setScale to configure.
*/
autoScale: boolean;
/**
* The angle of rotation of the group container, in degrees.
*
* This adjusts the group itself by modifying its local rotation transform.
*
* This has no impact on the rotation/angle properties of the children, but it will update their worldTransform
* and on-screen orientation and position.
*/
angle: number;
/**
* The angular drag component of particles launched from the emitter if they are rotating.
* Default: 0
*/
angularDrag: number;
/**
* Gets the bottom position of the Emitter.
*/
bottom: number;
/**
* How much each particle should bounce on each axis. 1 = full bounce, 0 = no bounce.
*/
bounce: Phaser.Point;
/**
* The point the particles are emitted from.
* Emitter.x and Emitter.y control the containers location, which updates all current particles
* Emitter.emitX and Emitter.emitY control the emission location relative to the x/y position.
*/
emitX: number;
/**
* The point the particles are emitted from.
* Emitter.x and Emitter.y control the containers location, which updates all current particles
* Emitter.emitX and Emitter.emitY control the emission location relative to the x/y position.
*/
emitY: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* If exists is true the group is updated, otherwise it is skipped.
* Default: true
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
exists: boolean;
/**
* How often a particle is emitted in ms (if emitter is started with Explode === false).
* Default: 100
*/
frequency: number;
/**
* Sets the `body.gravity.y` of each particle sprite to this value on launch.
* Default: 100
*/
gravity: number;
group: Phaser.Group;
/**
* Gets or sets the height of the Emitter. This is the region in which a particle can be emitted.
*/
height: number;
/**
* Gets the left position of the Emitter.
*/
left: number;
/**
* How long each particle lives once it is emitted in ms. Default is 2 seconds. Set lifespan to 'zero' for particles to live forever.
* Default: 2000
*/
lifespan: number;
/**
* The total number of particles in this emitter.
*/
maxParticles: number;
/**
* The maximum possible scale of a particle. This is applied to the X and Y axis. If you need to control each axis see maxParticleScaleX.
* Default: 1
*/
maxParticleScale: number;
/**
* The maximum possible velocity of a particle.
*/
maxParticleSpeed: Phaser.Point;
/**
* The maximum possible angular velocity of a particle.
* Default: 360
*/
maxRotation: number;
/**
* The minimum possible scale of a particle. This is applied to the X and Y axis. If you need to control each axis see minParticleScaleX.
* Default: 1
*/
minParticleScale: number;
/**
* The minimum possible velocity of a particle.
*/
minParticleSpeed: Phaser.Point;
/**
* The minimum possible angular velocity of a particle.
*/
minRotation: number;
/**
* A handy string name for this emitter. Can be set to anything.
*/
name: string;
/**
* Determines whether the emitter is currently emitting particles. It is totally safe to directly toggle this.
* Default: false
*/
on: boolean;
/**
* If this is `true` then when the Particle is emitted it will be bought to the top of the Emitters display list.
* Default: false
*/
particleBringToTop: boolean;
/**
* If this is `true` then when the Particle is emitted it will be sent to the back of the Emitters display list.
* Default: false
*/
particleSendToBack: boolean;
/**
* For emitting your own particle class types. They must extend Phaser.Particle.
*/
particleClass: Phaser.Sprite;
/**
* The X and Y drag component of particles launched from the emitter.
*/
particleDrag: Phaser.Point;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The const physics body type of this object.
*/
physicsType: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The coordinate of the object relative to the local coordinates of the parent.
*/
position: Phaser.Point;
/**
* Gets the right position of the Emitter.
*/
right: number;
/**
* An array of the calculated scale easing data applied to particles with scaleRates > 0.
*/
scaleData: any[];
/**
* Gets the top position of the Emitter.
*/
top: number;
/**
* Internal Phaser Type value.
*/
type: number;
/**
* Gets or sets the width of the Emitter. This is the region in which a particle can be emitted.
*/
width: number;
/**
* Gets or sets the x position of the Emitter.
*/
x: number;
/**
* Gets or sets the y position of the Emitter.
*/
y: number;
/**
* Change the emitters center to match the center of any object with a `center` property, such as a Sprite.
* If the object doesn't have a center property it will be set to object.x + object.width / 2
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The object that you wish to match the center with.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
at(object: any): void;
/**
* This function can be used both internally and externally to emit the next particle in the queue.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if a particle was emitted, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
emitParticle(): void;
/**
* Call this function to emit the given quantity of particles at all once (an explosion)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param lifespan How long each particle lives once emitted in ms. 0 = forever. - Default: 0
* @param quantity How many particles to launch. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
explode(lifespan?: number, quantity?: number): void;
/**
* Call this function to start emitting a flow of particles at the given frequency.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* It will carry on going until the total given is reached.
* Each time the flow is run the quantity number of particles will be emitted together.
* If you set the total to be 20 and quantity to be 5 then flow will emit 4 times in total (4 x 5 = 20 total)
* If you set the total to be -1 then no quantity cap is used and it will keep emitting.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param lifespan How long each particle lives once emitted in ms. 0 = forever. - Default: 0
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param frequency Frequency is how often to emit the particles, given in ms. - Default: 250
* @param quantity How many particles to launch each time the frequency is met. Can never be > Emitter.maxParticles. - Default: 1
* @param total How many particles to launch in total. If -1 it will carry on indefinitely. - Default: -1
* @param immediate Should the flow start immediately (true) or wait until the first frequency event? (false) - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
flow(lifespan?: number, frequency?: number, quantity?: number, total?: number, immediate?: boolean): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Call this function to turn off all the particles and the emitter.
*/
kill(): void;
/**
* This function generates a new set of particles for use by this emitter.
* The particles are stored internally waiting to be emitted via Emitter.start.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param keys A string or an array of strings that the particle sprites will use as their texture. If an array one is picked at random.
* @param frames A frame number, or array of frames that the sprite will use. If an array one is picked at random. - Default: 0
* @param quantity The number of particles to generate. If not given it will use the value of Emitter.maxParticles. If the value is greater than Emitter.maxParticles it will use Emitter.maxParticles as the quantity.
* @param collide If you want the particles to be able to collide with other Arcade Physics bodies then set this to true. - Default: false
* @param collideWorldBounds A particle can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World. - Default: false
* @return This Emitter instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
makeParticles(keys: any, frames?: any, quantity?: number, collide?: boolean, collideWorldBounds?: boolean): Phaser.Particles.Arcade.Emitter;
reset(x: number, y: number, health?: number): Phaser.Particles;
/**
* A more compact way of setting the alpha constraints of the particles.
* The rate parameter, if set to a value above zero, lets you set the speed at which the Particle change in alpha from min to max.
* If rate is zero, which is the default, the particle won't change alpha - instead it will pick a random alpha between min and max on emit.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value for this range. - Default: 1
* @param max The maximum value for this range. - Default: 1
* @param rate The rate (in ms) at which the particles will change in alpha from min to max, or set to zero to pick a random alpha between the two. - Default: 0
* @param ease If you've set a rate > 0 this is the easing formula applied between the min and max values. - Default: Phaser.Easing.Linear.None
* @param yoyo If you've set a rate > 0 you can set if the ease will yoyo or not (i.e. ease back to its original values) - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setAlpha(min?: number, max?: number, rate?: number, ease?: (k: number) => number, yoyo?: boolean): void;
/**
* A more compact way of setting the angular velocity constraints of the particles.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value for this range. - Default: 0
* @param max The maximum value for this range. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setRotation(min?: number, max?: number): void;
/**
* A more compact way of setting the scale constraints of the particles.
* The rate parameter, if set to a value above zero, lets you set the speed and ease which the Particle uses to change in scale from min to max across both axis.
* If rate is zero, which is the default, the particle won't change scale during update, instead it will pick a random scale between min and max on emit.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param minX The minimum value of Particle.scale.x. - Default: 1
* @param maxX The maximum value of Particle.scale.x. - Default: 1
* @param minY The minimum value of Particle.scale.y. - Default: 1
* @param maxY The maximum value of Particle.scale.y. - Default: 1
* @param rate The rate (in ms) at which the particles will change in scale from min to max, or set to zero to pick a random size between the two. - Default: 0
* @param ease If you've set a rate > 0 this is the easing formula applied between the min and max values. - Default: Phaser.Easing.Linear.None
* @param yoyo If you've set a rate > 0 you can set if the ease will yoyo or not (i.e. ease back to its original values) - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setScale(minX?: number, maxX?: number, minY?: number, maxY?: number, rate?: number, ease?: (k: number) => number, yoyo?: boolean): void;
/**
* A more compact way of setting the width and height of the emitter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The desired width of the emitter (particles are spawned randomly within these dimensions).
* @param height The desired height of the emitter.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setSize(width: number, height: number): void;
/**
* A more compact way of setting the X velocity range of the emitter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value for this range. - Default: 0
* @param max The maximum value for this range. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setXSpeed(min: number, max: number): void;
/**
* A more compact way of setting the Y velocity range of the emitter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value for this range. - Default: 0
* @param max The maximum value for this range. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setYSpeed(min: number, max: number): void;
/**
* Call this function to start emitting particles.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param explode Whether the particles should all burst out at once (true) or at the frequency given (false). - Default: true
* @param lifespan How long each particle lives once emitted in ms. 0 = forever. - Default: 0
* @param frequency Ignored if Explode is set to true. Frequency is how often to emit 1 particle. Value given in ms. - Default: 250
* @param quantity How many particles to launch. 0 = "all of the particles" which will keep emitting until Emitter.maxParticles is reached. - Default: 0
* @param forceQuantity If `true` and creating a particle flow, the quantity emitted will be forced to the be quantity given in this call. This can never exceed Emitter.maxParticles. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
start(explode?: boolean, lifespan?: number, frequency?: number, quantity?: number, forceQuantity?: boolean): void;
/**
* Called automatically by the game loop, decides when to launch particles and when to "die".
*/
update(): void;
/**
* Handy for bringing game objects "back to life". Just sets alive and exists back to true.
*/
revive(): void;
}
}
}
/**
* The Physics Manager is responsible for looking after all of the running physics systems.
* Phaser supports 4 physics systems: Arcade Physics, P2, Ninja Physics and Box2D via a commercial plugin.
*
* Game Objects (such as Sprites) can only belong to 1 physics system, but you can have multiple systems active in a single game.
*
* For example you could have P2 managing a polygon-built terrain landscape that an vehicle drives over, while it could be firing bullets that use the
* faster (due to being much simpler) Arcade Physics system.
*/
class Physics {
/**
* The Physics Manager is responsible for looking after all of the running physics systems.
* Phaser supports 4 physics systems: Arcade Physics, P2, Ninja Physics and Box2D via a commercial plugin.
*
* Game Objects (such as Sprites) can only belong to 1 physics system, but you can have multiple systems active in a single game.
*
* For example you could have P2 managing a polygon-built terrain landscape that an vehicle drives over, while it could be firing bullets that use the
* faster (due to being much simpler) Arcade Physics system.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param physicsConfig A physics configuration object to pass to the Physics world on creation. - Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, config?: any);
static ARCADE: number;
static P2JS: number;
static NINJA: number;
static BOX2D: number;
static CHIPMUNK: number;
/**
* The Arcade Physics system.
*/
arcade: Phaser.Physics.Arcade;
/**
* The physics configuration object as passed to the game on creation.
*/
config: any;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* The N+ Ninja Physics system.
*/
ninja: Phaser.Physics.Ninja;
/**
* The P2.JS Physics system.
*/
p2: Phaser.Physics.P2;
/**
* Clears down all active physics systems. This doesn't destroy them, it just clears them of objects and is called when the State changes.
*/
clear(): void;
/**
* Destroys all active physics systems. Usually only called on a Game Shutdown, not on a State swap.
*/
destroy(): void;
/**
* This will create a default physics body on the given game object or array of objects.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.
* It can be for any of the physics systems that have been started:
*
* Phaser.Physics.Arcade - A light weight AABB based collision system with basic separation.
* Phaser.Physics.P2JS - A full-body advanced physics system supporting multiple object shapes, polygon loading, contact materials, springs and constraints.
* Phaser.Physics.NINJA - A port of Metanet Softwares N+ physics system. Advanced AABB and Circle vs. Tile collision.
* Phaser.Physics.BOX2D - A port of https://code.google.com/p/box2d-html5
* Phaser.Physics.CHIPMUNK is still in development.
*
* If you require more control over what type of body is created, for example to create a Ninja Physics Circle instead of the default AABB, then see the
* individual physics systems `enable` methods instead of using this generic one.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. Can also be an array of objects, a body will be created on every object in the array.
* @param system The physics system that will be used to create the body. Defaults to Arcade Physics. - Default: Phaser.Physics.ARCADE
* @param debug Enable the debug drawing for this body. Defaults to false. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enable(object: any, system?: number, debug?: boolean): void;
/**
* Parses the Physics Configuration object passed to the Game constructor and starts any physics systems specified within.
*/
parseConfig(): void;
/**
* preUpdate checks.
*/
preUpdate(): void;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Resets the active physics system. Called automatically on a Phaser.State swap.
*/
reset(): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Updates the physics bounds to match the world dimensions.
*/
setBoundsToWorld(): void;
/**
* This will create an instance of the requested physics simulation.
* Phaser.Physics.Arcade is running by default, but all others need activating directly.
*
* You can start the following physics systems:
*
* Phaser.Physics.P2JS - A full-body advanced physics system by Stefan Hedman.
* Phaser.Physics.NINJA - A port of Metanet Softwares N+ physics system.
* Phaser.Physics.BOX2D - A commercial Phaser Plugin (see http://phaser.io)
*
* Both Ninja Physics and Box2D require their respective plugins to be loaded before you can start them.
* They are not bundled into the core Phaser library.
*
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* If the physics world has already been created (i.e. in another state in your game) then
* calling startSystem will reset the physics world, not re-create it. If you need to start them again from their constructors
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* then set Phaser.Physics.p2 (or whichever system you want to recreate) to `null` before calling `startSystem`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param system The physics system to start: Phaser.Physics.ARCADE, Phaser.Physics.P2JS, Phaser.Physics.NINJA or Phaser.Physics.BOX2D.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
startSystem(system: number): void;
/**
* Updates all running physics systems.
*/
update(): void;
}
module Physics {
/**
* The Arcade Physics world. Contains Arcade Physics related collision, overlap and motion methods.
*/
class Arcade {
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A constant used for the sortDirection value.
* Use this if you don't wish to perform any pre-collision sorting at all, or will manually sort your Groups.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
static SORT_NONE: number;
/**
* A constant used for the sortDirection value.
* Use this if your game world is wide but short and scrolls from the left to the right (i.e. Mario)
*/
static LEFT_RIGHT: number;
/**
* A constant used for the sortDirection value.
* Use this if your game world is wide but short and scrolls from the right to the left (i.e. Mario backwards)
*/
static RIGHT_LEFT: number;
/**
* A constant used for the sortDirection value.
* Use this if your game world is narrow but tall and scrolls from the top to the bottom (i.e. Dig Dug)
*/
static TOP_BOTTOM: number;
/**
* A constant used for the sortDirection value.
* Use this if your game world is narrow but tall and scrolls from the bottom to the top (i.e. Commando or a vertically scrolling shoot-em-up)
*/
static BOTTOM_TOP: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A value added to the delta values during collision checks.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
static OVERLAP_BIAS: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
static TILE_BIAS: number;
/**
* The Arcade Physics world. Contains Arcade Physics related collision, overlap and motion methods.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game reference to the current game instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* The bounds inside of which the physics world exists. Defaults to match the world bounds.
*/
bounds: Phaser.Rectangle;
/**
* Set the checkCollision properties to control for which bounds collision is processed.
* For example checkCollision.down = false means Bodies cannot collide with the World.bounds.bottom. An object containing allowed collision flags.
*/
checkCollision: { up?: boolean; down?: boolean; left?: boolean; right?: boolean; };
/**
* If true World.separate will always separate on the X axis before Y. Otherwise it will check gravity totals first.
*/
forceX: boolean;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* The World gravity setting. Defaults to x: 0, y: 0, or no gravity.
*/
gravity: Phaser.Point;
/**
* The world QuadTree.
*/
quadTree: Phaser.QuadTree;
/**
* Used by the QuadTree to set the maximum number of objects per quad.
*/
maxObjects: number;
/**
* Used by the QuadTree to set the maximum number of iteration levels.
*/
maxLevels: number;
/**
* If true the QuadTree will not be used for any collision. QuadTrees are great if objects are well spread out in your game, otherwise they are a performance hit. If you enable this you can disable on a per body basis via `Body.skipQuadTree`.
*/
skipQuadTree: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Used when colliding a Sprite vs. a Group, or a Group vs. a Group, this defines the direction the sort is based on. Default is Phaser.Physics.Arcade.LEFT_RIGHT.
*/
sortDirection: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Given the rotation (in radians) and speed calculate the acceleration and return it as a Point object, or set it to the given point object.
* One way to use this is: accelerationFromRotation(rotation, 200, sprite.acceleration) which will set the values directly to the sprites acceleration and not create a new Point object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rotation The angle in radians.
* @param speed The speed it will move, in pixels per second sq. - Default: 60
* @param point The Point object in which the x and y properties will be set to the calculated acceleration.
* @return - A Point where point.x contains the acceleration x value and point.y contains the acceleration y value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
accelerationFromRotation(rotation: number, speed?: number, point?: Phaser.Point): Phaser.Point;
/**
* Sets the acceleration.x/y property on the display object so it will move towards the target at the given speed (in pixels per second sq.)
* You must give a maximum speed value, beyond which the display object won't go any faster.
* Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.
* Note: The display object doesn't stop moving once it reaches the destination coordinates.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to move.
* @param destination The display object to move towards. Can be any object but must have visible x/y properties.
* @param speed The speed it will accelerate in pixels per second. - Default: 60
* @param xSpeedMax The maximum x velocity the display object can reach. - Default: 500
* @param ySpeedMax The maximum y velocity the display object can reach. - Default: 500
* @return The angle (in radians) that the object should be visually set to in order to match its new trajectory.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
accelerateToObject(displayObject: any, destination: any, speed?: number, xSpeedMax?: number, ySpeedMax?: number): number;
/**
* Sets the acceleration.x/y property on the display object so it will move towards the target at the given speed (in pixels per second sq.)
* You must give a maximum speed value, beyond which the display object won't go any faster.
* Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.
* Note: The display object doesn't stop moving once it reaches the destination coordinates.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to move.
* @param pointer The pointer to move towards. Defaults to Phaser.Input.activePointer.
* @param speed The speed it will accelerate in pixels per second. - Default: 60
* @param xSpeedMax The maximum x velocity the display object can reach. - Default: 500
* @param ySpeedMax The maximum y velocity the display object can reach. - Default: 500
* @return The angle (in radians) that the object should be visually set to in order to match its new trajectory.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
accelerateToPointer(displayObject: any, pointer?: Phaser.Pointer, speed?: number, xSpeedMax?: number, ySpeedMax?: number): number;
/**
* Sets the acceleration.x/y property on the display object so it will move towards the x/y coordinates at the given speed (in pixels per second sq.)
* You must give a maximum speed value, beyond which the display object won't go any faster.
* Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.
* Note: The display object doesn't stop moving once it reaches the destination coordinates.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to move.
* @param x The x coordinate to accelerate towards.
* @param y The y coordinate to accelerate towards.
* @param speed The speed it will accelerate in pixels per second. - Default: 60
* @param xSpeedMax The maximum x velocity the display object can reach. - Default: 500
* @param ySpeedMax The maximum y velocity the display object can reach. - Default: 500
* @return The angle (in radians) that the object should be visually set to in order to match its new trajectory.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
accelerateToXY(displayObject: any, x: number, y: number, speed?: number, xSpeedMax?: number, ySpeedMax?: number): number;
/**
* Find the angle in radians between two display objects (like Sprites).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The Display Object to test from.
* @param target The Display Object to test to.
* @return The angle in radians between the source and target display objects.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angleBetween(source: any, target: any): number;
/**
* Find the angle in radians between a display object (like a Sprite) and a Pointer, taking their x/y and center into account.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The Display Object to test from.
* @param pointer The Phaser.Pointer to test to. If none is given then Input.activePointer is used.
* @return The angle in radians between displayObject.x/y to Pointer.x/y
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angleToPointer(displayObject: any, pointer?: Phaser.Pointer): number;
/**
* Find the angle in radians between a display object (like a Sprite) and the given x/y coordinate.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The Display Object to test from.
* @param x The x coordinate to get the angle to.
* @param y The y coordinate to get the angle to.
* @return The angle in radians between displayObject.x/y to Pointer.x/y
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angleToXY(displayObject: any, x: number, y: number): number;
/**
* Checks for collision between two game objects. You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap Layer or Group vs. Tilemap Layer collisions.
* Both the first and second parameter can be arrays of objects, of differing types.
* If two arrays are passed, the contents of the first parameter will be tested against all contents of the 2nd parameter.
* The objects are also automatically separated. If you don't require separation then use ArcadePhysics.overlap instead.
* An optional processCallback can be provided. If given this function will be called when two sprites are found to be colliding. It is called before any separation takes place,
* giving you the chance to perform additional checks. If the function returns true then the collision and separation is carried out. If it returns false it is skipped.
* The collideCallback is an optional function that is only called if two sprites collide. If a processCallback has been set then it needs to return true for collideCallback to be called.
* NOTE: This function is not recursive, and will not test against children of objects passed (i.e. Groups or Tilemaps within other Groups).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object1 The first object or array of objects to check. Can be Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.TilemapLayer.
* @param object2 The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.TilemapLayer.
* @param collideCallback An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them, unless you are colliding Group vs. Sprite, in which case Sprite will always be the first parameter. - Default: null
* @param processCallback A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them. - Default: null
* @param callbackContext The context in which to run the callbacks.
* @return True if a collision occurred otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
collide(object1: any, object2: any, collideCallback?: Function, processCallback?: Function, callbackContext?: any): boolean;
/**
* A tween-like function that takes a starting velocity and some other factors and returns an altered velocity.
* Based on a function in Flixel by @ADAMATOMIC
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param axis 0 for nothing, 1 for horizontal, 2 for vertical.
* @param body The Body object to be updated.
* @param velocity Any component of velocity (e.g. 20).
* @param acceleration Rate at which the velocity is changing.
* @param drag Really kind of a deceleration, this is how much the velocity changes if Acceleration is not set.
* @param max An absolute value cap for the velocity. - Default: 10000
* @return The altered Velocity value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
computeVelocity(axis: number, body: Phaser.Physics.Arcade.Body, velocity: number, acceleration: number, drag: number, max?: number): number;
/**
* Find the distance between two display objects (like Sprites).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The Display Object to test from.
* @param target The Display Object to test to.
* @return The distance between the source and target objects.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
distanceBetween(source: any, target: any): number;
/**
* Find the distance between a display object (like a Sprite) and a Pointer. If no Pointer is given the Input.activePointer is used.
* The calculation is made from the display objects x/y coordinate. This may be the top-left if its anchor hasn't been changed.
* If you need to calculate from the center of a display object instead use the method distanceBetweenCenters()
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The distance to the Pointer is returned in screen space, not world space.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The Display Object to test from.
* @param pointer The Phaser.Pointer to test to. If none is given then Input.activePointer is used.
* @return The distance between the object and the Pointer.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
distanceToPointer(displayObject: any, pointer?: Phaser.Pointer): number;
/**
* Find the distance between a display object (like a Sprite) and the given x/y coordinates.
* The calculation is made from the display objects x/y coordinate. This may be the top-left if its anchor hasn't been changed.
* If you need to calculate from the center of a display object instead use the method distanceBetweenCenters()
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The Display Object to test from.
* @param x The x coordinate to move towards.
* @param y The y coordinate to move towards.
* @return The distance between the object and the x/y coordinates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
distanceToXY(displayObject: any, x: number, y: number): number;
/**
* This will create an Arcade Physics body on the given game object or array of game objects.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.
* @param children Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enable(object: any, children?: Boolean): void;
/**
* Creates an Arcade Physics body on the given game object.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the body is nulled.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. A body will only be created if this object has a null `body` property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enableBody(object: any): void;
/**
* Given a Group and a location this will check to see which Group children overlap with the coordinates.
* Each child will be sent to the given callback for further processing.
* Note that the children are not checked for depth order, but simply if they overlap the coordinate or not.
*
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
* @param x The x coordinate to check.
* @param y The y coordinate to check.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param group The Group to check.
* @param callback A callback function that is called if the object overlaps the coordinates. The callback will be sent two parameters: the callbackArg and the Object that overlapped the location.
* @param callbackContext The context in which to run the callback.
* @param callbackArg An argument to pass to the callback.
* @return An array of the Sprites from the Group that overlapped the coordinates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getObjectsAtLocation(x: number, y: number, group: Phaser.Group, callback?: (callbackArg: any, object: any) => void, callbackContext?: any, callbackArg?: any): Sprite[];
/**
* Check for intersection against two bodies.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body1 The Body object to check.
* @param body2 The Body object to check.
* @return True if they intersect, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
intersects(body1: Phaser.Physics.Arcade.Body, body2: Phaser.Physics.Arcade.Body): boolean;
/**
* Move the given display object towards the destination object at a steady velocity.
* If you specify a maxTime then it will adjust the speed (overwriting what you set) so it arrives at the destination in that number of seconds.
* Timings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.
* Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.
* Note: The display object doesn't stop moving once it reaches the destination coordinates.
* Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to move.
* @param destination The display object to move towards. Can be any object but must have visible x/y properties.
* @param speed The speed it will move, in pixels per second (default is 60 pixels/sec) - Default: 60
* @param maxTime Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms. - Default: 0
* @return The angle (in radians) that the object should be visually set to in order to match its new velocity.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveToObject(displayObject: any, destination: any, speed?: number, maxTime?: number): number;
/**
* Move the given display object towards the pointer at a steady velocity. If no pointer is given it will use Phaser.Input.activePointer.
* If you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds.
* Timings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.
* Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.
* Note: The display object doesn't stop moving once it reaches the destination coordinates.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to move.
* @param speed The speed it will move, in pixels per second (default is 60 pixels/sec) - Default: 60
* @param pointer The pointer to move towards. Defaults to Phaser.Input.activePointer.
* @param maxTime Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms. - Default: 0
* @return The angle (in radians) that the object should be visually set to in order to match its new velocity.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveToPointer(displayObject: any, speed?: number, pointer?: Phaser.Pointer, maxTime?: number): number;
/**
* Move the given display object towards the x/y coordinates at a steady velocity.
* If you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds.
* Timings are approximate due to the way browser timers work. Allow for a variance of +- 50ms.
* Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course.
* Note: The display object doesn't stop moving once it reaches the destination coordinates.
* Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to move.
* @param x The x coordinate to move towards.
* @param y The y coordinate to move towards.
* @param speed The speed it will move, in pixels per second (default is 60 pixels/sec) - Default: 60
* @param maxTime Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms. - Default: 0
* @return The angle (in radians) that the object should be visually set to in order to match its new velocity.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveToXY(displayObject: any, x: number, y: number, speed?: number, maxTime?: number): number;
/**
* Checks for overlaps between two game objects. The objects can be Sprites, Groups or Emitters.
* You can perform Sprite vs. Sprite, Sprite vs. Group and Group vs. Group overlap checks.
* Unlike collide the objects are NOT automatically separated or have any physics applied, they merely test for overlap results.
* Both the first and second parameter can be arrays of objects, of differing types.
* If two arrays are passed, the contents of the first parameter will be tested against all contents of the 2nd parameter.
* NOTE: This function is not recursive, and will not test against children of objects passed (i.e. Groups within Groups).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object1 The first object or array of objects to check. Can be Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.
* @param object2 The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param overlapCallback An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them. The two objects will be passed to this function in the same order in which you specified them, unless you are checking Group vs. Sprite, in which case Sprite will always be the first parameter. - Default: null
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param processCallback A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then overlapCallback will only be called if processCallback returns true. - Default: null
* @param callbackContext The context in which to run the callbacks.
* @return True if an overlap occurred otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
overlap(object1: any, object2: any, overlapCallback?: Function, processCallback?: Function, callbackContext?: any): boolean;
processTileSeparationX(body: Phaser.Physics.Arcade.Body, x: number): boolean;
processTileSeparationY(body: Phaser.Physics.Arcade.Body, y: number): void;
/**
* Updates the size of this physics world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x Top left most corner of the world.
* @param y Top left most corner of the world.
* @param width New width of the world. Can never be smaller than the Game.width.
* @param height New height of the world. Can never be smaller than the Game.height.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setBounds(x: number, y: number, width: number, height: number): void;
/**
* Updates the size of this physics world to match the size of the game world.
*/
setBoundsToWorld(): void;
/**
* The core separation function to separate two physics bodies.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body1 The first Body object to separate.
* @param body2 The second Body object to separate.
* @param processCallback A callback function that lets you perform additional checks against the two objects if they overlap. If this function is set then the sprites will only be collided if it returns true. - Default: null
* @param callbackContext The context in which to run the process callback.
* @param overlapOnly Just run an overlap or a full collision.
* @return Returns true if the bodies collided, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
separate(body1: Phaser.Physics.Arcade.Body, body2: Phaser.Physics.Arcade.Body, processCallback?: Function, callbackContext?: any, overlapOnly?: boolean): boolean;
/**
* The core separation function to separate two physics bodies on the x axis.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body1 The Body object to separate.
* @param body2 The Body object to separate.
* @param overlapOnly If true the bodies will only have their overlap data set, no separation or exchange of velocity will take place.
* @return Returns true if the bodies were separated, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
separateX(body1: Phaser.Physics.Arcade.Body, body2: Phaser.Physics.Arcade.Body, overlapOnly: boolean): boolean;
/**
* The core separation function to separate two physics bodies on the y axis.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body1 The Body object to separate.
* @param body2 The Body object to separate.
* @param overlapOnly If true the bodies will only have their overlap data set, no separation or exchange of velocity will take place.
* @return Returns true if the bodies were separated, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
separateY(body1: Phaser.Physics.Arcade.Body, body2: Phaser.Physics.Arcade.Body, overlapOnly: boolean): boolean;
separateTile(i: number, body: Phaser.Physics.Arcade.Body, tile: Phaser.Tile): boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
sort(group: Phaser.Group): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
tileCheckX(body: Phaser.Physics.Arcade.Body, tile: Phaser.Tile): number;
tileCheckY(body: Phaser.Physics.Arcade.Body, tile: Phaser.Tile): number;
/**
* Called automatically by a Physics body, it updates all motion related values on the Body unless `World.isPaused` is `true`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param The Body object to be updated.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateMotion(body: Phaser.Physics.Arcade.Body): void;
/**
* Given the angle (in degrees) and speed calculate the velocity and return it as a Point object, or set it to the given point object.
* One way to use this is: velocityFromAngle(angle, 200, sprite.velocity) which will set the values directly to the sprites velocity and not create a new Point object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param angle The angle in degrees calculated in clockwise positive direction (down = 90 degrees positive, right = 0 degrees positive, up = 90 degrees negative)
* @param speed The speed it will move, in pixels per second sq. - Default: 60
* @param point The Point object in which the x and y properties will be set to the calculated velocity.
* @return - A Point where point.x contains the velocity x value and point.y contains the velocity y value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
velocityFromAngle(angle: number, speed?: number, point?: Phaser.Point): Phaser.Point;
/**
* Given the rotation (in radians) and speed calculate the velocity and return it as a Point object, or set it to the given point object.
* One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) which will set the values directly to the sprites velocity and not create a new Point object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rotation The angle in radians.
* @param speed The speed it will move, in pixels per second sq. - Default: 60
* @param point The Point object in which the x and y properties will be set to the calculated velocity.
* @return - A Point where point.x contains the velocity x value and point.y contains the velocity y value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
velocityFromRotation(rotation: number, speed?: number, point?: Phaser.Point): Phaser.Point;
}
module Arcade {
/**
* The Physics Body is linked to a single Sprite. All physics operations should be performed against the body rather than
* the Sprite itself. For example you can set the velocity, acceleration, bounce values etc all on the Body.
*/
class Body {
/**
* The Physics Body is linked to a single Sprite. All physics operations should be performed against the body rather than
* the Sprite itself. For example you can set the velocity, acceleration, bounce values etc all on the Body.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The Sprite object this physics body belongs to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(sprite: Phaser.Sprite);
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The acceleration is the rate of change of the velocity. Measured in pixels per second squared.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
acceleration: Phaser.Point;
/**
* Allow this Body to be influenced by gravity? Either world or local.
* Default: true
*/
allowGravity: boolean;
/**
* Allow this Body to be rotated? (via angularVelocity, etc)
* Default: true
*/
allowRotation: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angle of the Body in radians, as calculated by its angularVelocity.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angular acceleration is the rate of change of the angular velocity. Measured in radians per second squared.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: 0
*/
angularAcceleration: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The drag applied during the rotation of the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: 0
*/
angularDrag: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angular velocity controls the rotation speed of the Body. It is measured in radians per second.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: 0
*/
angularVelocity: number;
/**
* This object is populated with boolean values when the Body collides with the World bounds or a Tile.
* For example if blocked.up is true then the Body cannot move up. An object containing on which faces this Body is blocked from moving, if any.
*/
blocked: FaceChoices;
/**
* The bottom value of this Body (same as Body.y + Body.height)
*/
bottom: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The elasticity of the Body when colliding. bounce.x/y = 1 means full rebound, bounce.x/y = 0.5 means 50% rebound velocity.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
bounce: Phaser.Point;
/**
* The center coordinate of the Physics Body.
*/
center: Phaser.Point;
/**
* Set the checkCollision properties to control which directions collision is processed for this Body.
* For example checkCollision.up = false means it won't collide when the collision happened while moving up. An object containing allowed collision.
*/
checkCollision: FaceChoices;
/**
* A Body can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World. Should the Body collide with the World bounds?
*/
collideWorldBounds: boolean;
/**
* This flag allows you to disable the custom x separation that takes place by Physics.Arcade.separate.
* Used in combination with your own collision processHandler you can create whatever type of collision response you need. Use a custom separation system or the built-in one?
* Default: false
*/
customSeparateX: boolean;
/**
* This flag allows you to disable the custom y separation that takes place by Physics.Arcade.separate.
* Used in combination with your own collision processHandler you can create whatever type of collision response you need. Use a custom separation system or the built-in one?
* Default: false
*/
customSeparateY: boolean;
/**
* The Sprite position is updated based on the delta x/y values. You can set a cap on those (both +-) using deltaMax.
*/
deltaMax: Phaser.Point;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* If this Body in a preUpdate (true) or postUpdate (false) state?
*/
dirty: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The drag applied to the motion of the Body.
*/
drag: Phaser.Point;
/**
* If a body is overlapping with another body, but neither of them are moving (maybe they spawned on-top of each other?) this is set to true. Body embed value.
*/
embedded: boolean;
/**
* A disabled body won't be checked for any form of collision or overlap or have its pre/post updates run.
* Default: true
*/
enable: boolean;
/**
* A const reference to the direction the Body is traveling or facing.
*/
facing: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The amount of movement that will occur if another object 'rides' this one.
*/
friction: Phaser.Point;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* A local gravity applied to this Body. If non-zero this over rides any world gravity, unless Body.allowGravity is set to false.
*/
gravity: Phaser.Point;
/**
* The calculated width / 2 of the physics body.
*/
halfWidth: number;
/**
* The calculated height / 2 of the physics body.
*/
halfHeight: number;
/**
* An immovable Body will not receive any impacts from other bodies.
* Default: false
*/
immovable: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The mass of the Body. When two bodies collide their mass is used in the calculation to determine the exchange of velocity.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: 1
*/
mass: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The maximum angular velocity in radians per second that the Body can reach.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: 1000
*/
maxAngular: number;
/**
* The maximum velocity in pixels per second sq. that the Body can reach.
*/
maxVelocity: Phaser.Point;
/**
* If you have a Body that is being moved around the world via a tween or a Group motion, but its local x/y position never
* actually changes, then you should set Body.moves = false. Otherwise it will most likely fly off the screen.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If you want the physics system to move the body around, then set moves to true. Set to true to allow the Physics system to move this Body, otherwise false to move it manually.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: true
*/
moves: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The new velocity. Calculated during the Body.preUpdate and applied to its position.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
newVelocity: Phaser.Point;
/**
* The offset of the Physics Body from the Sprite x/y position.
*/
offset: Phaser.Point;
/**
* When this body collides with another, the amount of overlap is stored here. The amount of horizontal overlap during the collision.
*/
overlapX: number;
/**
* When this body collides with another, the amount of overlap is stored here. The amount of vertical overlap during the collision.
*/
overlapY: number;
phase: number;
/**
* The position of the physics body.
*/
position: Phaser.Point;
/**
* The previous rotation of the physics body.
*/
preRotation: number;
/**
* The previous position of the physics body.
*/
prev: Phaser.Point;
/**
* The right value of this Body (same as Body.x + Body.width)
*/
right: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* An Arcade Physics Body can have angularVelocity and angularAcceleration. Please understand that the collision Body
* itself never rotates, it is always axis-aligned. However these values are passed up to the parent Sprite and updates its rotation.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
rotation: number;
/**
* If true and you collide this Sprite against a Group, it will disable the collision check from using a QuadTree.
*/
skipQuadTree: boolean;
/**
* The un-scaled original size.
*/
sourceWidth: number;
/**
* The un-scaled original size.
*/
sourceHeight: number;
/**
* The speed of the Body as calculated by its velocity.
*/
speed: number;
/**
* Reference to the parent Sprite.
*/
sprite: Phaser.Sprite;
/**
* If this is an especially small or fast moving object then it can sometimes skip over tilemap collisions if it moves through a tile in a step.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Set this padding value to add extra padding to its bounds. tilePadding.x applied to its width, y to its height. Extra padding to be added to this sprite's dimensions when checking for tile collision.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
tilePadding: Phaser.Point;
/**
* This object is populated with boolean values when the Body collides with another.
* touching.up = true means the collision happened to the top of this Body for example. An object containing touching results.
*/
touching: FaceChoices;
/**
* The type of physics system this body belongs to.
*/
type: number;
/**
* This object is populated with previous touching values from the bodies previous collision. An object containing previous touching results.
*/
wasTouching: FaceChoices;
/**
* The calculated width of the physics body.
*/
width: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The velocity, or rate of change in speed of the Body. Measured in pixels per second.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
velocity: Phaser.Point;
/**
* The x position.
*/
x: number;
/**
* The y position.
*/
y: number;
/**
* Internal method.
*/
checkWorldBounds(): void;
/**
* Returns the delta x value. The difference between Body.x now and in the previous step.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The delta value. Positive if the motion was to the right, negative if to the left.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaX(): number;
/**
* Returns the delta y value. The difference between Body.y now and in the previous step.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The delta value. Positive if the motion was downwards, negative if upwards.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaY(): number;
/**
* Returns the delta z value. The difference between Body.rotation now and in the previous step.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The delta value. Positive if the motion was clockwise, negative if anti-clockwise.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaZ(): number;
/**
* Returns the absolute delta x value.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The absolute delta value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaAbsX(): void;
/**
* Returns the absolute delta y value.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The absolute delta value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaAbsY(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Removes this body's reference to its parent sprite, freeing it up for gc.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(): void;
/**
* Tests if a world point lies within this Body.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The world x coordinate to test.
* @param y The world y coordinate to test.
* @return True if the given coordinates are inside this Body, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
hitTest(x: number, y: number): boolean;
/**
* Returns true if the bottom of this Body is in contact with either the world bounds or a tile.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if in contact with either the world bounds or a tile.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onFloor(): void;
/**
* Returns true if either side of this Body is in contact with either the world bounds or a tile.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if in contact with either the world bounds or a tile.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onWall(): void;
/**
* Internal method.
*/
preUpdate(): void;
/**
* Internal method.
*/
postUpdate(): void;
/**
* Render Sprite Body.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context to render to.
* @param body The Body to render the info of.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgba(0,255,0,0.4)'
* @param filled Render the objected as a filled (default, true) or a stroked (false) - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
render(context: any, body: Phaser.Physics.Arcade.Body, color?: string, filled?: boolean): void;
/**
* Render Sprite Body Physics Data as text.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body The Body to render the info of.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
renderBodyInfo(debug: Phaser.Utils.Debug, body: Phaser.Physics.Arcade.Body): void;
/**
* Resets all Body values (velocity, acceleration, rotation, etc)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The new x position of the Body.
* @param y The new y position of the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(x: number, y: number): void;
/**
* You can modify the size of the physics Body to be any dimension you need.
* So it could be smaller or larger than the parent Sprite. You can also control the x and y offset, which
* is the position of the Body relative to the top-left of the Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of the Body.
* @param height The height of the Body.
* @param offsetX The X offset of the Body from the Sprite position.
* @param offsetY The Y offset of the Body from the Sprite position.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setSize(width: number, height: number, offsetX?: number, offsetY?: number): void;
/**
* Internal method.
*/
updateBounds(): boolean;
}
class FaceChoices {
none: boolean;
any: boolean;
up: boolean;
down: boolean;
left: boolean;
right: boolean;
}
}
/**
* Ninja Physics. The Ninja Physics system was created in Flash by Metanet Software and ported to JavaScript by Richard Davey.
*
* It allows for AABB and Circle to Tile collision. Tiles can be any of 34 different types, including slopes, convex and concave shapes.
*
* It does what it does very well, but is ripe for expansion and optimisation. Here are some features that I'd love to see the community add:
*
* * AABB to AABB collision
* * AABB to Circle collision
* * AABB and Circle 'immovable' property support
* * n-way collision, so an AABB/Circle could pass through a tile from below and land upon it.
* * QuadTree or spatial grid for faster Body vs. Tile Group look-ups.
* * Optimise the internal vector math and reduce the quantity of temporary vars created.
* * Expand Gravity and Bounce to allow for separate x/y axis values.
* * Support Bodies linked to Sprites that don't have anchor set to 0.5
*
* Feel free to attempt any of the above and submit a Pull Request with your code! Be sure to include test cases proving they work.
*/
class Ninja {
/**
* Ninja Physics. The Ninja Physics system was created in Flash by Metanet Software and ported to JavaScript by Richard Davey.
*
* It allows for AABB and Circle to Tile collision. Tiles can be any of 34 different types, including slopes, convex and concave shapes.
*
* It does what it does very well, but is ripe for expansion and optimisation. Here are some features that I'd love to see the community add:
*
* * AABB to AABB collision
* * AABB to Circle collision
* * AABB and Circle 'immovable' property support
* * n-way collision, so an AABB/Circle could pass through a tile from below and land upon it.
* * QuadTree or spatial grid for faster Body vs. Tile Group look-ups.
* * Optimise the internal vector math and reduce the quantity of temporary vars created.
* * Expand Gravity and Bounce to allow for separate x/y axis values.
* * Support Bodies linked to Sprites that don't have anchor set to 0.5
*
* Feel free to attempt any of the above and submit a Pull Request with your code! Be sure to include test cases proving they work.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game reference to the current game instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* Local reference to game.
*/
game: Phaser.Game
/**
* The World gravity setting.
*/
gravity: number;
/**
* The bounds inside of which the physics world exists. Defaults to match the world bounds.
*/
bounds: Phaser.Rectangle;
/**
* Used by the QuadTree to set the maximum number of objects per quad.
*/
maxObjects: number;
/**
* Used by the QuadTree to set the maximum number of iteration levels.
*/
maxLevels: number;
/**
* The world QuadTree.
*/
quadTree: Phaser.QuadTree;
/**
* Local reference to game.time.
*/
time: Phaser.Time;
/**
* Clears all physics bodies from the given TilemapLayer that were created with `World.convertTilemap`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param map The Tilemap to get the map data from.
* @param layer The layer to operate on. If not given will default to map.currentLayer.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clearTilemapLayerBodies(map: Phaser.Tilemap, layer: any): void;
/**
* Checks for collision between two game objects. You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap Layer or Group vs. Tilemap Layer collisions.
* The second parameter can be an array of objects, of differing types.
* The objects are also automatically separated. If you don't require separation then use ArcadePhysics.overlap instead.
* An optional processCallback can be provided. If given this function will be called when two sprites are found to be colliding. It is called before any separation takes place,
* giving you the chance to perform additional checks. If the function returns true then the collision and separation is carried out. If it returns false it is skipped.
* The collideCallback is an optional function that is only called if two sprites collide. If a processCallback has been set then it needs to return true for collideCallback to be called.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object1 The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.TilemapLayer.
* @param object2 The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.TilemapLayer.
* @param collideCallback An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them. - Default: null
* @param processCallback A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them. - Default: null
* @param callbackContext The context in which to run the callbacks.
* @return True if a collision occured otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
collide(object1: any, object2: any, collideCallback?: Function, processCallback?: Function, callbackContext?: any): boolean;
/**
* Goes through all tiles in the given Tilemap and TilemapLayer and converts those set to collide into physics tiles.
* Only call this *after* you have specified all of the tiles you wish to collide with calls like Tilemap.setCollisionBetween, etc.
* Every time you call this method it will destroy any previously created bodies and remove them from the world.
* Therefore understand it's a very expensive operation and not to be done in a core game update loop.
*
* In Ninja the Tiles have an ID from 0 to 33, where 0 is 'empty', 1 is a full tile, 2 is a 45-degree slope, etc. You can find the ID
* list either at the very bottom of `Tile.js`, or in a handy visual reference in the `resources/Ninja Physics Debug Tiles` folder in the repository.
* The slopeMap parameter is an array that controls how the indexes of the tiles in your tilemap data will map to the Ninja Tile IDs.
* For example if you had 6 tiles in your tileset: Imagine the first 4 should be converted into fully solid Tiles and the other 2 are 45-degree slopes.
* Your slopeMap array would look like this: `[ 1, 1, 1, 1, 2, 3 ]`.
* Where each element of the array is a tile in your tilemap and the resulting Ninja Tile it should create.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param map The Tilemap to get the map data from.
* @param layer The layer to operate on. If not given will default to map.currentLayer.
* @param slopeMap The tilemap index to Tile ID map.
* @return An array of the Phaser.Physics.Ninja.Tile objects that were created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
convertTilemap(map: Phaser.Tilemap, layer?: any, slopeMap?: any): Phaser.Physics.Ninja.Tile[];
/**
* This will create a Ninja Physics AABB body on the given game object. Its dimensions will match the width and height of the object at the point it is created.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.
* @param children Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enableAABB(object: any, children?: boolean): void;
/**
* This will create a Ninja Physics Circle body on the given game object.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.
* @param radius The radius of the Circle.
* @param children Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enableCircle(object: any, radius: number, children?: boolean): void;
/**
* This will create a Ninja Physics Tile body on the given game object. There are 34 different types of tile you can create, including 45 degree slopes,
* convex and concave circles and more. The id parameter controls which Tile type is created, but you can also change it at run-time.
* Note that for all degree based tile types they need to have an equal width and height. If the given object doesn't have equal width and height it will use the width.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.
* @param id The type of Tile this will use, i.e. Phaser.Physics.Ninja.Tile.SLOPE_45DEGpn, Phaser.Physics.Ninja.Tile.CONVEXpp, etc. - Default: 1
* @param children Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enableTile(object: any, id: number, children?: boolean): void;
/**
* This will create a Ninja Physics body on the given game object or array of game objects.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.
* @param type The type of Ninja shape to create. 1 = AABB, 2 = Circle or 3 = Tile. - Default: 1
* @param id If this body is using a Tile shape, you can set the Tile id here, i.e. Phaser.Physics.Ninja.Tile.SLOPE_45DEGpn, Phaser.Physics.Ninja.Tile.CONVEXpp, etc. - Default: 1
* @param radius If this body is using a Circle shape this controls the radius. - Default: 0
* @param children Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enable(object: any, type?: number, id?: number, radius?: number, children?: boolean): void;
/**
* Creates a Ninja Physics body on the given game object.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the body is nulled.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. A body will only be created if this object has a null `body` property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enableBody(object: any, type?: number, id?: number, radius?: number): void;
/**
* Checks for overlaps between two game objects. The objects can be Sprites, Groups or Emitters.
* You can perform Sprite vs. Sprite, Sprite vs. Group and Group vs. Group overlap checks.
* Unlike collide the objects are NOT automatically separated or have any physics applied, they merely test for overlap results.
* The second parameter can be an array of objects, of differing types.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object1 The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.
* @param object2 The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.
* @param overlapCallback An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them. - Default: null
* @param processCallback A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then overlapCallback will only be called if processCallback returns true. - Default: null
* @param callbackContext The context in which to run the callbacks.
* @return True if an overlap occured otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
overlap(object1: any, object2: any, overlapCallback?: Function, processCallback?: Function, callbackContext?: any): boolean;
/**
* The core separation function to separate two physics bodies.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body1 The Body object to separate.
* @param body2 The Body object to separate.
* @return Returns true if the bodies collided, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
separate(body1: Phaser.Physics.Ninja.Body, body2: Phaser.Physics.Ninja.Body, processCallback?: Function, callbackContext?: any, overlapOnly?: boolean): boolean;
/**
* Updates the size of this physics world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x Top left most corner of the world.
* @param y Top left most corner of the world.
* @param width New width of the world. Can never be smaller than the Game.width.
* @param height New height of the world. Can never be smaller than the Game.height.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setBounds(x: number, y: number, width: number, height: number): void;
/**
* Updates the size of this physics world to match the size of the game world.
*/
setBoundsToWorld(): void;
}
module Ninja {
/**
* The Physics Body is linked to a single Sprite. All physics operations should be performed against the body rather than
* the Sprite itself. For example you can set the velocity, bounce values etc all on the Body.
*/
class Body {
/**
* The Physics Body is linked to a single Sprite. All physics operations should be performed against the body rather than
* the Sprite itself. For example you can set the velocity, bounce values etc all on the Body.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param system The physics system this Body belongs to.
* @param sprite The Sprite object this physics body belongs to.
* @param type The type of Ninja shape to create. 1 = AABB, 2 = Circle or 3 = Tile. - Default: 1
* @param id If this body is using a Tile shape, you can set the Tile id here, i.e. Phaser.Physics.Ninja.Tile.SLOPE_45DEGpn, Phaser.Physics.Ninja.Tile.CONVEXpp, etc. - Default: 1
* @param radius If this body is using a Circle shape this controls the radius. - Default: 16
* @param x The x coordinate of this Body. This is only used if a sprite is not provided. - Default: 0
* @param y The y coordinate of this Body. This is only used if a sprite is not provided. - Default: 0
* @param width The width of this Body. This is only used if a sprite is not provided. - Default: 0
* @param height The height of this Body. This is only used if a sprite is not provided. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(system: Phaser.Physics.Ninja, sprite: Phaser.Sprite, type?: number, id?: number, radius?: number, x?: number, y?: number, width?: number, height?: number);
/**
* The AABB object this body is using for collision.
*/
aabb: Phaser.Physics.Ninja.AABB;
/**
* The angle of this Body
*/
angle: number;
/**
* The bottom value of this Body (same as Body.y + Body.height)
*/
bottom: number;
/**
* The bounciness of this object when it collides. A value between 0 and 1. We recommend setting it to 0.999 to avoid jittering.
* Default: 0.3
*/
bounce: number;
/**
* Set the checkCollision properties to control which directions collision is processed for this Body.
* For example checkCollision.up = false means it won't collide when the collision happened while moving up. An object containing allowed collision.
*/
checkCollision: Phaser.Physics.Arcade.FaceChoices;
/**
* The Circle object this body is using for collision.
*/
circle: Phaser.Physics.Ninja.Circle;
/**
* A Body can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World. Should the Body collide with the World bounds?
*/
collideWorldBounds: boolean;
/**
* The drag applied to this object as it moves.
* Default: 1
*/
drag: number;
/**
* A const reference to the direction the Body is traveling or facing.
*/
facing: number;
/**
* The friction applied to this object as it moves.
* Default: 0.05
*/
friction: number;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* How much of the world gravity should be applied to this object? 1 = all of it, 0.5 = 50%, etc.
* Default: 1
*/
gravityScale: number;
/**
* The height of this Body
*/
height: number;
/**
* An immovable Body will not receive any impacts from other bodies. Not fully implemented.
* Default: false
*/
immovable: boolean;
/**
* The maximum speed this body can travel at (taking drag and friction into account)
* Default: 8
*/
maxSpeed: number;
/**
* The right value of this Body (same as Body.x + Body.width)
*/
right: number;
/**
* Reference to the parent Sprite.
*/
sprite: Phaser.Sprite;
/**
* The parent physics system.
*/
system: Phaser.Physics.Ninja;
/**
* The Tile object this body is using for collision.
*/
tile: Phaser.Physics.Ninja.Tile;
/**
* This object is populated with boolean values when the Body collides with another.
* touching.up = true means the collision happened to the top of this Body for example. An object containing touching results.
*/
touching: Phaser.Physics.Arcade.FaceChoices;
/**
* The type of physics system this body belongs to.
*/
type: number;
/**
* A local reference to the body shape.
*/
shape: any;
/**
* The speed of this Body
*/
speed: number;
/**
* The velocity in pixels per second sq. of the Body.
*/
velocity: Phaser.Point;
/**
* This object is populated with previous touching values from the bodies previous collision. An object containing previous touching results.
*/
wasTouching: Phaser.Physics.Arcade.FaceChoices;
/**
* The width of this Body
*/
width: number;
/**
* The x position.
*/
x: number;
/**
* The y position.
*/
y: number;
/**
* Returns the absolute delta x value.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The absolute delta value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaAbsX(): number;
/**
* Returns the absolute delta y value.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The absolute delta value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaAbsY(): number;
/**
* Returns the delta x value. The difference between Body.x now and in the previous step.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The delta value. Positive if the motion was to the right, negative if to the left.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaX(): number;
/**
* Returns the delta y value. The difference between Body.y now and in the previous step.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The delta value. Positive if the motion was downwards, negative if upwards.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaY(): number;
/**
* Destroys this body's reference to the sprite and system, and destroys its shape.
*/
destroy(): void;
/**
* Stops all movement of this body.
*/
setZeroVelocity(): void;
moveTo(speed: number, angle: number): void;
moveFrom(speed: number, angle: number): void;
moveLeft(speed: number): void;
moveRight(speed: number): void;
moveUp(speed: number): void;
moveDown(speed: number): void;
poseUpdate(): void;
/**
* Internal method.
*/
preUpdate(): void;
/**
* Render Sprite's Body.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context to render to.
* @param body The Body to render.
* @param color color of the debug shape to be rendered. (format is css color string). - Default: 'rgba(0,255,0,0.4)'
* @param filled Render the shape as a filled (default, true) or a stroked (false) - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
render(context: any, body: Phaser.Physics.Ninja.Body, color?: string, filled?: boolean): void;
/**
* Resets all Body values and repositions on the Sprite.
*/
reset(): void;
}
/**
* Ninja Physics AABB constructor.
* Note: This class could be massively optimised and reduced in size. I leave that challenge up to you.
*/
class AABB {
/**
* Ninja Physics AABB constructor.
* Note: This class could be massively optimised and reduced in size. I leave that challenge up to you.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body The body that owns this shape.
* @param x The x coordinate to create this shape at.
* @param y The y coordinate to create this shape at.
* @param width The width of this AABB.
* @param height The height of this AABB.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(body: Phaser.Physics.Ninja.Body, x: number, y: number, width: number, height: number);
static COL_NONE: number;
static COL_AXIS: number;
static COL_OTHER: number;
/**
* All of the collision response handlers.
*/
aabbTileProjections: any;
/**
* A reference to the body that owns this shape.
*/
body: Phaser.Physics.Ninja.Body;
/**
* The height.
*/
height: number;
oldPos: Phaser.Point;
/**
* The position of this object.
*/
pos: Phaser.Point;
/**
* A reference to the physics system.
*/
system: Phaser.Physics.Ninja;
/**
* The width.
*/
width: number;
/**
* The velocity of this object.
*/
velocity: Phaser.Point;
/**
* Half the width.
*/
xw: number;
/**
* Half the height.
*/
yw: number;
/**
* Collides this AABB against the world bounds.
*/
collideWorldBounds(): void;
/**
* Collides this AABB against a AABB.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param aabb The AABB to collide against.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
collideAABBVsAABB(aabb: Phaser.Physics.Ninja.AABB): boolean;
/**
* Collides this AABB against a Tile.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tile The Tile to collide against.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
collideAABBVsTile(tile: Phaser.Physics.Ninja.Tile): boolean;
/**
* Destroys this AABB's reference to Body and System
*/
destroy(): void;
/**
* Updates this AABBs position.
*/
integrate(): void;
/**
* Render this AABB for debugging purposes.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context to render to.
* @param xOffset X offset from AABB's position to render at.
* @param yOffset Y offset from AABB's position to render at.
* @param color color of the debug shape to be rendered. (format is css color string).
* @param filled Render the shape as solid (true) or hollow (false).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
render(context: any, xOffset: number, yOffset: number, color: string, filled: boolean): void;
/**
* Process a world collision and apply the resulting forces.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param px The tangent velocity
* @param py The tangent velocity
* @param dx Collision normal
* @param dy Collision normal
* @param obj Object this AABB collided with
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reportCollisionVsWorld(px: number, py: number, dx: number, dy: number, obj: any): void;
/**
* Process a body collision and apply the resulting forces. Still very much WIP and doesn't work fully. Feel free to fix!
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param px The tangent velocity
* @param py The tangent velocity
* @param dx Collision normal
* @param dy Collision normal
* @param obj Object this AABB collided with
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reportCollisionVsBody(px: number, py: number, dx: number, dy: number, obj: any): void;
/**
* Resolves tile collision.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x Penetration depth on the x axis.
* @param y Penetration depth on the y axis.
* @param body The AABB involved in the collision.
* @param tile The Tile involved in the collision.
* @return True if the collision was processed, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
resolveTile(x: number, y: number, body: Phaser.Physics.Ninja.AABB, tile: Phaser.Physics.Ninja.Tile): boolean;
reverse(): void;
}
/**
* Ninja Physics Circle constructor.
* Note: This class could be massively optimised and reduced in size. I leave that challenge up to you.
*/
class Circle {
/**
* Ninja Physics Circle constructor.
* Note: This class could be massively optimised and reduced in size. I leave that challenge up to you.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body The body that owns this shape.
* @param x The x coordinate to create this shape at.
* @param y The y coordinate to create this shape at.
* @param radius The radius of this Circle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(body: Phaser.Physics.Ninja.Body, x: number, y: number, radius: number);
COL_NONE: number;
COL_AXIS: number;
COL_OTHER: number;
/**
* A reference to the body that owns this shape.
*/
body: Phaser.Physics.Ninja.Body;
/**
* All of the collision response handlers.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
circleTileProjections: { [index: number]: ((x: number, y: number, oH: number, oV: number, obj: Phaser.Physics.Ninja.Circle, t: Phaser.Physics.Ninja.Tile) => number); };
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
oldPos: Phaser.Point;
/**
* The height.
*/
height: number;
/**
* The position of this object.
*/
pos: Phaser.Point;
/**
* The radius of this circle shape.
*/
radius: number;
/**
* A reference to the physics system.
*/
system: Phaser.Physics.Ninja;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
type: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The velocity of this object.
*/
velocity: Phaser.Point;
/**
* The width.
*/
width: number;
/**
* Half the width.
*/
xw: number;
/**
* Half the height.
*/
yw: number;
/**
* Collides this Circle with a Tile.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param t The Tile involved in the collision.
* @return True if they collide, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
collideCircleVsTile(tile: Phaser.Physics.Ninja.Tile): boolean;
/**
* Collides this Circle against the world bounds.
*/
collideWorldBounds(): void;
/**
* Destroys this Circle's reference to Body and System
*/
destroy(): void;
distance(dest: number, round?: boolean): number;
/**
* Updates this Circles position.
*/
integrate(): void;
/**
* Render this circle for debugging purposes.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context to render to.
* @param xOffset X offset from circle's position to render at.
* @param yOffset Y offset from circle's position to render at.
* @param color color of the debug shape to be rendered. (format is css color string).
* @param filled Render the shape as solid (true) or hollow (false).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
render(context: any, xOffset: number, yOffset: number, color: string, filled: boolean): void;
/**
* Process a world collision and apply the resulting forces.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param px The tangent velocity
* @param py The tangent velocity
* @param dx Collision normal
* @param dy Collision normal
* @param obj Object this Circle collided with
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reportCollisionVsWorld(px: number, py: number, dx: number, dy: number, obj: any): void;
reportCollisionVsBody(px: number, py: number, dx: number, dy: number, obj: any): void;
/**
* Resolves tile collision.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x Penetration depth on the x axis.
* @param y Penetration depth on the y axis.
* @param oH Grid / voronoi region.
* @param oV Grid / voronoi region.
* @param obj The Circle involved in the collision.
* @param t The Tile involved in the collision.
* @return The result of the collision.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
resolveCircleTile(x: number, y: number, oH: number, oV: number, obj: Phaser.Physics.Ninja.Circle, t: Phaser.Physics.Ninja.Tile): boolean;
}
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
enum TileType {
TYPE_EMPTY,
TYPE_FULL,
TYPE_45DEG,
TYPE_CONCAVE,
TYPE_CONVEX,
TYPE_22DEGs,
TYPE_22DEGb,
TYPE_67DEGs,
TYPE_67DEGb,
TYPE_HALF
}
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Ninja Physics Tile constructor.
* A Tile is defined by its width, height and type. It's type can include slope data, such as 45 degree slopes, or convex slopes.
* Understand that for any type including a slope (types 2 to 29) the Tile must be SQUARE, i.e. have an equal width and height.
* Also note that as Tiles are primarily used for levels they have gravity disabled and world bounds collision disabled by default.
*
* Note: This class could be massively optimised and reduced in size. I leave that challenge up to you.
*/
class Tile {
/**
* Ninja Physics Tile constructor.
* A Tile is defined by its width, height and type. It's type can include slope data, such as 45 degree slopes, or convex slopes.
* Understand that for any type including a slope (types 2 to 29) the Tile must be SQUARE, i.e. have an equal width and height.
* Also note that as Tiles are primarily used for levels they have gravity disabled and world bounds collision disabled by default.
*
* Note: This class could be massively optimised and reduced in size. I leave that challenge up to you.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body The body that owns this shape.
* @param x The x coordinate to create this shape at.
* @param y The y coordinate to create this shape at.
* @param width The width of this AABB.
* @param height The height of this AABB.
* @param type The type of Ninja shape to create. 1 = AABB, 2 = Circle or 3 = Tile. - Default: 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(body: Phaser.Physics.Ninja.Body, x: number, y: number, width: number, height: number, type?: number);
/**
* A reference to the body that owns this shape.
*/
body: Phaser.Physics.Ninja.Body;
/**
* The bottom value of this Body (same as Body.y + Body.height)
*/
bottom: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
flipped: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The height.
*/
height: number;
/**
* The ID of this Tile.
*/
id: number;
/**
* The position of this object in the previous update.
*/
oldpos: Phaser.Point;
/**
* The position of this object.
*/
pos: Phaser.Point;
/**
* The right value of this Body (same as Body.x + Body.width)
*/
right: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
rotation: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A reference to the physics system.
*/
system: Phaser.Physics.Ninja;
/**
* The type of this Tile.
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
type: Phaser.Physics.Ninja.TileType;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The velocity of this object.
*/
velocity: Phaser.Point;
/**
* The width.
*/
width: number;
/**
* Half the width.
*/
xw: number;
/**
* Half the height.
*/
yw: number;
/**
* The x position.
*/
x: number;
/**
* The y position.
*/
y: number;
/**
* Sets this tile to be empty.
*/
clear(): void;
/**
* Tiles cannot collide with the world bounds, it's up to you to keep them where you want them. But we need this API stub to satisfy the Body.
*/
collideWorldBounds(): void;
/**
* Destroys this Tiles reference to Body and System.
*/
destroy(): void;
/**
* Updates this objects position.
*/
integrate(): void;
/**
* Process a world collision and apply the resulting forces.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param px The tangent velocity
* @param py The tangent velocity
* @param dx Collision normal
* @param dy Collision normal
* @param obj Object this Tile collided with
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reportCollisionVsWorld(px: number, py: number, dx: number, dy: number, obj: any): void;
/**
* Tiles cannot collide with the world bounds, it's up to you to keep them where you want them. But we need this API stub to satisfy the Body.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param id The type of Tile this will use, i.e. Phaser.Physics.Ninja.Tile.SLOPE_45DEGpn, Phaser.Physics.Ninja.Tile.CONVEXpp, etc.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setType(id: number): number;
}
}
/**
* This is your main access to the P2 Physics World.
* From here you can create materials, listen for events and add bodies into the physics simulation.
*/
class P2 {
/**
* This is your main access to the P2 Physics World.
* From here you can create materials, listen for events and add bodies into the physics simulation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Reference to the current game instance.
* @param config Physics configuration object passed in from the game constructor.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, config?: any);
/**
* Enable to automatically apply body damping each step.
*/
applyDamping: boolean;
/**
* Enable to automatically apply gravity each step.
*/
applyGravity: boolean;
/**
* Enable to automatically apply spring forces each step.
*/
applySpringForces: boolean;
/**
* An array of the bodies the world bounds collides with.
*/
boundsCollidesWith: Phaser.Physics.P2.Body[];
/**
* A default collision group.
*/
boundsCollisionGroup: Phaser.Physics.P2.CollisionGroup;
/**
* The p2 World configuration object.
*/
config: any;
/**
* The context under which the callbacks are fired.
*/
callbackContext: any;
/**
* An array containing the collision groups that have been defined in the World.
*/
collisionGroups: Phaser.Physics.P2.CollisionGroup[];
/**
* The default Contact Material being used by the World.
*/
contactMaterial: Phaser.Physics.P2.ContactMaterial;
/**
* Set to true if you want to the world to emit the "impact" event. Turning this off could improve performance.
*/
emitImpactEvent: boolean;
/**
* A default collision group.
*/
everythingCollisionGroup: Phaser.Physics.P2.CollisionGroup;
/**
* The frame rate the world will be stepped at. Defaults to 1 / 60, but you can change here. Also see useElapsedTime property.
*/
frameRate: number;
/**
* Friction between colliding bodies. This value is used if no matching ContactMaterial is found for a Material pair.
*/
friction: number;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* The gravity applied to all bodies each step.
*/
gravity: Phaser.Physics.P2.InversePointProxy;
/**
* A local array of all created Materials.
*/
materials: Phaser.Physics.P2.Material[];
/**
* A default collision group.
*/
nothingCollisionGroup: Phaser.Physics.P2.CollisionGroup;
/**
* Dispatched when a new Body is added to the World.
*/
onBodyAdded: Phaser.Signal;
/**
* Dispatched when a Body is removed from the World.
*/
onBodyRemoved: Phaser.Signal;
/**
* Dispatched when a first contact is created between two bodies. This event is fired before the step has been done.
*/
onBeginContact: Phaser.Signal;
/**
* Dispatched when a new Constraint is added to the World.
*/
onConstraintAdded: Phaser.Signal;
/**
* Dispatched when a Constraint is removed from the World.
*/
onConstraintRemoved: Phaser.Signal;
/**
* Dispatched when a new ContactMaterial is added to the World.
*/
onContactMaterialAdded: Phaser.Signal;
/**
* Dispatched when a ContactMaterial is removed from the World.
*/
onContactMaterialRemoved: Phaser.Signal;
/**
* Dispatched when final contact occurs between two bodies. This event is fired before the step has been done.
*/
onEndContact: Phaser.Signal;
/**
* Dispatched when a new Spring is added to the World.
*/
onSpringAdded: Phaser.Signal;
/**
* Dispatched when a Spring is removed from the World.
*/
onSpringRemoved: Phaser.Signal;
/**
* The paused state of the P2 World.
* Default: false
*/
paused: boolean;
postBroaddphaseCallback: Function;
/**
* Default coefficient of restitution between colliding bodies. This value is used if no matching ContactMaterial is found for a Material pair.
*/
restitution: number;
/**
* Enable/disable constraint solving in each step.
*/
solveConstraints: boolean;
/**
* The World time.
*/
time: any;
/**
* The total number of bodies in the world.
*/
total: number;
/**
* If true the frameRate value will be ignored and instead p2 will step with the value of Game.Time.physicsElapsed, which is a delta time value.
* Default: false
*/
useElapsedTime: boolean;
/**
* An object containing the 4 wall bodies that bound the physics world.
*/
walls: {
left?: Phaser.Physics.P2.Body;
right?: Phaser.Physics.P2.Body;
top?: Phaser.Physics.P2.Body;
bottom?: Phaser.Physics.P2.Body;
};
/**
* The p2 World in which the simulation is run.
*/
world: p2.World;
/**
* Add a body to the world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body The Body to add to the World.
* @return True if the Body was added successfully, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addBody(body: Phaser.Physics.P2.Body): boolean;
/**
* Adds a Contact Material to the world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param material The Contact Material to be added to the World.
* @return The Contact Material that was added.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addContactMaterial(material: Phaser.Physics.P2.ContactMaterial): Phaser.Physics.P2.ContactMaterial;
/**
* Adds a Constraint to the world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param constraint The Constraint to add to the World.
* @return The Constraint that was added.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addConstraint<T>(constraint: T): T;
/**
* Adds a Spring to the world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param spring The Spring to add to the World.
* @return The Spring that was added.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addSpring(spring: Phaser.Physics.P2.Spring): Phaser.Physics.P2.Spring;
/**
* Handles a p2 begin contact event.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The event data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
beginContactHandler(event: any): void;
/**
* Clears all bodies from the simulation, resets callbacks and resets the collision bitmask.
*
* The P2 world is also cleared:
*
* * Removes all solver equations
* * Removes all constraints
* * Removes all bodies
* * Removes all springs
* * Removes all contact materials
*
* This is called automatically when you switch state.
*/
clear(): void;
/**
* Clears all physics bodies from the given TilemapLayer that were created with `World.convertTilemap`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param map The Tilemap to get the map data from.
* @param layer The layer to operate on. If not given will default to map.currentLayer.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clearTilemapLayerBodies(map: Phaser.Tilemap, layer?: any): void;
/**
* Converts all of the polylines objects inside a Tiled ObjectGroup into physics bodies that are added to the world.
* Note that the polylines must be created in such a way that they can withstand polygon decomposition.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param map The Tilemap to get the map data from.
* @param layer The layer to operate on. If not given will default to map.currentLayer.
* @param addToWorld If true it will automatically add each body to the world. - Default: true
* @return An array of the Phaser.Physics.Body objects that have been created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
convertCollisionObjects(map: Phaser.Tilemap, layer?: any, addToWorld?: boolean): Phaser.Physics.P2.Body[];
/**
* Goes through all tiles in the given Tilemap and TilemapLayer and converts those set to collide into physics bodies.
* Only call this *after* you have specified all of the tiles you wish to collide with calls like Tilemap.setCollisionBetween, etc.
* Every time you call this method it will destroy any previously created bodies and remove them from the world.
* Therefore understand it's a very expensive operation and not to be done in a core game update loop.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param map The Tilemap to get the map data from.
* @param layer The layer to operate on. If not given will default to map.currentLayer.
* @param addToWorld If true it will automatically add each body to the world, otherwise it's up to you to do so. - Default: true
* @param optimize If true adjacent colliding tiles will be combined into a single body to save processing. However it means you cannot perform specific Tile to Body collision responses. - Default: true
* @return An array of the Phaser.Physics.P2.Body objects that were created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
convertTilemap(map: Phaser.Tilemap, layer?: any, addToWorld?: Boolean, optimize?: boolean): Phaser.Physics.P2.Body[];
/**
* Creates a new Body and adds it to the World.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of Body.
* @param y The y coordinate of Body.
* @param mass The mass of the Body. A mass of 0 means a 'static' Body is created.
* @param addToWorld Automatically add this Body to the world? (usually false as it won't have any shapes on construction). - Default: false
* @param options An object containing the build options:
* @param options.optimalDecomp Set to true if you need optimal decomposition. Warning: very slow for polygons with more than 10 vertices. - Default: false
* @param options.skipSimpleCheck Set to true if you already know that the path is not intersecting itself. - Default: false
* @param options.removeCollinearPoints Set to a number (angle threshold value) to remove collinear points, or false to keep all points. - Default: false
* @param points An array of 2d vectors that form the convex or concave polygon.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Either [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],
* or the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The body
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createBody(x: number, y: number, mass: number, addToWorld?: boolean, options?: p2.BodyOptions, data?: number[][]): Phaser.Physics.P2.Body;
/**
* Creates a new Body and adds it to the World.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of Body.
* @param y The y coordinate of Body.
* @param mass The mass of the Body. A mass of 0 means a 'static' Body is created.
* @param addToWorld Automatically add this Body to the world? (usually false as it won't have any shapes on construction). - Default: false
* @param options An object containing the build options:
* @param options.optimalDecomp Set to true if you need optimal decomposition. Warning: very slow for polygons with more than 10 vertices. - Default: false
* @param options.skipSimpleCheck Set to true if you already know that the path is not intersecting itself. - Default: false
* @param options.removeCollinearPoints Set to a number (angle threshold value) to remove collinear points, or false to keep all points. - Default: false
* @param points An array of 2d vectors that form the convex or concave polygon.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Either [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],
* or the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The body
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createBody(x: number, y: number, mass: number, addToWorld?: boolean, options?: p2.BodyOptions, data?: number[]): Phaser.Physics.P2.Body;
/**
* Creates a new Collision Group and optionally applies it to the given object.
* Collision Groups are handled using bitmasks, therefore you have a fixed limit you can create before you need to re-use older groups.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object An optional Sprite or Group to apply the Collision Group to. If a Group is given it will be applied to all top-level children.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createCollisionGroup(group?: Phaser.Group): Phaser.Physics.P2.CollisionGroup;
/**
* Creates a new Collision Group and optionally applies it to the given object.
* Collision Groups are handled using bitmasks, therefore you have a fixed limit you can create before you need to re-use older groups.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object An optional Sprite or Group to apply the Collision Group to. If a Group is given it will be applied to all top-level children.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createCollisionGroup(group?: Phaser.Sprite): Phaser.Physics.P2.CollisionGroup;
/**
* Creates a Contact Material from the two given Materials. You can then edit the properties of the Contact Material directly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param materialA The first Material to create the ContactMaterial from. If undefined it will create a new Material object first.
* @param materialB The second Material to create the ContactMaterial from. If undefined it will create a new Material object first.
* @param options Material options object.
* @return The Contact Material that was created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createContactMaterial(materialA: Phaser.Physics.P2.Material, materialB: Phaser.Physics.P2.Material, options?: p2.ContactMaterialOptions): Phaser.Physics.P2.ContactMaterial;
/**
* Creates a constraint that tries to keep the distance between two bodies constant.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param distance The distance to keep between the bodies.
* @param localAnchorA The anchor point for bodyA, defined locally in bodyA frame. Defaults to [0,0].
* @param localAnchorB The anchor point for bodyB, defined locally in bodyB frame. Defaults to [0,0].
* @param maxForce The maximum force that should be applied to constrain the bodies.
* @return The constraint
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createDistanceConstraint(bodyA: any, bodyB: any, distance: number, localAnchorA?: number[], localAnchorB?: number[], maxForce?: number): Phaser.Physics.P2.DistanceConstraint;
/**
* Creates a constraint that tries to keep the distance between two bodies constant.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param angle The relative angle - Default: 0
* @param ratio The gear ratio. - Default: 1
* @return The constraint
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createGearConstraint(bodyA: any, bodyB: any, angle?: number, ratio?: number): Phaser.Physics.P2.GearConstraint;
/**
* Locks the relative position between two bodies.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param offset The offset of bodyB in bodyA's frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param angle The angle of bodyB in bodyA's frame. - Default: 0
* @param maxForce The maximum force that should be applied to constrain the bodies.
* @return The constraint
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createLockConstraint(bodyA: any, bodyB: any, offset?: number[], angle?: number, maxForce?: number): Phaser.Physics.P2.LockConstraint;
/**
* Creates a Material. Materials are applied to Shapes owned by a Body and can be set with Body.setMaterial().
* Materials are a way to control what happens when Shapes collide. Combine unique Materials together to create Contact Materials.
* Contact Materials have properties such as friction and restitution that allow for fine-grained collision control between different Materials.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name Optional name of the Material. Each Material has a unique ID but string names are handy for debugging.
* @param body Optional Body. If given it will assign the newly created Material to the Body shapes.
* @return The Material that was created. This is also stored in Phaser.Physics.P2.materials.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createMaterial(name?: string, body?: Phaser.Physics.P2.Body): Phaser.Physics.P2.Material;
/**
* Creates a new Particle and adds it to the World.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of Body.
* @param y The y coordinate of Body.
* @param mass The mass of the Body. A mass of 0 means a 'static' Body is created.
* @param addToWorld Automatically add this Body to the world? (usually false as it won't have any shapes on construction). - Default: false
* @param options An object containing the build options:
* @param options.optimalDecomp Set to true if you need optimal decomposition. Warning: very slow for polygons with more than 10 vertices. - Default: false
* @param options.skipSimpleCheck Set to true if you already know that the path is not intersecting itself. - Default: false
* @param options.removeCollinearPoints Set to a number (angle threshold value) to remove collinear points, or false to keep all points. - Default: false
* @param points An array of 2d vectors that form the convex or concave polygon.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Either [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],
* or the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createParticle(x: number, y: number, mass: number, addToWorld?: boolean, options?: p2.BodyOptions, data?: number[][]): Phaser.Physics.P2.Body;
/**
* Creates a new Particle and adds it to the World.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of Body.
* @param y The y coordinate of Body.
* @param mass The mass of the Body. A mass of 0 means a 'static' Body is created.
* @param addToWorld Automatically add this Body to the world? (usually false as it won't have any shapes on construction). - Default: false
* @param options An object containing the build options:
* @param options.optimalDecomp Set to true if you need optimal decomposition. Warning: very slow for polygons with more than 10 vertices. - Default: false
* @param options.skipSimpleCheck Set to true if you already know that the path is not intersecting itself. - Default: false
* @param options.removeCollinearPoints Set to a number (angle threshold value) to remove collinear points, or false to keep all points. - Default: false
* @param points An array of 2d vectors that form the convex or concave polygon.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Either [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],
* or the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createParticle(x: number, y: number, mass: number, addToWorld?: boolean, options?: p2.BodyOptions, data?: number[]): Phaser.Physics.P2.Body;
/**
* Constraint that only allows bodies to move along a line, relative to each other.
* See http://www.iforce2d.net/b2dtut/joints-prismatic
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param lockRotation If set to false, bodyB will be free to rotate around its anchor point. - Default: true
* @param anchorA Body A's anchor point, defined in its own local frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param anchorB Body A's anchor point, defined in its own local frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param axis An axis, defined in body A frame, that body B's anchor point may slide along. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param maxForce The maximum force that should be applied to constrain the bodies.
* @return The constraint
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createPrismaticConstraint(body: any, bodyB: any, lockRotation?: boolean, anchorA?: number[], anchorB?: number[], axis?: Float32Array, maxForce?: number): Phaser.Physics.P2.PrismaticConstraint;
/**
* Connects two bodies at given offset points, letting them rotate relative to each other around this point.
* The pivot points are given in world (pixel) coordinates.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bodyA First connected body.
* @param pivotA The point relative to the center of mass of bodyA which bodyA is constrained to. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param bodyB Second connected body.
* @param pivotB The point relative to the center of mass of bodyB which bodyB is constrained to. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param maxForce The maximum force that should be applied to constrain the bodies. - Default: 0
* @param worldPivot A pivot point given in world coordinates. If specified, localPivotA and localPivotB are automatically computed from this value. - Default: null
* @return The constraint
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
createRevoluteConstraint(bodyA: any, pivotA: number[], bodyB: any, pivotB: number[], maxForce?: number, worldPivot?: number[]): Phaser.Physics.P2.RevoluteConstraint;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Creates a rotational spring, connecting two bodies. A spring can have a resting length, a stiffness and damping.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param restAngle The relative angle of bodies at which the spring is at rest. If not given, it's set to the current relative angle between the bodies.
* @param stiffness Stiffness of the spring. A number >= 0. - Default: 100
* @param damping Damping of the spring. A number >= 0. - Default: 1
* @return The spring
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createRotationalSpring(bodyA: any, bodyB: any, restAngle?: number, stiffness?: number, damping?: number): p2.RotationalSpring;
/**
* Creates a linear spring, connecting two bodies. A spring can have a resting length, a stiffness and damping.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param restLength Rest length of the spring. A number > 0. - Default: 1
* @param stiffness Stiffness of the spring. A number >= 0. - Default: 100
* @param damping Damping of the spring. A number >= 0. - Default: 1
* @param worldA Where to hook the spring to body A in world coordinates. This value is an array by 2 elements, x and y, i.e: [32, 32].
* @param worldB Where to hook the spring to body B in world coordinates. This value is an array by 2 elements, x and y, i.e: [32, 32].
* @param localA Where to hook the spring to body A in local body coordinates. This value is an array by 2 elements, x and y, i.e: [32, 32].
* @param localB Where to hook the spring to body B in local body coordinates. This value is an array by 2 elements, x and y, i.e: [32, 32].
* @return The spring
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createSpring(bodyA: any, bodyB: any, restLength?: number, stiffness?: number, damping?: number, worldA?: number[], worldB?: number[], localA?: number[], localB?: number[]): Phaser.Physics.P2.Spring;
/**
* Clears all bodies from the simulation and unlinks World from Game. Should only be called on game shutdown. Call `clear` on a State change.
*/
destroy(): void;
/**
* This will create a P2 Physics body on the given game object or array of game objects.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the object is destroyed.
* Note: When the game object is enabled for P2 physics it has its anchor x/y set to 0.5 so it becomes centered.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. Can also be an array or Group of objects, a body will be created on every child that has a `body` property.
* @param debug Create a debug object to go with this body? - Default: false
* @param children Should a body be created on all children of this object? If true it will recurse down the display list as far as it can go. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enable(object: any, debug?: boolean, children?: boolean): void;
/**
* Creates a P2 Physics body on the given game object.
* A game object can only have 1 physics body active at any one time, and it can't be changed until the body is nulled.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The game object to create the physics body on. A body will only be created if this object has a null `body` property.
* @param debug Create a debug object to go with this body?
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
enableBody(object: any, debug: boolean): void;
/**
* Handles a p2 end contact event.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The event data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
endContactHandler(event: any): void;
/**
* Populates and returns an array with references to of all current Bodies in the world.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return An array containing all current Bodies in the world.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getBodies(): Phaser.Physics.P2.Body[];
/**
* Checks the given object to see if it has a p2.Body and if so returns it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The object to check for a p2.Body on.
* @return The p2.Body, or null if not found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getBody(object: any): Phaser.Physics.P2.Body;
/**
* Populates and returns an array of all current Constraints in the world.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return An array containing all current Constraints in the world.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getConstraints(): p2.Constraint[];
/**
* Populates and returns an array of all current Springs in the world.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return An array containing all current Springs in the world.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getSprings(): Phaser.Physics.P2.Spring[];
/**
* Gets a Contact Material based on the two given Materials.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param materialA The first Material to search for.
* @param materialB The second Material to search for.
* @return The Contact Material or false if none was found matching the Materials given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getContactMaterial(materialA: Phaser.Physics.P2.Material, materialB: Phaser.Physics.P2.Material): Phaser.Physics.P2.ContactMaterial;
/**
* Test if a world point overlaps bodies. You will get an array of actual P2 bodies back. You can find out which Sprite a Body belongs to
* (if any) by checking the Body.parent.sprite property. Body.parent is a Phaser.Physics.P2.Body property.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param worldPoint Point to use for intersection tests. The points values must be in world (pixel) coordinates.
* @param bodies A list of objects to check for intersection. If not given it will check Phaser.Physics.P2.world.bodies (i.e. all world bodies)
* @param precision Used for matching against particles and lines. Adds some margin to these infinitesimal objects. - Default: 5
* @param filterStatic If true all Static objects will be removed from the results array. - Default: false
* @return Array of bodies that overlap the point.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
hitTest(worldPoint: Phaser.Point, bodies?: any[], precision?: number, filterStatic?: boolean): Phaser.Physics.P2.Body[];
/**
* Convert p2 physics value (meters) to pixel scale.
* By default Phaser uses a scale of 20px per meter.
* If you need to modify this you can over-ride these functions via the Physics Configuration object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param v The value to convert.
* @return The scaled value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
mpx(v: number): number;
/**
* Convert p2 physics value (meters) to pixel scale and inverses it.
* By default Phaser uses a scale of 20px per meter.
* If you need to modify this you can over-ride these functions via the Physics Configuration object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param v The value to convert.
* @return The scaled value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
mpxi(v: number): number;
/**
* Pauses the P2 World independent of the game pause state.
*/
pause(): void;
/**
* Called at the start of the core update loop. Purges flagged bodies from the world.
*/
preUpdate(): void;
/**
* Convert pixel value to p2 physics scale (meters).
* By default Phaser uses a scale of 20px per meter.
* If you need to modify this you can over-ride these functions via the Physics Configuration object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param v The value to convert.
* @return The scaled value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pxm(v: number): number;
/**
* Convert pixel value to p2 physics scale (meters) and inverses it.
* By default Phaser uses a scale of 20px per meter.
* If you need to modify this you can over-ride these functions via the Physics Configuration object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param v The value to convert.
* @return The scaled value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pxmi(v: number): number;
/**
* Removes a body from the world. This will silently fail if the body wasn't part of the world to begin with.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body The Body to remove from the World.
* @return The Body that was removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeBody(body: Phaser.Physics.P2.Body): Phaser.Physics.P2.Body;
/**
* This will add a P2 Physics body into the removal list for the next step.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body The body to remove at the start of the next step.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeBodyNextStep(body: Phaser.Physics.P2.Body): void;
/**
* Removes a Constraint from the world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param constraint The Constraint to be removed from the World.
* @return The Constraint that was removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeConstraint<T>(constraint: T): T;
/**
* Removes a Contact Material from the world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param material The Contact Material to be removed from the World.
* @return The Contact Material that was removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeContactMaterial(material: Phaser.Physics.P2.ContactMaterial): Phaser.Physics.P2.ContactMaterial;
/**
* Removes a Spring from the world.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param spring The Spring to remove from the World.
* @return The Spring that was removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeSpring(spring: Phaser.Physics.P2.Spring): Phaser.Physics.P2.Spring;
/**
* Called by Phaser.Physics when a State swap occurs.
* Starts the begin and end Contact listeners again.
*/
reset(): void;
/**
* Resumes a paused P2 World.
*/
resume(): void;
/**
* Sets the bounds of the Physics world to match the given world pixel dimensions.
* You can optionally set which 'walls' to create: left, right, top or bottom.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If none of the walls are given it will default to use the walls settings it had previously.
* I.e. if you previously told it to not have the left or right walls, and you then adjust the world size
* the newly created bounds will also not have the left and right walls.
* Explicitly state them in the parameters to override this.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the top-left corner of the bounds.
* @param y The y coordinate of the top-left corner of the bounds.
* @param width The width of the bounds.
* @param height The height of the bounds.
* @param left If true will create the left bounds wall. - Default: true
* @param right If true will create the right bounds wall. - Default: true
* @param top If true will create the top bounds wall. - Default: true
* @param bottom If true will create the bottom bounds wall. - Default: true
* @param setCollisionGroup If true the Bounds will be set to use its own Collision Group. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setBounds(x: number, y: number, width: number, height: number, left?: Boolean, right?: boolean, top?: boolean, bottom?: boolean, setCollisionGroup?: boolean): void;
setBoundsToWorld(left?: boolean, right?: boolean, top?: boolean, bottom?: boolean, setCollisionGroup?: boolean): void;
setCollisionGroup(object: any, group: Phaser.Physics.P2.CollisionGroup): void;
/**
* Impact event handling is disabled by default. Enable it before any impact events will be dispatched.
* In a busy world hundreds of impact events can be generated every step, so only enable this if you cannot do what you need via beginContact or collision masks.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param state Set to true to enable impact events, or false to disable.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setImpactEvents(state: boolean): void;
/**
* Sets the given Material against all Shapes owned by all the Bodies in the given array.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param material The Material to be applied to the given Bodies.
* @param bodies An Array of Body objects that the given Material will be set on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setMaterial(material: Phaser.Physics.P2.Material, bodies?: Phaser.Physics.P2.Body[]): void;
/**
* Sets a callback to be fired after the Broadphase has collected collision pairs in the world.
* Just because a pair exists it doesn't mean they *will* collide, just that they potentially could do.
* If your calback returns `false` the pair will be removed from the narrowphase. This will stop them testing for collision this step.
* Returning `true` from the callback will ensure they are checked in the narrowphase.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The callback that will receive the postBroadphase event data. It must return a boolean. Set to null to disable an existing callback.
* @param context The context under which the callback will be fired.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setPostBroadphaseCallback(callback: Function, context: any): void;
setWorldMaterial(material: Phaser.Physics.P2.Material, left?: boolean, right?: boolean, top?: boolean, bottom?: boolean): void;
/**
* Converts the current world into a JSON object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A JSON representation of the world.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
toJSON(): any;
/**
* Internal P2 update loop.
*/
update(): void;
/**
* By default the World will be set to collide everything with everything. The bounds of the world is a Body with 4 shapes, one for each face.
* If you start to use your own collision groups then your objects will no longer collide with the bounds.
* To fix this you need to adjust the bounds to use its own collision group first BEFORE changing your Sprites collision group.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param setCollisionGroup If true the Bounds will be set to use its own Collision Group. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateBoundsCollisionGroup(setCollisionGroup?: boolean): void;
}
module P2 {
/**
* The Physics Body is typically linked to a single Sprite and defines properties that determine how the physics body is simulated.
* These properties affect how the body reacts to forces, what forces it generates on itself (to simulate friction), and how it reacts to collisions in the scene.
* In most cases, the properties are used to simulate physical effects. Each body also has its own property values that determine exactly how it reacts to forces and collisions in the scene.
* By default a single Rectangle shape is added to the Body that matches the dimensions of the parent Sprite. See addShape, removeShape, clearShapes to add extra shapes around the Body.
* Note: When bound to a Sprite to avoid single-pixel jitters on mobile devices we strongly recommend using Sprite sizes that are even on both axis, i.e. 128x128 not 127x127.
* Note: When a game object is given a P2 body it has its anchor x/y set to 0.5, so it becomes centered.
*/
class Body {
/**
* Dynamic body. Dynamic bodies body can move and respond to collisions and forces.
*/
static DYNAMIC: number;
/**
* Static body. Static bodies do not move, and they do not respond to forces or collision.
*/
static STATIC: number;
/**
* Kinematic body. Kinematic bodies only moves according to its .velocity, and does not respond to collisions or force.
*/
static KINEMATIC: number;
/**
* The Physics Body is typically linked to a single Sprite and defines properties that determine how the physics body is simulated.
* These properties affect how the body reacts to forces, what forces it generates on itself (to simulate friction), and how it reacts to collisions in the scene.
* In most cases, the properties are used to simulate physical effects. Each body also has its own property values that determine exactly how it reacts to forces and collisions in the scene.
* By default a single Rectangle shape is added to the Body that matches the dimensions of the parent Sprite. See addShape, removeShape, clearShapes to add extra shapes around the Body.
* Note: When bound to a Sprite to avoid single-pixel jitters on mobile devices we strongly recommend using Sprite sizes that are even on both axis, i.e. 128x128 not 127x127.
* Note: When a game object is given a P2 body it has its anchor x/y set to 0.5, so it becomes centered.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Game reference to the currently running game.
* @param sprite The Sprite object this physics body belongs to.
* @param x The x coordinate of this Body. - Default: 0
* @param y The y coordinate of this Body. - Default: 0
* @param mass The default mass of this Body (0 = static). - Default: 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, sprite?: Phaser.Sprite, x?: number, y?: number, mass?: number);
/**
* -
*/
allowSleep: boolean;
/**
* The angle of the Body in degrees from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
* Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement Body.angle = 450 is the same as Body.angle = 90.
* If you wish to work in radians instead of degrees use the property Body.rotation instead. Working in radians is faster as it doesn't have to convert values. The angle of this Body in degrees.
*/
angle: number;
/**
* Damping is specified as a value between 0 and 1, which is the proportion of velocity lost per second. The angular damping acting acting on the body.
*/
angularDamping: number;
/**
* The angular force acting on the body.
*/
angularForce: number;
/**
* The angular velocity of the body.
*/
angularVelocity: number;
/**
* Array of CollisionGroups that this Bodies shapes collide with.
*/
collidesWith: Phaser.Physics.P2.CollisionGroup[];
/**
* A Body can be set to collide against the World bounds automatically if this is set to true. Otherwise it will leave the World.
* Note that this only applies if your World has bounds! The response to the collision should be managed via CollisionMaterials.
* Also note that when you set this it will only effect Body shapes that already exist. If you then add further shapes to your Body
* after setting this it will *not* proactively set them to collide with the bounds. Should the Body collide with the World bounds?
*/
collideWorldBounds: boolean;
/**
* Damping is specified as a value between 0 and 1, which is the proportion of velocity lost per second. The linear damping acting on the body in the velocity direction.
*/
damping: number;
/**
* The p2 Body data.
*/
data: p2.Body;
/**
* Enable or disable debug drawing of this body
*/
debug: boolean;
/**
* Reference to the debug body.
*/
debugBody: Phaser.Physics.P2.BodyDebug;
/**
* Returns true if the Body is dynamic. Setting Body.dynamic to 'false' will make it static.
*/
dynamic: boolean;
/**
* -
*/
fixedRotation: boolean;
/**
* The force applied to the body.
*/
force: Phaser.Physics.P2.InversePointProxy;
/**
* Returns true if the Body is kinematic. Setting Body.kinematic to 'false' will make it static.
*/
kinematic: boolean;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* A locally applied gravity force to the Body. Applied directly before the world step. NOTE: Not currently implemented.
*/
gravity: Phaser.Point;
/**
* The Body ID. Each Body that has been added to the World has a unique ID.
*/
id: number;
/**
* The inertia of the body around the Z axis..
*/
inertia: number;
/**
* -
*/
mass: number;
/**
* The type of motion this body has. Should be one of: Body.STATIC (the body does not move), Body.DYNAMIC (body can move and respond to collisions) and Body.KINEMATIC (only moves according to its .velocity).
*/
motionState: number;
/**
* The offset of the Physics Body from the Sprite x/y position.
*/
offset: Phaser.Point;
/**
* Dispatched when a first contact is created between shapes in two bodies. This event is fired during the step, so collision has already taken place.
* The event will be sent 4 parameters: The body it is in contact with, the shape from this body that caused the contact, the shape from the contact body and the contact equation data array.
*/
onBeginContact: Phaser.Signal;
/**
* Dispatched when contact ends between shapes in two bodies. This event is fired during the step, so collision has already taken place.
* The event will be sent 3 parameters: The body it is in contact with, the shape from this body that caused the contact and the shape from the contact body.
*/
onEndContact: Phaser.Signal;
/**
* The angle of the Body in radians.
* If you wish to work in degrees instead of radians use the Body.angle property instead. Working in radians is faster as it doesn't have to convert values. The angle of this Body in radians.
*/
rotation: number;
/**
* To avoid deleting this body during a physics step, and causing all kinds of problems, set removeNextStep to true to have it removed in the next preUpdate.
*/
removeNextStep: boolean;
/**
* Reference to the parent Sprite.
*/
sprite: Phaser.Sprite;
/**
* .
*/
sleepSpeedLimit: number;
/**
* Returns true if the Body is static. Setting Body.static to 'false' will make it dynamic.
*/
static: boolean;
/**
* The type of physics system this body belongs to.
*/
type: number;
/**
* The velocity of the body. Set velocity.x to a negative value to move to the left, position to the right. velocity.y negative values move up, positive move down.
*/
velocity: Phaser.Physics.P2.InversePointProxy;
/**
* Local reference to the P2 World.
*/
world: Phaser.Physics.P2;
/**
* The x coordinate of this Body.
*/
x: number;
/**
* The y coordinate of this Body.
*/
y: number;
/**
* Adds this physics body to the world.
*/
addToWorld(): void;
/**
* Adds a Capsule shape to this Body.
* You can control the offset from the center of the body and the rotation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param length The distance between the end points in pixels.
* @param radius Radius of the capsule in pixels.
* @param offsetX Local horizontal offset of the shape relative to the body center of mass. - Default: 0
* @param offsetY Local vertical offset of the shape relative to the body center of mass. - Default: 0
* @param rotation Local rotation of the shape relative to the body center of mass, specified in radians. - Default: 0
* @return The Capsule shape that was added to the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addCapsule(length: number, radius: number, offsetX?: number, offsetY?: number, rotation?: number): p2.Capsule;
/**
* Adds a Circle shape to this Body. You can control the offset from the center of the body and the rotation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param radius The radius of this circle (in pixels)
* @param offsetX Local horizontal offset of the shape relative to the body center of mass. - Default: 0
* @param offsetY Local vertical offset of the shape relative to the body center of mass. - Default: 0
* @param rotation Local rotation of the shape relative to the body center of mass, specified in radians. - Default: 0
* @return The Circle shape that was added to the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addCircle(radius: number, offsetX?: number, offsetY?: number, rotation?: number): p2.Circle;
/**
* Add a polygon fixture. This is used during #loadPolygon.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param fixtureData The data for the fixture. It contains: isSensor, filter (collision) and the actual polygon shapes.
* @return An array containing the generated shapes for the given polygon.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addFixture(fixtureData: string): p2.Shape[];
/**
* Adds a Line shape to this Body.
* The line shape is along the x direction, and stretches from [-length/2, 0] to [length/2,0].
* You can control the offset from the center of the body and the rotation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param length The length of this line (in pixels)
* @param offsetX Local horizontal offset of the shape relative to the body center of mass. - Default: 0
* @param offsetY Local vertical offset of the shape relative to the body center of mass. - Default: 0
* @param rotation Local rotation of the shape relative to the body center of mass, specified in radians. - Default: 0
* @return The Line shape that was added to the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addLine(length: number, offsetX?: number, offsetY?: number, rotation?: number): p2.Line;
/**
* Adds a Particle shape to this Body. You can control the offset from the center of the body and the rotation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param offsetX Local horizontal offset of the shape relative to the body center of mass. - Default: 0
* @param offsetY Local vertical offset of the shape relative to the body center of mass. - Default: 0
* @param rotation Local rotation of the shape relative to the body center of mass, specified in radians. - Default: 0
* @return The Particle shape that was added to the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addParticle(offsetX?: number, offsetY?: number, rotation?: number): p2.Particle;
/**
* Reads a polygon shape path, and assembles convex shapes from that and puts them at proper offset points. The shape must be simple and without holes.
* This function expects the x.y values to be given in pixels. If you want to provide them at p2 world scales then call Body.data.fromPolygon directly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param options An object containing the build options:
* @param options.optimalDecomp Set to true if you need optimal decomposition. Warning: very slow for polygons with more than 10 vertices. - Default: false
* @param options.skipSimpleCheck Set to true if you already know that the path is not intersecting itself. - Default: false
* @param options.removeCollinearPoints Set to a number (angle threshold value) to remove collinear points, or false to keep all points. - Default: false
* @param points An array of 2d vectors that form the convex or concave polygon.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* Either [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],
* or the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True on success, else false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addPolygon(options: { optimalDecomp?: boolean; skipSimpleCheck?: boolean; removeCollinearPoints?: boolean; }, points: number[][]): boolean;
/**
* Reads the shape data from a physics data file stored in the Game.Cache and adds it as a polygon to this Body.
* The shape data format is based on the custom phaser export in.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The key of the Physics Data file as stored in Game.Cache.
* @param object The key of the object within the Physics data file that you wish to load the shape data from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addPhaserPolygon(key: string, object: string): Phaser.Physics.P2.FixtureList;
/**
* Adds a Plane shape to this Body. The plane is facing in the Y direction. You can control the offset from the center of the body and the rotation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param offsetX Local horizontal offset of the shape relative to the body center of mass. - Default: 0
* @param offsetY Local vertical offset of the shape relative to the body center of mass. - Default: 0
* @param rotation Local rotation of the shape relative to the body center of mass, specified in radians. - Default: 0
* @return The Plane shape that was added to the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addPlane(offsetX?: number, offsetY?: number, rotation?: number): p2.Plane;
/**
* Adds a Rectangle shape to this Body. You can control the offset from the center of the body and the rotation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of the rectangle in pixels.
* @param height The height of the rectangle in pixels.
* @param offsetX Local horizontal offset of the shape relative to the body center of mass. - Default: 0
* @param offsetY Local vertical offset of the shape relative to the body center of mass. - Default: 0
* @param rotation Local rotation of the shape relative to the body center of mass, specified in radians. - Default: 0
* @return The Rectangle shape that was added to the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addRectangle(width: number, height: number, offsetX?: number, offsetY?: number, rotation?: number): p2.Rectangle;
/**
* Add a shape to the body. You can pass a local transform when adding a shape, so that the shape gets an offset and an angle relative to the body center of mass.
* Will automatically update the mass properties and bounding radius.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If this Body had a previously set Collision Group you will need to re-apply it to the new Shape this creates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param shape The shape to add to the body.
* @param offsetX Local horizontal offset of the shape relative to the body center of mass. - Default: 0
* @param offsetY Local vertical offset of the shape relative to the body center of mass. - Default: 0
* @param rotation Local rotation of the shape relative to the body center of mass, specified in radians. - Default: 0
* @return The shape that was added to the body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addShape(shape: p2.Shape, offsetX?: number, offsetY?: number, rotation?: number): p2.Shape;
/**
* Moves the shape offsets so their center of mass becomes the body center of mass.
*/
adjustCenterOfMass(): void;
/**
* Apply damping, see http://code.google.com/p/bullet/issues/detail?id=74 for details.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dt Current time step.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
applyDamping(dt: number): void;
/**
* Apply force to a world point. This could for example be a point on the RigidBody surface. Applying force this way will add to Body.force and Body.angularForce.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param force The force vector to add.
* @param worldX The world x point to apply the force on.
* @param worldY The world y point to apply the force on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
applyForce(force: number[], worldX: number, worldY: number): void;
/**
* Clears the collision data from the shapes in this Body. Optionally clears Group and/or Mask.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param clearGroup Clear the collisionGroup value from the shape/s? - Default: true
* @param clearMask Clear the collisionMask value from the shape/s? - Default: true
* @param shape An optional Shape. If not provided the collision data will be cleared from all Shapes in this Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clearCollision(clearGroup?: boolean, cleanMask?: boolean, shape?: p2.Shape): void;
/**
* Removes all Shapes from this Body.
*/
clearShapes(): void;
/**
* Adds the given CollisionGroup, or array of CollisionGroups, to the list of groups that this body will collide with and updates the collision masks.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param group The Collision Group or Array of Collision Groups that this Bodies shapes will collide with.
* @param callback Optional callback that will be triggered when this Body impacts with the given Group.
* @param callbackContext The context under which the callback will be called.
* @param shape An optional Shape. If not provided the collision mask will be added to all Shapes in this Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
collides(group: any, callback?: Function, callbackContext?: any, shape?: p2.Shape): void;
/**
* Sets a callback to be fired any time a shape in this Body impacts with a shape in the given Body. The impact test is performed against body.id values.
* The callback will be sent 4 parameters: This body, the body that impacted, the Shape in this body and the shape in the impacting body.
* Note that the impact event happens after collision resolution, so it cannot be used to prevent a collision from happening.
* It also happens mid-step. So do not destroy a Body during this callback, instead set safeDestroy to true so it will be killed on the next preUpdate.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The object to send impact events for.
* @param callback The callback to fire on impact. Set to null to clear a previously set callback.
* @param callbackContext The context under which the callback will fire.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createBodyCallback(object: any, callback: Function, callbackContext: any): void;
/**
* Sets a callback to be fired any time this Body impacts with the given Group. The impact test is performed against shape.collisionGroup values.
* The callback will be sent 4 parameters: This body, the body that impacted, the Shape in this body and the shape in the impacting body.
* This callback will only fire if this Body has been assigned a collision group.
* Note that the impact event happens after collision resolution, so it cannot be used to prevent a collision from happening.
* It also happens mid-step. So do not destroy a Body during this callback, instead set safeDestroy to true so it will be killed on the next preUpdate.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param group The Group to send impact events for.
* @param callback The callback to fire on impact. Set to null to clear a previously set callback.
* @param callbackContext The context under which the callback will fire.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createGroupCallback(group: Phaser.Physics.P2.CollisionGroup, callback: Function, callbackContext: any): void;
/**
* Destroys this Body and all references it holds to other objects.
*/
destroy(): void;
/**
* Gets the collision bitmask from the groups this body collides with.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The bitmask.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getCollisionMask(): number;
/**
* Reads the shape data from a physics data file stored in the Game.Cache and adds it as a polygon to this Body.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The key of the Physics Data file as stored in Game.Cache.
* @param object The key of the object within the Physics data file that you wish to load the shape data from.
* @return True on success, else false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
loadPolygon(key: string, object: string): boolean;
/**
* Moves the Body backwards based on its current angle and the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should move backwards.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveBackward(speed: number): void;
/**
* If this Body is dynamic then this will move it down by setting its y velocity to the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should move down, in pixels per second.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveDown(speed: number): void;
/**
* Moves the Body forwards based on its current angle and the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should move forwards.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveForward(speed: number): void;
/**
* If this Body is dynamic then this will move it to the left by setting its x velocity to the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should move to the left, in pixels per second.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveLeft(speed: number): void;
/**
* If this Body is dynamic then this will move it to the right by setting its x velocity to the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should move to the right, in pixels per second.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveRight(speed: number): void;
/**
* If this Body is dynamic then this will move it up by setting its y velocity to the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should move up, in pixels per second.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
moveUp(speed: number): void;
/**
* Internal method. This is called directly before the sprites are sent to the renderer and after the update function has finished.
*/
preUpdate(): void;
/**
* Internal method. This is called directly before the sprites are sent to the renderer and after the update function has finished.
*/
postUpdate(): void;
/**
* Removes this physics body from the world.
*/
removeFromWorld(): void;
/**
* Remove a shape from the body. Will automatically update the mass properties and bounding radius.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param shape The shape to remove from the body.
* @return True if the shape was found and removed, else false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeShape(shape: p2.Shape): boolean;
/**
* Applies a force to the Body that causes it to 'thrust' backwards (in reverse), based on its current angle and the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should reverse.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reverse(speed: number): void;
/**
* This will rotate the Body by the given speed to the left (counter-clockwise).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should rotate.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
rotateLeft(speed: number): void;
/**
* This will rotate the Body by the given speed to the left (clockwise).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should rotate.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
rotateRight(speed: number): void;
/**
* Resets the Body force, velocity (linear and angular) and rotation. Optionally resets damping and mass.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The new x position of the Body.
* @param y The new x position of the Body.
* @param resetDamping Resets the linear and angular damping. - Default: false
* @param resetMass Sets the Body mass back to 1. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(x: number, y: number, resetDamping?: boolean, resetMass?: boolean): void;
/**
* Updates the debug draw if any body shapes change.
*/
shapeChanged(): void;
/**
* Clears any previously set shapes. Then creates a new Circle shape and adds it to this Body.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If this Body had a previously set Collision Group you will need to re-apply it to the new Shape this creates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param radius The radius of this circle (in pixels)
* @param offsetX Local horizontal offset of the shape relative to the body center of mass. - Default: 0
* @param offsetY Local vertical offset of the shape relative to the body center of mass. - Default: 0
* @param rotation Local rotation of the shape relative to the body center of mass, specified in radians. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setCircle(radius: number, offsetX?: number, offsetY?: number, rotation?: number): p2.Circle;
/**
* Sets the given CollisionGroup to be the collision group for all shapes in this Body, unless a shape is specified.
* This also resets the collisionMask.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param group The Collision Group that this Bodies shapes will use.
* @param shape An optional Shape. If not provided the collision group will be added to all Shapes in this Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setCollisionGroup(group: Phaser.Physics.P2.CollisionGroup, shape?: p2.Shape): void;
/**
* Clears any previously set shapes. The creates a new Rectangle shape at the given size and offset, and adds it to this Body.
* If you wish to create a Rectangle to match the size of a Sprite or Image see Body.setRectangleFromSprite.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If this Body had a previously set Collision Group you will need to re-apply it to the new Shape this creates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of the rectangle in pixels. - Default: 16
* @param height The height of the rectangle in pixels. - Default: 16
* @param offsetX Local horizontal offset of the shape relative to the body center of mass. - Default: 0
* @param offsetY Local vertical offset of the shape relative to the body center of mass. - Default: 0
* @param rotation Local rotation of the shape relative to the body center of mass, specified in radians. - Default: 0
* @return The Rectangle shape that was added to the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setRectangle(width?: number, height?: number, offsetX?: number, offsetY?: number, rotation?: number): p2.Rectangle;
/**
* Clears any previously set shapes.
* Then creates a Rectangle shape sized to match the dimensions and orientation of the Sprite given.
* If no Sprite is given it defaults to using the parent of this Body.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If this Body had a previously set Collision Group you will need to re-apply it to the new Shape this creates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The Sprite on which the Rectangle will get its dimensions.
* @return The Rectangle shape that was added to the Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setRectangleFromSprite(sprite: any): p2.Rectangle;
/**
* Adds the given Material to all Shapes that belong to this Body.
* If you only wish to apply it to a specific Shape in this Body then provide that as the 2nd parameter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param material The Material that will be applied.
* @param shape An optional Shape. If not provided the Material will be added to all Shapes in this Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setMaterial(material: Phaser.Physics.P2.Material, shape?: p2.Shape): void;
/**
* Sets the Body damping and angularDamping to zero.
*/
setZeroDamping(): void;
/**
* Sets the force on the body to zero.
*/
setZeroForce(): void;
/**
* If this Body is dynamic then this will zero its angular velocity.
*/
setZeroRotation(): void;
/**
* If this Body is dynamic then this will zero its velocity on both axis.
*/
setZeroVelocity(): void;
/**
* Transform a world point to local body frame.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param out The vector to store the result in.
* @param worldPoint The input world vector.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
toLocalFrame(out: number[], worldPoint: number[]): void;
/**
* Applies a force to the Body that causes it to 'thrust' forwards, based on its current angle and the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param speed The speed at which it should thrust.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
thrust(speed: number): void;
/**
* Transform a local point to world frame.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param out The vector to store the result in.
* @param localPoint The input local vector.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
toWorldFrame(out: number[], localPoint: number[]): void;
/**
* Updates the collisionMask.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param shape An optional Shape. If not provided the collision group will be added to all Shapes in this Body.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateCollisionMask(shape?: p2.Shape): void;
}
/**
* Draws a P2 Body to a Graphics instance for visual debugging.
* Needless to say, for every body you enable debug drawing on, you are adding processor and graphical overhead.
* So use sparingly and rarely (if ever) in production code.
*/
class BodyDebug extends Phaser.Group {
/**
* Draws a P2 Body to a Graphics instance for visual debugging.
* Needless to say, for every body you enable debug drawing on, you are adding processor and graphical overhead.
* So use sparingly and rarely (if ever) in production code.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Game reference to the currently running game.
* @param body The P2 Body to display debug data for.
* @param settings Settings object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The alpha value of the group container.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
constructor(game: Phaser.Game, body: Phaser.Physics.P2.Body, settings: { pixelsPerLengthUnit?: number; debugPolygons?: boolean; lineWidth?: number; alpha?: number; });
/**
* The P2 Body to display debug data for.
*/
body: Phaser.Physics.P2.Body;
/**
* The canvas to render the debug info to.
*/
canvas: Phaser.Graphics;
/**
* Pixels per Length Unit.
*/
ppu: number;
/**
* Core update.
*/
updateSpriteTransform(): void;
/**
* Draws the P2 shapes to the Graphics object.
*/
draw(): void;
}
/**
* Collision Group
*/
class CollisionGroup {
/**
* Collision Group
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bitmask The CollisionGroup bitmask.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(bitmask: number);
/**
* The CollisionGroup bitmask.
*/
mask: number;
}
/**
* Defines a physics material
*/
class ContactMaterial extends p2.ContactMaterial {
}
/**
* A constraint that tries to keep the distance between two bodies constant.
*/
class DistanceConstraint extends p2.DistanceConstraint {
/**
* A constraint that tries to keep the distance between two bodies constant.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param world A reference to the P2 World.
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param distance The distance to keep between the bodies.
* @param localAnchorA The anchor point for bodyA, defined locally in bodyA frame. Defaults to [0,0].
* @param localAnchorB The anchor point for bodyB, defined locally in bodyB frame. Defaults to [0,0].
* @param maxForce Maximum force to apply. - Default: Number.MAX_VALUE
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(world: Phaser.Physics.P2, bodyA: Phaser.Physics.P2.Body, bodyB: Phaser.Physics.P2.Body, distance: number, maxForce: number);
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* Local reference to P2 World.
*/
world: Phaser.Physics.P2;
}
/**
* Allow to access a list of created fixture (coming from Body#addPhaserPolygon)
* which itself parse the input from PhysicsEditor with the custom phaser exporter.
* You can access fixtures of a Body by a group index or even by providing a fixture Key.
* You can set the fixture key and also the group index for a fixture in PhysicsEditor.
* This gives you the power to create a complex body built of many fixtures and modify them
* during runtime (to remove parts, set masks, categories & sensor properties)
*/
class FixtureList {
/**
* Allow to access a list of created fixture (coming from Body#addPhaserPolygon)
* which itself parse the input from PhysicsEditor with the custom phaser exporter.
* You can access fixtures of a Body by a group index or even by providing a fixture Key.
* You can set the fixture key and also the group index for a fixture in PhysicsEditor.
* This gives you the power to create a complex body built of many fixtures and modify them
* during runtime (to remove parts, set masks, categories & sensor properties)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param list A list of fixtures (from Phaser.Physics.P2.Body#addPhaserPolygon)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(list: any[]);
/**
* A helper to flatten arrays. This is very useful as the fixtures are nested from time to time due to the way P2 creates and splits polygons.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param array The array to flatten. Notice: This will happen recursive not shallow.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
flatten(array: any[]): any[];
/**
* Accessor to get either a list of specified fixtures by key or the whole fixture list
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param keys A list of fixture keys
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFixtures(keys: string): any[];
/**
* Accessor to get either a single fixture by its key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The key of the fixture.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getFixtureByKey(key: string): any[];
/**
* Accessor to get a group of fixtures by its group index.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param groupID The group index.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getGroup(groupID: number): any[];
init(): void;
/**
* Parser for the output of Phaser.Physics.P2.Body#addPhaserPolygon
*/
parse(): void;
/**
*
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bit The bit to set as the collision group.
* @param fixtureKey Only apply to the fixture with the given key.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setCategory(bit: number, fictureKey: string): void;
/**
*
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param bit The bit to set as the collision mask
* @param fixtureKey Only apply to the fixture with the given key
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setMask(bit: number, fixtureKey: string): void;
/**
*
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param material The contact material for a fixture
* @param fixtureKey Only apply to the fixture with the given key
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setMaterial(material: any, fixtureKey: string): void;
/**
*
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value sensor true or false
* @param fixtureKey Only apply to the fixture with the given key
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setSensor(value: boolean, fixtureKey: string): void;
}
/**
* Connects two bodies at given offset points, letting them rotate relative to each other around this point.
*/
class GearConstraint extends p2.GearConstraint {
/**
* Connects two bodies at given offset points, letting them rotate relative to each other around this point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param world A reference to the P2 World.
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param angle The relative angle - Default: 0
* @param ratio The gear ratio. - Default: 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(world: Phaser.Physics.P2, bodyA: Phaser.Physics.P2.Body, bodyB: Phaser.Physics.P2.Body, angle?: number, ratio?: number);
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* Local reference to P2 World.
*/
world: Phaser.Physics.P2;
}
/**
* A InversePointProxy is an internal class that allows for direct getter/setter style property access to Arrays and TypedArrays but inverses the values on set.
*/
class InversePointProxy {
/**
* A InversePointProxy is an internal class that allows for direct getter/setter style property access to Arrays and TypedArrays but inverses the values on set.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param world A reference to the P2 World.
* @param destination The object to bind to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(world: Phaser.Physics.P2, destination: any);
/**
* The x property of this InversePointProxy get and set in pixels.
*/
x: number;
/**
* The y property of this InversePointProxy get and set in pixels.
*/
y: number;
/**
* The x property of this InversePointProxy get and set in meters.
*/
mx: number;
/**
* The y property of this InversePointProxy get and set in meters.
*/
my: number;
}
/**
* Locks the relative position between two bodies.
*/
class LockConstraint extends p2.LockConstraint {
/**
* Locks the relative position between two bodies.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param world A reference to the P2 World.
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param offset The offset of bodyB in bodyA's frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param angle The angle of bodyB in bodyA's frame. - Default: 0
* @param maxForce The maximum force that should be applied to constrain the bodies.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(world: Phaser.Physics.P2, bodyA: Phaser.Physics.P2.Body, bodyB: Phaser.Physics.P2.Body, offset?: number[], angle?: number, maxForce?: number);
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* Local reference to P2 World.
*/
world: Phaser.Physics.P2;
}
/**
* A P2 Material.
*
* \o/ ~ "Because I'm a Material girl"
*/
class Material extends p2.Material {
/**
* A P2 Material.
*
* \o/ ~ "Because I'm a Material girl"
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The user defined name given to this Material.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(name: string);
/**
* The user defined name given to this Material.
*/
name: string;
}
/**
* A PointProxy is an internal class that allows for direct getter/setter style property access to Arrays and TypedArrays.
*/
class PointProxy {
/**
* A PointProxy is an internal class that allows for direct getter/setter style property access to Arrays and TypedArrays.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param world A reference to the P2 World.
* @param destination The object to bind to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(world: Phaser.Physics.P2, destination: any);
/**
* The x property of this PointProxy get and set in pixels.
*/
x: number;
/**
* The y property of this PointProxy get and set in pixels.
*/
y: number;
/**
* The x property of this PointProxy get and set in meters.
*/
mx: number;
/**
* The x property of this PointProxy get and set in meters.
*/
my: number;
}
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Connects two bodies at given offset points, letting them rotate relative to each other around this point.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class PrismaticConstraint extends p2.PrismaticConstraint {
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Connects two bodies at given offset points, letting them rotate relative to each other around this point.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param world A reference to the P2 World.
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param lockRotation If set to false, bodyB will be free to rotate around its anchor point. - Default: true
* @param anchorA Body A's anchor point, defined in its own local frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param anchorB Body A's anchor point, defined in its own local frame. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param axis An axis, defined in body A frame, that body B's anchor point may slide along. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param maxForce The maximum force that should be applied to constrain the bodies.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(world: Phaser.Physics.P2, bodyA?: Phaser.Physics.P2.Body, bodyB?: Phaser.Physics.P2.Body, lockRotation?: boolean, anchorA?: number[], anchorB?: number[], axis?: number[], maxForce?: number);
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* Local reference to P2 World.
*/
world: Phaser.Physics.P2;
}
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Connects two bodies at given offset points, letting them rotate relative to each other around this point.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The pivot points are given in world (pixel) coordinates.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
*/
class RevoluteConstraint extends p2.RevoluteConstraint {
/**
* Connects two bodies at given offset points, letting them rotate relative to each other around this point.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The pivot points are given in world (pixel) coordinates.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param world A reference to the P2 World.
* @param bodyA First connected body.
* @param pivotA The point relative to the center of mass of bodyA which bodyA is constrained to. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param bodyB Second connected body.
* @param pivotB The point relative to the center of mass of bodyB which bodyB is constrained to. The value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param maxForce The maximum force that should be applied to constrain the bodies. - Default: 0
* @param worldPivot A pivot point given in world coordinates. If specified, localPivotA and localPivotB are automatically computed from this value. - Default: null
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
constructor(world: Phaser.Physics.P2, bodyA: Phaser.Physics.P2.Body, pivotA: number[], bodyB: Phaser.Physics.P2.Body, pivotB: number[], maxForce?: number);
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Local reference to game.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
game: Phaser.Game;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Local reference to P2 World.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
world: Phaser.Physics.P2;
}
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Creates a linear spring, connecting two bodies. A spring can have a resting length, a stiffness and damping.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class Spring {
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Creates a linear spring, connecting two bodies. A spring can have a resting length, a stiffness and damping.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param world A reference to the P2 World.
* @param bodyA First connected body.
* @param bodyB Second connected body.
* @param restLength Rest length of the spring. A number > 0. - Default: 1
* @param stiffness Stiffness of the spring. A number >= 0. - Default: 100
* @param damping Damping of the spring. A number >= 0. - Default: 1
* @param worldA Where to hook the spring to body A in world coordinates. This value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param worldB Where to hook the spring to body B in world coordinates. This value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param localA Where to hook the spring to body A in local body coordinates. This value is an array with 2 elements matching x and y, i.e: [32, 32].
* @param localB Where to hook the spring to body B in local body coordinates. This value is an array with 2 elements matching x and y, i.e: [32, 32].
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(world: Phaser.Physics.P2, bodyA: Phaser.Physics.P2.Body, bodyB: Phaser.Physics.P2.Body, restLength?: number, stiffness?: number, damping?: number, worldA?: number[], worldB?: number[], localA?: number[], localB?: number[]);
/**
* The actual p2 spring object.
*/
data: p2.LinearSpring;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* Local reference to P2 World.
*/
world: Phaser.Physics.P2;
}
}
}
/**
* This is a base Plugin template to use for any Phaser plugin development.
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
class Plugin implements IStateCycle {
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* This is a base Plugin template to use for any Phaser plugin development.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param parent The object that owns this plugin, usually Phaser.PluginManager.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, parent: PIXI.DisplayObject);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A Plugin with active=true has its preUpdate and update methods called by the parent, otherwise they are skipped.
* Default: false
*/
active: boolean;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* A flag to indicate if this plugin has a postRender method.
* Default: false
*/
hasPostRender: boolean;
/**
* A flag to indicate if this plugin has a postUpdate method.
* Default: false
*/
hasPostUpdate: boolean;
/**
* A flag to indicate if this plugin has a preUpdate method.
* Default: false
*/
hasPreUpdate: boolean;
/**
* A flag to indicate if this plugin has a render method.
* Default: false
*/
hasRender: boolean;
/**
* A flag to indicate if this plugin has an update method.
* Default: false
*/
hasUpdate: boolean;
/**
* The parent of this plugin. If added to the PluginManager the parent will be set to that, otherwise it will be null.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
parent: PIXI.DisplayObject;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A Plugin with visible=true has its render and postRender methods called by the parent, otherwise they are skipped.
* Default: false
*/
visible: boolean;
/**
* Clear down this Plugin and null out references
*/
destroy(): void;
/**
* Post-render is called after the Game Renderer and State.render have run.
* It is only called if visible is set to true.
*/
postRender(): void;
/**
* Pre-update is called at the very start of the update cycle, before any other subsystems have been updated (including Physics).
* It is only called if active is set to true.
*/
preUpdate(): void;
/**
* Render is called right after the Game Renderer completes, but before the State.render.
* It is only called if visible is set to true.
*/
render(): void;
/**
* Update is called after all the core subsystems (Input, Tweens, Sound, etc) and the State have updated, but before the render.
* It is only called if active is set to true.
*/
update(): void;
}
module Plugin {
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* AStar is a phaser pathfinding plugin based on an A* kind of algorythm
* It works with the Phaser.Tilemap
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
class AStar extends Phaser.Plugin {
static VERSION: string;
static COST_ORTHAGONAL: number;
static COST_DIAGAONAL: number;
static DISTANCE_MANHATTEN: string;
static DISTANCE_EUCLIDIAN: string;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* AStar is a phaser pathfinding plugin based on an A* kind of algorythm
* It works with the Phaser.Tilemap
*
* @param parent The object that owns this plugin, usually Phaser.PluginManager.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(parent: PIXI.DisplayObject);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The parent of this plugin. If added to the PluginManager the parent will be set to that, otherwise it will be null.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
parent: PIXI.DisplayObject;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
version: string;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Find a path between to tiles coordinates
*
* @param startPoint The start point x, y in tiles coordinates to search a path.
* @param goalPoint The goal point x, y in tiles coordinates that you trying to reach.
* @return The Phaser.Plugin.AStar.AStarPath that results
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
findPath(startPoint: Phaser.Point, goalPoint: Phaser.Point): Phaser.Plugin.AStar.AStarPath;
isWalkable(x: number, y: number): boolean;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Sets the Phaser.Tilemap used to searchPath into.
*
* @param map the Phaser.Tilemap used to searchPath into. It must have a tileset with tile porperties to know if tiles are walkable or not.
* @param layerName The name of the layer that handle tiles.
* @param tilesetName The name of the tileset that have walkable properties.
* @return The Phaser.Plugin.AStar itself.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
setAStarMap(map: Phaser.Tilemap, layerName: string, tilesetName: string): Phaser.Plugin.AStar;
}
module AStar {
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* AStarNode is an object that stores AStar value. Each tile have an AStarNode in their properties
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
class AStarNode {
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* AStarNode is an object that stores AStar value. Each tile have an AStarNode in their properties
*
* @param x The x coordinate of the tile.
* @param y The y coordinate of the tile.
* @param isWalkable Is this tile is walkable?
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
constructor(x: number, y: number, isWalkable: boolean);
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The x coordinate of the tile.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
x: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The y coordinate of the tile.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
y: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The total travel cost from the start point. Sum of COST_ORTHOGONAL and COST_DIAGONAL
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
g: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The remaing distance as the crow flies between this node and the goal.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
h: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The weight. Sum of g + h.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
f: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Where do we come from? It's an AStarNode reference needed to reconstruct a path backwards (from goal to start point)
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
parent: Phaser.Plugin.AStar.AStarNode;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The cost to travel to this node, COST_ORTHOGONAL or COST_DIAGONAL
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
travelCost: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Is this node is walkable?
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
walkable: boolean;
}
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* AStarPath is an object that stores a searchPath result.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
class AStarPath {
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* AStarPath is an object that stores a searchPath result.
*
* @param nodes An array of nodes coordinates sorted backward from goal to start point.
* @param start The start AStarNode used for the searchPath.
* @param goal The goal AStarNode used for the searchPath.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
constructor(nodes: Phaser.Plugin.AStar.AStarNode[], start: Phaser.Plugin.AStar.AStarNode, goal: Phaser.Plugin.AStar.AStarNode);
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Array of AstarNodes x, y coordiantes that are the path solution from goal to start point.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
nodes: Phaser.Plugin.AStar.AStarNode[];
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Reference to the start point used by findPath.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
start: Phaser.Plugin.AStar.AStarNode;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Reference to the goal point used by findPath.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
goal: Phaser.Plugin.AStar.AStarNode;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Array of AStarNodes that the findPath algorythm has visited. Used for debug only.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
visited: Phaser.Plugin.AStar.AStarNode[];
}
}
class ColorHarmony extends Phaser.Plugin {
getAnalogousHarmony(color: number, threshold?: number): any;
getComplementHarmony(color: number): number;
getSplitComplementHarmony(color: number, threshold: number): any;
getTriadicHarmony(color: number): any;
}
class CSS3Filters extends Phaser.Plugin {
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(parent: PIXI.DisplayObject);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
blur: number;
brightness: number;
contrast: number;
grayscale: number;
hueRotate: number;
invert: number;
opacity: number;
saturate: number;
sepia: number;
}
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Creates an object that is placed within a layer of a Phaser.Tilemap and can be moved around and rotated using the direction commands.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
class TilemapWalker extends Phaser.Plugin {
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Creates an object that is placed within a layer of a Phaser.Tilemap and can be moved around and rotated using the direction commands.
*
* @param game Game reference to the currently running game.
* @param map A reference to the Tilemap this TilemapWalker belongs to.
* @param layer The layer to operate on. If not given will default to this.currentLayer.
* @param x X position of the top left of the area to copy (given in tiles, not pixels)
* @param y Y position of the top left of the area to copy (given in tiles, not pixels)
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
constructor(game: Phaser.Game, map: Phaser.Tilemap, layer?: any, x?: number, y?: number);
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Does the TilemapWalker collide with the tiles in the map set for collision? If so it cannot move through them.
* Default: true
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
collides: boolean;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* A reference to the currently running Game.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
game: Phaser.Game;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* An array containing a history of movements through the map.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
history: boolean;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The direction the location marker is facing. You can rotate it using the turn and face methods.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
facing: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* A reference to the Tilemap this TilemapWalker belongs to.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
map: Phaser.Tilemap;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The current marker location. You can move the marker with the movement methods.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
location: Phaser.Point;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The current layer of the location marker.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
locationLayer: number;
checkTile(x: number, y: number): boolean;
getTileFromLocation(x: number, y: number): Phaser.Tile;
getTiles(width: number, height: number, center?: boolean): any[];
getTileBehind(distance?: number): Phaser.Tile;
getTileBehindLeft(distance?: number): Phaser.Tile;
getTileBehindRight(distance?: number): Phaser.Tile;
getTileAhead(distance?: number): Phaser.Tile;
getTileAheadLeft(distance?: number): Phaser.Tile;
getTileAheadRight(distance?: number): Phaser.Tile;
getTileLeft(distance: number): Phaser.Tile;
getTileRight(distance: number): Phaser.Tile;
moveForward(): boolean;
moveBackward(): boolean;
moveLeft(): boolean;
moveRight(): boolean;
putTile(index: number): void;
setLocation(x: number, y: number, layer?: any): boolean;
turnLeft(): void;
turnRight(): void;
updateLocation(x: number, y: number): boolean;
}
class SamplePlugin extends Phaser.Plugin {
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, parent: PIXI.DisplayObject);
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
addSprite(sprite: Phaser.Sprite): void;
update(): void;
}
class VirtualJoystick extends Phaser.Plugin {
constructor(game: Phaser.Game, parent: any);
angle: number;
base: Phaser.Sprite;
baseBMD: Phaser.BitmapData;
baseCircle: Phaser.Circle;
deltaX: number;
deltaY: number;
distance: number;
force: number;
isDragging: boolean;
limit: number;
limitPoint: Phaser.Point;
location: Phaser.Point;
nub: Phaser.Sprite;
nubBMD: Phaser.BitmapData;
speed: number;
x: number;
y: number;
init(x: number, y: number, diameter?: number, limit?: number): void;
move(pointer: Phaser.Pointer, x: number, y: number): void;
render(): void;
setVelocity(sprite: Phaser.Sprite, minSpeed?: number, maxSpeed?: number): Phaser.Sprite;
startDrag(): void;
stopDrag(nub: Phaser.Sprite, pointer: Phaser.Pointer): void;
update(): void;
}
class Webcam extends Phaser.Plugin {
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, parent: PIXI.DisplayObject);
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
active: boolean;
context: any;
stream: any;
video: HTMLVideoElement;
connectCallback: (stream: any) => void;
errorCallback: (e: any) => void;
grab: (context: any, x: number, y: number) => void;
start(width: number, height: number, context: any): void;
stop(): void;
update(): void;
}
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Creates a new `Juicy` object.
*/
class Juicy extends Phaser.Plugin {
/**
* Creates a new `Juicy` object.
*
* @param game Current game instance.
*/
constructor(game: Phaser.Game);
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Creates a 'Juicy.ScreenFlash' object
*
* @param color The color of the screen flash
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
createScreenFlash(color?: string): Phaser.Plugin.Juicy.ScreenFlash;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Creates a 'Juicy.Trail' object
*
* @param length The length of the trail
* @param color The color of the trail
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
createTrail(length?: number, color?: number): Phaser.Plugin.Juicy.Trail;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Creates the over scale effect on the given object
*
* @param object The object to over scale
* @param scale The scale amount to overscale by - Default: 1.5
* @param initialScale The initial scale of the object - Default: new Phaser.Point(1,1)
*/
overScale(object: Phaser.Sprite, scale?: number, initialScale?: Phaser.Point): void;
/**
* Creates the jelly effect on the given object
*
* @param object The object to gelatinize
* @param strength The strength of the effect - Default: 0.2
* @param delay The delay of the snap-back tween. 50ms are automaticallly added to whatever the delay amount is. - Default: 0
* @param initialScale The initial scale of the object - Default: new Phaser.Point(1,1)
*/
jelly(object: Phaser.Sprite, strength?: number, delay?: number, initialScale?: Phaser.Point): void;
/**
* Creates the mouse stretch effect on the given object
*
* @param object The object to mouse stretch
* @param strength The strength of the effect - Default: 0.5
* @param initialScale The initial scale of the object - Default: new Phaser.Point(1,1)
*/
mouseStretch(object: Phaser.Sprite, strength?: number, initialScale?: Phaser.Point): void;
/**
* Runs the core update function and causes screen shake and overscaling effects to occur if they are queued to do so.
*/
update(): void;
shake(duration?: number, strength?: number): void;
}
module Juicy {
/**
* Creates a new `Juicy.Trail` object.
*/
class Trail {
/**
* Creates a new `Juicy.Trail` object.
*
* @param game Current game instance.
* @param trailLength The length of the trail - Default: 100
* @param color The color of the trail - Default: 0xFFFFFF
*/
constructor(game: Phaser.Game, trailLength?: number, color?: number);
/**
* The target sprite whose movement we want to create the trail from
*/
target: Phaser.Sprite;
/**
* The number of segments to use to create the trail
*/
trailLength: number;
/**
* The width of the trail
*/
trailWidth: number;
/**
* Whether or not to taper the trail towards the end
*/
trailScaling: boolean;
/**
* The color of the trail
*/
trailColor: number;
/**
* Updates the Trail if a target is set
*/
update(): void;
/**
* Adds a segment to the segments list and culls the list if it is too long
*
* @param x The x position of the point
* @param y The y position of the point
*/
addSegment(x: number, y: number): void;
redrawSegments(offsetX: number, offsetY: number): void;
}
/**
* Creates a new `Juicy.ScreenFlash` object.
*/
class ScreenFlash {
/**
* Creates a new `Juicy.ScreenFlash` object.
*
* @param game Current game instance.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param color='white' The color to flash the screen.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
*/
constructor(game: Phaser.Game, color?: string);
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
flash(maxAlpha?: number, duration?: number): void;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
}
}
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
/**
* The Plugin Manager is responsible for the loading, running and unloading of Phaser Plugins.
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
class PluginManager implements IStateCycle {
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The Plugin Manager is responsible for the loading, running and unloading of Phaser Plugins.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
constructor(game: Phaser.Game);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* An array of all the plugins being managed by this PluginManager.
*/
plugins: Phaser.Plugin[];
/**
* Add a new Plugin into the PluginManager.
* The Plugin must have 2 properties: game and parent. Plugin.game is set to the game reference the PluginManager uses, and parent is set to the PluginManager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param plugin The Plugin to add into the PluginManager. This can be a function or an existing object.
* @param args Additional parameters that will be passed to the Plugin.init method.
* @return The Plugin that was added to the manager.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
add(plugin: Phaser.Plugin | typeof Phaser.Plugin, ...parameter: any[]): Phaser.Plugin;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Clear down this PluginManager, calls destroy on every plugin and nulls out references.
*/
destroy(): void;
/**
* Post-render is called after the Game Renderer and State.render have run.
* It only calls plugins who have visible=true.
*/
postRender(): void;
/**
* PostUpdate is the last thing to be called before the world render.
* In particular, it is called after the world postUpdate, which means the camera has been adjusted.
* It only calls plugins who have active=true.
*/
postUpdate(): void;
/**
* Pre-update is called at the very start of the update cycle, before any other subsystems have been updated (including Physics).
* It only calls plugins who have active=true.
*/
preUpdate(): void;
/**
* Remove a Plugin from the PluginManager. It calls Plugin.destroy on the plugin before removing it from the manager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param plugin The plugin to be removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(plugin: Phaser.Plugin): void;
/**
* Remove all Plugins from the PluginManager. It calls Plugin.destroy on every plugin before removing it from the manager.
*/
removeAll(): void;
/**
* Render is called right after the Game Renderer completes, but before the State.render.
* It only calls plugins who have visible=true.
*/
render(): void;
/**
* Update is called after all the core subsystems (Input, Tweens, Sound, etc) and the State have updated, but before the render.
* It only calls plugins who have active=true.
*/
update(): void;
}
/**
* A Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis.
* The following code creates a point at (0,0):
* `var myPoint = new Phaser.Point();`
* You can also use them as 2D Vectors and you'll find different vector related methods in this class.
*/
class Point extends PIXI.Point {
/**
* A Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis.
* The following code creates a point at (0,0):
* `var myPoint = new Phaser.Point();`
* You can also use them as 2D Vectors and you'll find different vector related methods in this class.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The horizontal position of this Point. - Default: 0
* @param y The vertical position of this Point. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(x?: number, y?: number);
/**
* The x value of the point.
*/
x: number;
/**
* The y value of the point.
*/
y: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The const type of this object.
*/
type: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Adds the given x and y values to this Point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The value to add to Point.x.
* @param y The value to add to Point.y.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static add(a: Phaser.Point, b: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Subtracts the given x and y values from this Point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The value to subtract from Point.x.
* @param y The value to subtract from Point.y.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static subtract(a: Phaser.Point, b: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Multiplies Point.x and Point.y by the given x and y values. Sometimes known as `Scale`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The value to multiply Point.x by.
* @param y The value to multiply Point.x by.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static multiply(a: Phaser.Point, b: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Divides Point.x and Point.y by the given x and y values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The value to divide Point.x by.
* @param y The value to divide Point.x by.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static divide(a: Phaser.Point, b: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Determines whether the given objects x/y values are equal to this Point object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The object to compare with this Point.
* @return A value of true if the x and y points are equal, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static equals(a: Phaser.Point, b: Phaser.Point): boolean;
/**
* Returns the angle between this Point object and another object with public x and y properties.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The object to get the angle from this Point to.
* @param asDegrees Is the given angle in radians (false) or degrees (true)? - Default: false
* @return The angle between the two objects.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static angle(a: Phaser.Point, b: Phaser.Point): number;
static angleSq(a: Phaser.Point, b: Phaser.Point): number;
/**
* Creates a negative Point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The first Point object.
* @param out Optional Point to store the value in, if not supplied a new Point object will be created.
* @return The new Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static negative(a: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Adds two 2D Points together and multiplies the result by the given scalar.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The first Point object.
* @param b The second Point object.
* @param s The scaling value.
* @param out Optional Point to store the value in, if not supplied a new Point object will be created.
* @return The new Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static multiplyAdd(a: Phaser.Point, b: Phaser.Point, scale: number, out?: Phaser.Point): Phaser.Point;
/**
* Interpolates the two given Points, based on the `f` value (between 0 and 1) and returns a new Point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The first Point object.
* @param b The second Point object.
* @param f The level of interpolation between the two points. Indicates where the new point will be, along the line between pt1 and pt2. If f=1, pt1 is returned; if f=0, pt2 is returned.
* @param out Optional Point to store the value in, if not supplied a new Point object will be created.
* @return The new Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static interpolate(a: Phaser.Point, b: Phaser.Point, alpha: number, out?: Phaser.Point): Phaser.Point;
/**
* Parses an object for x and/or y properties and returns a new Phaser.Point with matching values.
* If the object doesn't contain those properties a Point with x/y of zero will be returned.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param obj The object to parse.
* @param xProp The property used to set the Point.x value. - Default: 'x'
* @param yProp The property used to set the Point.y value. - Default: 'y'
* @return The new Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static parse(obj: any, xProp?: string, yProp?: string): Phaser.Point;
/**
* Make this Point perpendicular (90 degrees rotation)
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static perp(a: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Make this Point perpendicular (-90 degrees rotation)
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static rperp(a: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Returns the distance of this Point object to the given object (can be a Circle, Point or anything with x/y properties)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dest The target object. Must have visible x and y properties that represent the center of the object.
* @param round Round the distance to the nearest integer (default false).
* @return The distance between this Point object and the destination Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static distance(a: any, b: any, round?: boolean): number;
/**
* Project two Points onto another Point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The first Point object.
* @param b The second Point object.
* @param out Optional Point to store the value in, if not supplied a new Point object will be created.
* @return The new Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static project(a: Phaser.Point, b: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Project two Points onto a Point of unit length.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The first Point object.
* @param b The second Point object.
* @param out Optional Point to store the value in, if not supplied a new Point object will be created.
* @return The new Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static projectUnit(a: Phaser.Point, b: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Right-hand normalize (make unit length) this Point.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static normalRightHand(a: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Alters the Point object so that its length is 1, but it retains the same direction.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static normalize(a: Phaser.Point, out?: Phaser.Point): Phaser.Point;
/**
* Rotates this Point around the x/y coordinates given to the desired angle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the anchor point.
* @param y The y coordinate of the anchor point.
* @param angle The angle in radians (unless asDegrees is true) to rotate the Point to.
* @param asDegrees Is the given rotation in radians (false) or degrees (true)?
* @param distance An optional distance constraint between the Point and the anchor.
* @return The modified point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static rotate(a: Phaser.Point, x: number, y: number, angle: number, asDegrees?: boolean, distance?: number): Phaser.Point;
/**
* Calculates centroid (or midpoint) from an array of points. If only one point is provided, that point is returned.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param points The array of one or more points.
* @param out Optional Point to store the value in, if not supplied a new Point object will be created.
* @return The new Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static centroid(points: Phaser.Point[], out?: Phaser.Point): Phaser.Point;
/**
* Adds the given x and y values to this Point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The value to add to Point.x.
* @param y The value to add to Point.y.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(x: number, y: number): Phaser.Point;
/**
* Returns the angle between this Point object and another object with public x and y properties.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The object to get the angle from this Point to.
* @param asDegrees Is the given angle in radians (false) or degrees (true)? - Default: false
* @return The angle between the two objects.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle(a: Phaser.Point, asDegrees?: boolean): number;
angleSq(a: Phaser.Point): number;
/**
* Clamps this Point object values to be between the given min and max.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value to clamp this Point to.
* @param max The maximum value to clamp this Point to.
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clamp(min: number, max: number): Phaser.Point;
/**
* Clamps the x value of this Point to be between the given min and max.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value to clamp this Point to.
* @param max The maximum value to clamp this Point to.
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clampX(min: number, max: number): Phaser.Point;
/**
* Clamps the y value of this Point to be between the given min and max
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value to clamp this Point to.
* @param max The maximum value to clamp this Point to.
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clampY(min: number, max: number): Phaser.Point;
/**
* Creates a copy of the given Point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param output Optional Point object. If given the values will be set into this object, otherwise a brand new Point object will be created and returned.
* @return The new Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clone(output?: Phaser.Point): Phaser.Point;
/**
* Copies the x and y properties from any given object to this Point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The object to copy from.
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copyFrom(source: Phaser.Point): Phaser.Point;
/**
* Copies the x and y properties from this Point to any given object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dest The object to copy to.
* @return The dest object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copyTo<T>(dest: T): T;
/**
* Math.ceil() both the x and y properties of this Point.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
ceil(): Phaser.Point;
/**
* The cross product of this and another Point object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The Point object to get the cross product combined with this Point.
* @return The result.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cross(a: Phaser.Point): number;
/**
* Divides Point.x and Point.y by the given x and y values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The value to divide Point.x by.
* @param y The value to divide Point.x by.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
divide(x: number, y: number): Phaser.Point;
/**
* Returns the distance of this Point object to the given object (can be a Circle, Point or anything with x/y properties)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dest The target object. Must have visible x and y properties that represent the center of the object.
* @param round Round the distance to the nearest integer (default false).
* @return The distance between this Point object and the destination Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
distance(dest: Phaser.Point, round?: boolean): number;
/**
* The dot product of this and another Point object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The Point object to get the dot product combined with this Point.
* @return The result.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
dot(a: Phaser.Point): number;
/**
* Determines whether the given objects x/y values are equal to this Point object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The object to compare with this Point.
* @return A value of true if the x and y points are equal, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
equals(a: Phaser.Point): boolean;
/**
* Math.floor() both the x and y properties of this Point.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
floor(): Phaser.Point;
/**
* Calculates the length of the Point object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The length of the Point.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getMagnitude(): number;
/**
* Calculates the length squared of the Point object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The length ^ 2 of the Point.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getMagnitudeSq(): number;
/**
* Inverts the x and y values of this Point
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
invert(): Phaser.Point;
/**
* Determine if this point is at 0,0.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if this Point is 0,0, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isZero(): boolean;
/**
* Multiplies Point.x and Point.y by the given x and y values. Sometimes known as `Scale`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The value to multiply Point.x by.
* @param y The value to multiply Point.x by.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
multiply(x: number, y: number): Phaser.Point;
/**
* Alters the Point object so that its length is 1, but it retains the same direction.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
normalize(): Phaser.Point;
/**
* Right-hand normalize (make unit length) this Point.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
normalRightHand(): Phaser.Point;
/**
* Make this Point perpendicular (90 degrees rotation)
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
perp(): Phaser.Point;
/**
* Make this Point perpendicular (-90 degrees rotation)
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
rperp(): Phaser.Point;
/**
* Rotates this Point around the x/y coordinates given to the desired angle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the anchor point.
* @param y The y coordinate of the anchor point.
* @param angle The angle in radians (unless asDegrees is true) to rotate the Point to.
* @param asDegrees Is the given rotation in radians (false) or degrees (true)?
* @param distance An optional distance constraint between the Point and the anchor.
* @return The modified point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
rotate(x: number, y: number, angle: number, asDegrees?: boolean, distance?: number): Phaser.Point;
/**
* Sets the `x` and `y` values of this Point object to the given values.
* If you omit the `y` value then the `x` value will be applied to both, for example:
* `Point.setTo(2)` is the same as `Point.setTo(2, 2)`
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The horizontal value of this point.
* @param y The vertical value of this point. If not given the x value will be used in its place.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
set(x: number, y?: number): Phaser.Point;
/**
* Alters the length of the Point without changing the direction.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param magnitude The desired magnitude of the resulting Point.
* @return This Point object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setMagnitude(magnitude: number): Phaser.Point;
/**
* Sets the `x` and `y` values of this Point object to the given values.
* If you omit the `y` value then the `x` value will be applied to both, for example:
* `Point.setTo(2)` is the same as `Point.setTo(2, 2)`
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The horizontal value of this point.
* @param y The vertical value of this point. If not given the x value will be used in its place.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setTo(x: number, y?: number): Phaser.Point;
/**
* Subtracts the given x and y values from this Point.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The value to subtract from Point.x.
* @param y The value to subtract from Point.y.
* @return This Point object. Useful for chaining method calls.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
subtract(x: number, y: number): Phaser.Point;
/**
* Returns a string representation of this object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A string representation of the instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
toString(): string;
}
/**
* A Pointer object is used by the Mouse, Touch and MSPoint managers and represents a single finger on the touch screen.
*/
class Pointer {
/**
* A Pointer object is used by the Mouse, Touch and MSPoint managers and represents a single finger on the touch screen.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param id The ID of the Pointer object within the game. Each game can have up to 10 active pointers.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, id: number);
/**
* An active pointer is one that is currently pressed down on the display. A Mouse is always active.
* Default: false
*/
active: boolean;
/**
* The button property of the Pointer as set by the DOM event when this Pointer is started.
* Default: null
*/
button: any;
/**
* A Phaser.Circle that is centered on the x/y coordinates of this pointer, useful for hit detection.
* The Circle size is 44px (Apples recommended "finger tip" size).
*/
circle: Phaser.Circle;
/**
* The horizontal coordinate of the Pointer within the application's client area at which the event occurred (as opposed to the coordinates within the page).
*/
clientX: number;
/**
* The vertical coordinate of the Pointer within the application's client area at which the event occurred (as opposed to the coordinates within the page).
*/
clientY: number;
/**
* A dirty pointer needs to re-poll any interactive objects it may have been over, regardless if it has moved or not.
* Default: false
*/
dirty: boolean;
/**
* How long the Pointer has been depressed on the touchscreen. If not currently down it returns -1.
*/
duration: number;
/**
* A Pointer object that exists is allowed to be checked for physics collisions and overlaps.
* Default: true
*/
exists: boolean;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* The ID of the Pointer object within the game. Each game can have up to 10 active pointers.
*/
id: number;
/**
* The identifier property of the Pointer as set by the DOM event when this Pointer is started.
* Default: 0
*/
identifier: number;
/**
* If the Pointer is touching the touchscreen, or the mouse button is held down, isDown is set to true.
* Default: false
*/
isDown: boolean;
/**
* If the Pointer is a mouse this is true, otherwise false.
* Default: false
*/
isMouse: boolean;
/**
* If the Pointer is not touching the touchscreen, or the mouse button is up, isUp is set to true.
* Default: true
*/
isUp: boolean;
/**
* The horizontal processed relative movement of the Pointer in pixels since last event.
* Default: 0
*/
movementX: number;
/**
* The vertical processed relative movement of the Pointer in pixels since last event.
* Default: 0
*/
movementY: number;
/**
* The number of milliseconds since the last click or touch event.
*/
msSinceLastClick: number;
/**
* The horizontal coordinate of the Pointer relative to whole document.
*/
pageX: number;
/**
* The vertical coordinate of the Pointer relative to whole document.
*/
pageY: number;
/**
* The pointerId property of the Pointer as set by the DOM event when this Pointer is started. The browser can and will recycle this value.
* Default: null
*/
pointerId: number;
/**
* A Phaser.Point object containing the current x/y values of the pointer on the display.
*/
position: Phaser.Point;
/**
* A Phaser.Point object containing the x/y values of the pointer when it was last in a down state on the display.
*/
positionDown: Phaser.Point;
/**
* A Phaser.Point object containing the x/y values of the pointer when it was last released.
*/
positionUp: Phaser.Point;
/**
* A timestamp representing when the Pointer was last tapped or clicked.
* Default: 0
*/
previousTapTime: number;
/**
* The horizontal raw relative movement of the Pointer in pixels since last event.
* Default: 0
*/
rawMovementX: number;
/**
* The vertical raw relative movement of the Pointer in pixels since last event.
* Default: 0
*/
rawMovementY: number;
/**
* The horizontal coordinate of the Pointer relative to the screen.
*/
screenX: number;
/**
* The vertical coordinate of the Pointer relative to the screen.
*/
screenY: number;
/**
* The target property of the Pointer as set by the DOM event when this Pointer is started.
* Default: null
*/
target: any;
/**
* The Game Object this Pointer is currently over / touching / dragging.
* Default: null
*/
targetObject: any;
/**
* A timestamp representing when the Pointer first touched the touchscreen.
* Default: 0
*/
timeDown: number;
/**
* A timestamp representing when the Pointer left the touchscreen.
* Default: 0
*/
timeUp: number;
/**
* The total number of times this Pointer has been touched to the touchscreen.
* Default: 0
*/
totalTouches: number;
/**
* The const type of this object.
*/
type: number;
/**
* true if the Pointer is over the game canvas, otherwise false.
*/
withinGame: boolean;
/**
* Gets the X value of this Pointer in world coordinates based on the world camera.
*/
worldX: number;
/**
* Gets the Y value of this Pointer in world coordinates based on the world camera.
*/
worldY: number;
/**
* The horizontal coordinate of the Pointer. This value is automatically scaled based on the game scale.
*/
x: number;
/**
* The vertical coordinate of the Pointer. This value is automatically scaled based on the game scale.
*/
y: number;
/**
* Add a click trampoline to this pointer.
*
* A click trampoline is a callback that is run on the DOM 'click' event; this is primarily
* needed with certain browsers (ie. IE11) which restrict some actions like requestFullscreen
* to the DOM 'click' event and reject it for 'pointer*' and 'mouse*' events.
*
* This is used internally by the ScaleManager; click trampoline usage is uncommon.
* Click trampolines can only be added to pointers that are currently down.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the trampoline; must be unique among active trampolines in this pointer.
* @param callback Callback to run/trampoline.
* @param callbackContext Context of the callback.
* @param callbackArgs Additional callback args, if any. Supplied as an array.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addClickTrampoline(name: string, callback: Function, callbackContext: any, ...callbackArgs: any[]): void;
/**
* The Pointer is considered justPressed if the time it was pressed onto the touchscreen or clicked is less than justPressedRate.
* Note that calling justPressed doesn't reset the pressed status of the Pointer, it will return `true` for as long as the duration is valid.
* If you wish to check if the Pointer was pressed down just once then see the Sprite.events.onInputDown event.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration The time to check against. If none given it will use InputManager.justPressedRate.
* @return true if the Pointer was pressed down within the duration given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justPressed(duration?: number): boolean;
/**
* The Pointer is considered justReleased if the time it left the touchscreen is less than justReleasedRate.
* Note that calling justReleased doesn't reset the pressed status of the Pointer, it will return `true` for as long as the duration is valid.
* If you wish to check if the Pointer was released just once then see the Sprite.events.onInputUp event.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration The time to check against. If none given it will use InputManager.justReleasedRate.
* @return true if the Pointer was released within the duration given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justReleased(duration?: number): boolean;
/**
* Called when the Pointer leaves the target area.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The event passed up from the input handler.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
leave(event: any): void;
/**
* Called when the Pointer is moved.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The event passed up from the input handler.
* @param fromClick Was this called from the click event? - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
move(event: any, fromClick?: boolean): void;
/**
* Resets the Pointer properties. Called by InputManager.reset when you perform a State change.
*/
reset(): void;
/**
* Resets the movementX and movementY properties. Use in your update handler after retrieving the values.
*/
resetMovement(): void;
/**
* Called when the Pointer is pressed onto the touchscreen.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The DOM event from the browser.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
start(event: any): void;
/**
* Called when the Pointer leaves the touchscreen.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The event passed up from the input handler.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
stop(event: any): void;
/**
* Called by the Input Manager.
*/
update(): void;
}
/**
* Creates a new Polygon.
*
* The points can be set from a variety of formats:
*
* - An array of Point objects: `[new Phaser.Point(x1, y1), ...]`
* - An array of objects with public x/y properties: `[obj1, obj2, ...]`
* - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`
* - As separate Point arguments: `setTo(new Phaser.Point(x1, y1), ...)`
* - As separate objects with public x/y properties arguments: `setTo(obj1, obj2, ...)`
* - As separate arguments representing point coordinates: `setTo(x1,y1, x2,y2, ...)`
*/
class Polygon {
/**
* Creates a new Polygon.
*
* The points can be set from a variety of formats:
*
* - An array of Point objects: `[new Phaser.Point(x1, y1), ...]`
* - An array of objects with public x/y properties: `[obj1, obj2, ...]`
* - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`
* - As separate Point arguments: `setTo(new Phaser.Point(x1, y1), ...)`
* - As separate objects with public x/y properties arguments: `setTo(obj1, obj2, ...)`
* - As separate arguments representing point coordinates: `setTo(x1,y1, x2,y2, ...)`
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param points The points to set.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(points: Phaser.Point[]|number[]);
/**
* Creates a new Polygon.
*
* The points can be set from a variety of formats:
*
* - An array of Point objects: `[new Phaser.Point(x1, y1), ...]`
* - An array of objects with public x/y properties: `[obj1, obj2, ...]`
* - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`
* - As separate Point arguments: `setTo(new Phaser.Point(x1, y1), ...)`
* - As separate objects with public x/y properties arguments: `setTo(obj1, obj2, ...)`
* - As separate arguments representing point coordinates: `setTo(x1,y1, x2,y2, ...)`
*
* @param points The points to set.
*/
constructor(...points: Phaser.Point[]);
/**
* Creates a new Polygon.
*
* The points can be set from a variety of formats:
*
* - An array of Point objects: `[new Phaser.Point(x1, y1), ...]`
* - An array of objects with public x/y properties: `[obj1, obj2, ...]`
* - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`
* - As separate Point arguments: `setTo(new Phaser.Point(x1, y1), ...)`
* - As separate objects with public x/y properties arguments: `setTo(obj1, obj2, ...)`
* - As separate arguments representing point coordinates: `setTo(x1,y1, x2,y2, ...)`
*
* @param points The points to set.
*/
constructor(...points: number[]);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The area of this Polygon.
*/
area: number;
/**
* Sets and modifies the points of this polygon.
*
* See {@link Phaser.Polygon#setTo setTo} for the different kinds of arrays formats that can be assigned. The array of vertex points.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
points: number[]|Phaser.Point[];
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The base object type.
*/
type: number;
/**
* Creates a copy of the given Polygon.
* This is a deep clone, the resulting copy contains new Phaser.Point objects
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param output The polygon to update. If not specified a new polygon will be created. - Default: (new Polygon)
* @return The cloned (`output`) polygon object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clone(output: Phaser.Polygon): Phaser.Polygon;
/**
* Checks whether the x and y coordinates are contained within this polygon.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The X value of the coordinate to test.
* @param y The Y value of the coordinate to test.
* @return True if the coordinates are within this polygon, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
contains(x: number, y: number): boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Flattens this Polygon so the points are a sequence of numbers. Any Point objects found are removed and replaced with two numbers.
* @return This Polygon object
*/
flatten(): Phaser.Polygon;
/**
* Sets this Polygon to the given points.
*
* The points can be set from a variety of formats:
*
* - An array of Point objects: `[new Phaser.Point(x1, y1), ...]`
* - An array of objects with public x/y properties: `[obj1, obj2, ...]`
* - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`
* - As separate Point arguments: `setTo(new Phaser.Point(x1, y1), ...)`
* - As separate objects with public x/y properties arguments: `setTo(obj1, obj2, ...)`
* - As separate arguments representing point coordinates: `setTo(x1,y1, x2,y2, ...)`
*
* `setTo` may also be called without any arguments to remove all points.
*
* @param points The points to set.
* @return This Polygon object
*/
setTo(points: Phaser.Point[]|number[]): void;
/**
* Sets this Polygon to the given points.
*
* The points can be set from a variety of formats:
*
* - An array of Point objects: `[new Phaser.Point(x1, y1), ...]`
* - An array of objects with public x/y properties: `[obj1, obj2, ...]`
* - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`
* - As separate Point arguments: `setTo(new Phaser.Point(x1, y1), ...)`
* - As separate objects with public x/y properties arguments: `setTo(obj1, obj2, ...)`
* - As separate arguments representing point coordinates: `setTo(x1,y1, x2,y2, ...)`
*
* `setTo` may also be called without any arguments to remove all points.
*
* @param points The points to set.
* @return This Polygon object
*/
setTo(...points: Phaser.Point[]): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Sets this Polygon to the given points.
*
* The points can be set from a variety of formats:
*
* - An array of Point objects: `[new Phaser.Point(x1, y1), ...]`
* - An array of objects with public x/y properties: `[obj1, obj2, ...]`
* - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`
* - As separate Point arguments: `setTo(new Phaser.Point(x1, y1), ...)`
* - As separate objects with public x/y properties arguments: `setTo(obj1, obj2, ...)`
* - As separate arguments representing point coordinates: `setTo(x1,y1, x2,y2, ...)`
*
* `setTo` may also be called without any arguments to remove all points.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param points The points to set.
* @return This Polygon object
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setTo(...points: number[]): void;
/**
* Export the points as an array of flat numbers, following the sequence [ x,y, x,y, x,y ]
*
* @param output The array to append the points to. If not specified a new array will be created.
* @return The flattened array.
*/
toNumberArray(output?: number[]): number[];
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
/**
* A QuadTree implementation. The original code was a conversion of the Java code posted to GameDevTuts.
* However I've tweaked it massively to add node indexing, removed lots of temp. var creation and significantly increased performance as a result.
* Original version at https://github.com/timohausmann/quadtree-js/
*/
class QuadTree {
/**
* A QuadTree implementation. The original code was a conversion of the Java code posted to GameDevTuts.
* However I've tweaked it massively to add node indexing, removed lots of temp. var creation and significantly increased performance as a result.
* Original version at https://github.com/timohausmann/quadtree-js/
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The top left coordinate of the quadtree.
* @param y The top left coordinate of the quadtree.
* @param width The width of the quadtree in pixels.
* @param height The height of the quadtree in pixels.
* @param maxObjects The maximum number of objects per node. - Default: 10
* @param maxLevels The maximum number of levels to iterate to. - Default: 4
* @param level Which level is this? - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(x: number, y: number, width: number, height: number, maxObject?: number, maxLevels?: number, level?: number);
/**
* Object that contains the quadtree bounds.
*/
bounds: {
x: number;
y: number;
width: number;
height: number;
subWidth: number;
subHeight: number;
right: number;
bottom: number;
};
/**
* The current level.
*/
level: number;
/**
* The maximum number of objects per node.
* Default: 10
*/
maxObjects: number;
/**
* The maximum number of levels to break down to.
* Default: 4
*/
maxLevels: number;
/**
* Array of quadtree children.
*/
objects: any[];
/**
* Array of associated child nodes.
*/
nodes: any[];
/**
* Clear the quadtree.
*/
clear(): void;
/**
* Determine which node the object belongs to.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rect The bounds in which to check.
* @return index - Index of the subnode (0-3), or -1 if rect cannot completely fit within a subnode and is part of the parent node.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getIndex(rect: any): number;
/**
* Insert the object into the node. If the node exceeds the capacity, it will split and add all objects to their corresponding subnodes.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param body The Body object to insert into the quadtree. Can be any object so long as it exposes x, y, right and bottom properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
insert(body: any): void;
/**
* Populates this quadtree with the children of the given Group. In order to be added the child must exist and have a body property.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param group The Group to add to the quadtree.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
populate(group: Phaser.Group): void;
/**
* Handler for the populate method.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The Sprite to check.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
populateHandler(sprite: Phaser.Sprite): void;
/**
* Resets the QuadTree.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The top left coordinate of the quadtree.
* @param y The top left coordinate of the quadtree.
* @param width The width of the quadtree in pixels.
* @param height The height of the quadtree in pixels.
* @param maxObjects The maximum number of objects per node. - Default: 10
* @param maxLevels The maximum number of levels to iterate to. - Default: 4
* @param level Which level is this? - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(x: number, y: number, width: number, height: number, maxObject?: number, maxLevels?: number, level?: number): void;
/**
* Return all objects that could collide with the given Sprite or Rectangle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The source object to check the QuadTree against. Either a Sprite or Rectangle.
* @return - Array with all detected objects.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
retrieve(source: any): any[];
/**
* Split the node into 4 subnodes
*/
split(): void;
}
/**
* An extremely useful repeatable random data generator.
*
* Based on Nonsense by Josh Faul https://github.com/jocafa/Nonsense.
*
* The random number genererator is based on the Alea PRNG, but is modified.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* - https://github.com/coverslide/node-alea
* - https://github.com/nquinlan/better-random-numbers-for-javascript-mirror
* - http://baagoe.org/en/wiki/Better_random_numbers_for_javascript (original, perm. 404)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class RandomDataGenerator {
/**
* An extremely useful repeatable random data generator.
*
* Based on Nonsense by Josh Faul https://github.com/jocafa/Nonsense.
*
* The random number genererator is based on the Alea PRNG, but is modified.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* - https://github.com/coverslide/node-alea
* - https://github.com/nquinlan/better-random-numbers-for-javascript-mirror
* - http://baagoe.org/en/wiki/Better_random_numbers_for_javascript (original, perm. 404)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param seeds An array of values to use as the seed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(seeds: number[]);
/**
* Returns a random angle between -180 and 180.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A random number between -180 and 180.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle(): number;
/**
* Returns a random integer between and including min and max.
* This method is an alias for RandomDataGenerator.integerInRange.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value in the range.
* @param max The maximum value in the range.
* @return A random number between min and max.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
between(min: number, max: number): number;
/**
* Returns a random real number between 0 and 1.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A random real number between 0 and 1.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
frac(): number;
/**
* Returns a random integer between 0 and 2^32.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A random integer between 0 and 2^32.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
integer(): number;
/**
* Returns a random integer between and including min and max.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value in the range.
* @param max The maximum value in the range.
* @return A random number between min and max.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
integerInRange(min: number, max: number): number;
/**
* Returns a random real number between -1 and 1.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A random real number between -1 and 1.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
normal(): number;
/**
* Returns a random member of `array`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param ary An Array to pick a random member of.
* @return A random member of the array.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pick<T>(ary: T[]): T;
/**
* Returns a random real number between 0 and 2^32.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A random real number between 0 and 2^32.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
real(): number;
/**
* Returns a random real number between min and max.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value in the range.
* @param max The maximum value in the range.
* @return A random number between min and max.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
realInRange(min: number, max: number): number;
/**
* Reset the seed of the random data generator.
*
* _Note_: the seed array is only processed up to the first `undefined` (or `null`) value, should such be present.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param seeds The array of seeds: the `toString()` of each value is used.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
sow(seeds: number[]): void;
/**
* Returns a random timestamp between min and max, or between the beginning of 2000 and the end of 2020 if min and max aren't specified.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param min The minimum value in the range.
* @param max The maximum value in the range.
* @return A random timestamp between min and max.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
timestamp(min: number, max: number): number;
/**
* Returns a valid RFC4122 version4 ID hex string from https://gist.github.com/1308368
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A valid RFC4122 version4 ID hex string
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
uuid(): number;
/**
* Returns a random member of `array`, favoring the earlier entries.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param ary An Array to pick a random member of.
* @return A random member of the array.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
weightedPick<T>(ary: T[]): T;
}
/**
* Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters.
* If you call this function without parameters, a Rectangle with x, y, width, and height properties set to 0 is created.
*/
class Rectangle {
/**
* Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters.
* If you call this function without parameters, a Rectangle with x, y, width, and height properties set to 0 is created.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the top-left corner of the Rectangle.
* @param y The y coordinate of the top-left corner of the Rectangle.
* @param width The width of the Rectangle. Should always be either zero or a positive value.
* @param height The height of the Rectangle. Should always be either zero or a positive value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(x: number, y: number, width: number, height: number);
/**
* The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.
*/
bottom: number;
bottomRight: Phaser.Point;
/**
* The x coordinate of the center of the Rectangle.
*/
centerX: number;
/**
* The y coordinate of the center of the Rectangle.
*/
centerY: number;
/**
* Determines whether or not this Rectangle object is empty. A Rectangle object is empty if its width or height is less than or equal to 0.
* If set to true then all of the Rectangle properties are set to 0. Gets or sets the Rectangles empty state.
*/
empty: boolean;
/**
* Half of the height of the Rectangle.
*/
halfHeight: number;
/**
* Half of the width of the Rectangle.
*/
halfWidth: number;
/**
* The height of the Rectangle. This value should never be set to a negative.
*/
height: number;
/**
* The x coordinate of the left of the Rectangle. Changing the left property of a Rectangle object has no effect on the y and height properties. However it does affect the width property, whereas changing the x value does not affect the width property.
*/
left: number;
/**
* The perimeter size of the Rectangle. This is the sum of all 4 sides.
*/
perimeter: number;
/**
* A random value between the left and right values (inclusive) of the Rectangle.
*/
randomX: number;
/**
* A random value between the top and bottom values (inclusive) of the Rectangle.
*/
randomY: number;
/**
* The sum of the x and width properties. Changing the right property of a Rectangle object has no effect on the x, y and height properties, however it does affect the width property.
*/
right: number;
/**
* The y coordinate of the top of the Rectangle. Changing the top property of a Rectangle object has no effect on the x and width properties.
* However it does affect the height property, whereas changing the y value does not affect the height property.
*/
top: number;
/**
* The location of the Rectangles top left corner as a Point object.
*/
topLeft: Phaser.Point;
/**
* The location of the Rectangles top right corner as a Point object. The location of the Rectangles top left corner as a Point object.
*/
topRight: Phaser.Point;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The const type of this object.
*/
type: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The volume of the Rectangle derived from width * height.
*/
volume: number;
/**
* The width of the Rectangle. This value should never be set to a negative.
*/
width: number;
/**
* The x coordinate of the top-left corner of the Rectangle.
*/
x: number;
/**
* The y coordinate of the top-left corner of the Rectangle.
*/
y: number;
/**
* Calculates the Axis Aligned Bounding Box (or aabb) from an array of points.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param points The array of one or more points.
* @param out Optional Rectangle to store the value in, if not supplied a new Rectangle object will be created.
* @return The new Rectangle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static aabb(points: Phaser.Point[], out?: Phaser.Rectangle): Phaser.Rectangle;
/**
* Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param output Optional Rectangle object. If given the values will be set into the object, otherwise a brand new Rectangle object will be created and returned.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static clone(a: Phaser.Rectangle, output?: Phaser.Rectangle): Phaser.Rectangle;
/**
* Determines whether the specified coordinates are contained within the region defined by this Rectangle object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the point to test.
* @param y The y coordinate of the point to test.
* @return A value of true if the Rectangle object contains the specified point; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static contains(a: Phaser.Rectangle, x: number, y: number): boolean;
/**
* Determines whether the specified point is contained within the rectangular region defined by this Rectangle object. This method is similar to the Rectangle.contains() method, except that it takes a Point object as a parameter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The Rectangle object.
* @param point The point object being checked. Can be Point or any object with .x and .y values.
* @return A value of true if the Rectangle object contains the specified point; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static containsPoint(a: Phaser.Rectangle, point: Phaser.Point): boolean;
/**
* Determines whether the specified coordinates are contained within the region defined by the given raw values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rx The x coordinate of the top left of the area.
* @param ry The y coordinate of the top left of the area.
* @param rw The width of the area.
* @param rh The height of the area.
* @param x The x coordinate of the point to test.
* @param y The y coordinate of the point to test.
* @return A value of true if the Rectangle object contains the specified point; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static containsRaw(rx: number, ry: number, rw: number, rh: number, x: number, y: number): boolean;
/**
* Determines whether the first Rectangle object is fully contained within the second Rectangle object.
* A Rectangle object is said to contain another if the second Rectangle object falls entirely within the boundaries of the first.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @return A value of true if the Rectangle object contains the specified point; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static containsRect(a: Phaser.Rectangle, b: Phaser.Rectangle): boolean;
/**
* Determines whether the two Rectangles are equal.
* This method compares the x, y, width and height properties of each Rectangle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @return A value of true if the two Rectangles have exactly the same values for the x, y, width and height properties; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static equals(a: Phaser.Rectangle, b: Phaser.Rectangle): boolean;
/**
* Increases the size of the Rectangle object by the specified amounts. The center point of the Rectangle object stays the same, and its size increases to the left and right by the dx value, and to the top and the bottom by the dy value.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dx The amount to be added to the left side of the Rectangle.
* @param dy The amount to be added to the bottom side of the Rectangle.
* @return This Rectangle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static inflate(a: Phaser.Rectangle, dx: number, dy: number): Phaser.Rectangle;
/**
* Increases the size of the Rectangle object. This method is similar to the Rectangle.inflate() method except it takes a Point object as a parameter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param a The Rectangle object.
* @param point The x property of this Point object is used to increase the horizontal dimension of the Rectangle object. The y property is used to increase the vertical dimension of the Rectangle object.
* @return The Rectangle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static inflatePoint(a: Phaser.Rectangle, point: Phaser.Point): Phaser.Rectangle;
/**
* If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object. If the Rectangles do not intersect, this method returns an empty Rectangle object with its properties set to 0.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @param out Optional Rectangle object. If given the intersection values will be set into this object, otherwise a brand new Rectangle object will be created and returned.
* @return A Rectangle object that equals the area of intersection. If the Rectangles do not intersect, this method returns an empty Rectangle object; that is, a Rectangle with its x, y, width, and height properties set to 0.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static intersection(a: Phaser.Rectangle, b: Phaser.Rectangle, out?: Phaser.Rectangle): Phaser.Rectangle;
/**
* Determines whether this Rectangle and another given Rectangle intersect with each other.
* This method checks the x, y, width, and height properties of the two Rectangles.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @return A value of true if the specified object intersects with this Rectangle object; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static intersects(a: Phaser.Rectangle, b: Phaser.Rectangle): boolean;
/**
* Determines whether the coordinates given intersects (overlaps) with this Rectangle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param left The x coordinate of the left of the area.
* @param right The right coordinate of the area.
* @param top The y coordinate of the area.
* @param bottom The bottom coordinate of the area.
* @param tolerance A tolerance value to allow for an intersection test with padding, default to 0
* @return A value of true if the specified object intersects with the Rectangle; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static intersectsRaw(left: number, right: number, top: number, bottom: number, tolerance: number): boolean;
/**
* The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param output Optional Point object. If given the values will be set into the object, otherwise a brand new Point object will be created and returned.
* @return The size of the Rectangle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static size(a: Phaser.Rectangle, output?: Phaser.Point): Phaser.Point;
/**
* Adds two Rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two Rectangles.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @param out Optional Rectangle object. If given the new values will be set into this object, otherwise a brand new Rectangle object will be created and returned.
* @return A Rectangle object that is the union of the two Rectangles.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static union(a: Phaser.Rectangle, b: Phaser.Rectangle, out?: Phaser.Rectangle): Phaser.Rectangle;
/**
* Centers this Rectangle so that the center coordinates match the given x and y values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate to place the center of the Rectangle at.
* @param y The y coordinate to place the center of the Rectangle at.
* @return This Rectangle object
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
centerOn(x: number, y: number): Phaser.Rectangle;
/**
* Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param output Optional Rectangle object. If given the values will be set into the object, otherwise a brand new Rectangle object will be created and returned.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
clone(output: Phaser.Rectangle): Phaser.Rectangle;
/**
* Determines whether the specified coordinates are contained within the region defined by this Rectangle object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the point to test.
* @param y The y coordinate of the point to test.
* @return A value of true if the Rectangle object contains the specified point; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
contains(x: number, y: number): boolean;
/**
* Determines whether the first Rectangle object is fully contained within the second Rectangle object.
* A Rectangle object is said to contain another if the second Rectangle object falls entirely within the boundaries of the first.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @return A value of true if the Rectangle object contains the specified point; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
containsRect(b: Phaser.Rectangle): boolean;
/**
* Copies the x, y, width and height properties from any given object to this Rectangle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The object to copy from.
* @return This Rectangle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copyFrom(source: any): Phaser.Rectangle;
/**
* Copies the x, y, width and height properties from this Rectangle to any given object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The object to copy to.
* @return This object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copyTo(dest: any): any;
/**
* Determines whether the two Rectangles are equal.
* This method compares the x, y, width and height properties of each Rectangle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @return A value of true if the two Rectangles have exactly the same values for the x, y, width and height properties; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
equals(b: Phaser.Rectangle): boolean;
/**
* Runs Math.floor() on both the x and y values of this Rectangle.
*/
floor(): void;
/**
* Runs Math.floor() on the x, y, width and height values of this Rectangle.
*/
floorAll(): void;
/**
* Increases the size of the Rectangle object by the specified amounts. The center point of the Rectangle object stays the same, and its size increases to the left and right by the dx value, and to the top and the bottom by the dy value.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dx The amount to be added to the left side of the Rectangle.
* @param dy The amount to be added to the bottom side of the Rectangle.
* @return This Rectangle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inflate(dx: number, dy: number): Phaser.Rectangle;
/**
* If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object. If the Rectangles do not intersect, this method returns an empty Rectangle object with its properties set to 0.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @param out Optional Rectangle object. If given the intersection values will be set into this object, otherwise a brand new Rectangle object will be created and returned.
* @return A Rectangle object that equals the area of intersection. If the Rectangles do not intersect, this method returns an empty Rectangle object; that is, a Rectangle with its x, y, width, and height properties set to 0.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
intersection(b: Phaser.Rectangle, out: Phaser.Rectangle): Phaser.Rectangle;
/**
* Determines whether this Rectangle and another given Rectangle intersect with each other.
* This method checks the x, y, width, and height properties of the two Rectangles.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @return A value of true if the specified object intersects with this Rectangle object; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
intersects(b: Phaser.Rectangle, tolerance: number): boolean;
/**
* Determines whether the coordinates given intersects (overlaps) with this Rectangle.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param left The x coordinate of the left of the area.
* @param right The right coordinate of the area.
* @param top The y coordinate of the area.
* @param bottom The bottom coordinate of the area.
* @param tolerance A tolerance value to allow for an intersection test with padding, default to 0
* @return A value of true if the specified object intersects with the Rectangle; otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
intersectsRaw(left: number, right: number, top: number, bottom: number, tolerance: number): boolean;
/**
* Adjusts the location of the Rectangle object, as determined by its top-left corner, by the specified amounts.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param dx Moves the x value of the Rectangle object by this amount.
* @param dy Moves the y value of the Rectangle object by this amount.
* @return This Rectangle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
offset(dx: number, dy: number): Phaser.Rectangle;
/**
* Adjusts the location of the Rectangle object using a Point object as a parameter. This method is similar to the Rectangle.offset() method, except that it takes a Point object as a parameter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param point A Point object to use to offset this Rectangle object.
* @return This Rectangle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
offsetPoint(point: Phaser.Point): Phaser.Rectangle;
/**
* Sets the members of Rectangle to the specified values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate of the top-left corner of the Rectangle.
* @param y The y coordinate of the top-left corner of the Rectangle.
* @param width The width of the Rectangle. Should always be either zero or a positive value.
* @param height The height of the Rectangle. Should always be either zero or a positive value.
* @return This Rectangle object
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setTo(x: number, y: number, width: number, height: number): Phaser.Rectangle;
/**
* Scales the width and height of this Rectangle by the given amounts.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The amount to scale the width of the Rectangle by. A value of 0.5 would reduce by half, a value of 2 would double the width, etc.
* @param y The amount to scale the height of the Rectangle by. A value of 0.5 would reduce by half, a value of 2 would double the height, etc.
* @return This Rectangle object
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
scale(x: number, y?: number): Phaser.Rectangle;
/**
* The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param output Optional Point object. If given the values will be set into the object, otherwise a brand new Point object will be created and returned.
* @return The size of the Rectangle object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
size(output?: Phaser.Point): Phaser.Point;
/**
* Returns a string representation of this object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return A string representation of the instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
toString(): string;
/**
* Adds two Rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two Rectangles.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param b The second Rectangle object.
* @param out Optional Rectangle object. If given the new values will be set into this object, otherwise a brand new Rectangle object will be created and returned.
* @return A Rectangle object that is the union of the two Rectangles.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
union(b: Phaser.Rectangle, out?: Phaser.Rectangle): Phaser.Rectangle;
}
/**
* A RenderTexture is a special texture that allows any displayObject to be rendered to it. It allows you to take many complex objects and
* render them down into a single quad (on WebGL) which can then be used to texture other display objects with. A way of generating textures at run-time.
*/
class RenderTexture extends PIXI.RenderTexture {
/**
* A RenderTexture is a special texture that allows any displayObject to be rendered to it. It allows you to take many complex objects and
* render them down into a single quad (on WebGL) which can then be used to texture other display objects with. A way of generating textures at run-time.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Current game instance.
* @param key Internal Phaser reference key for the render texture.
* @param width The width of the render texture. - Default: 100
* @param height The height of the render texture. - Default: 100
* @param key The key of the RenderTexture in the Cache, if stored there. - Default: ''
* @param scaleMode One of the Phaser.scaleModes consts. - Default: Phaser.scaleModes.DEFAULT
* @param resolution The resolution of the texture being generated. - Default: 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, width?: number, height?: number, key?: string, scaleMode?: number, resolution?: number);
/**
* This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,
* irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)
*/
crop: PIXI.Rectangle;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* The key of the RenderTexture in the Cache, if stored there.
*/
key: string;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* The matrix that is applied when display objects are rendered to this RenderTexture.
*/
matrix: PIXI.Matrix;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Base Phaser object type.
*/
type: number;
/**
* This function will draw the display object to the texture.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to render to this texture.
* @param position A Point object containing the position to render the display object at.
* @param clear If true the texture will be cleared before the display object is drawn.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
render(displayObject: PIXI.DisplayObject, position: Phaser.Point, clear?: boolean): void;
/**
* This function will draw the display object to the texture.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to render to this texture.
* @param x The x position to render the object at.
* @param y The y position to render the object at.
* @param clear If true the texture will be cleared before the display object is drawn.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
renderXY(displayObject: PIXI.DisplayObject, x: number, y: number, clear?: boolean): void;
}
/**
* Abstracts away the use of RAF or setTimeOut for the core game update loop.
*/
class RequestAnimationFrame {
/**
* Abstracts away the use of RAF or setTimeOut for the core game update loop.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param forceSetTimeOut Tell Phaser to use setTimeOut even if raf is available. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, forceSetTimeOut?: boolean);
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Tell Phaser to use setTimeOut even if raf is available.
*/
forceSetTimeOut: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The currently running game.
*/
game: Phaser.Game;
/**
* true if RequestAnimationFrame is running, otherwise false.
* Default: false
*/
isRunning: boolean;
/**
* Is the browser using requestAnimationFrame?
*/
isRAF(): boolean;
/**
* Is the browser using setTimeout?
*/
isSetTimeOut(): boolean;
/**
* Starts the requestAnimationFrame running or setTimeout if unavailable in browser
*/
start(): boolean;
/**
* Stops the requestAnimationFrame from running.
*/
stop(): void;
/**
* The update method for the requestAnimationFrame
*/
updateRAF(rafTime: number): void;
/**
* The update method for the setTimeout.
*/
updateSetTimeout(): void;
}
/**
* A Retro Font is similar to a BitmapFont, in that it uses a texture to render the text. However unlike a BitmapFont every character in a RetroFont
* is the same size. This makes it similar to a sprite sheet. You typically find font sheets like this from old 8/16-bit games and demos.
*/
class RetroFont extends Phaser.RenderTexture {
/**
* A Retro Font is similar to a BitmapFont, in that it uses a texture to render the text. However unlike a BitmapFont every character in a RetroFont
* is the same size. This makes it similar to a sprite sheet. You typically find font sheets like this from old 8/16-bit games and demos.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Current game instance.
* @param key The font set graphic set as stored in the Game.Cache.
* @param characterWidth The width of each character in the font set.
* @param characterHeight The height of each character in the font set.
* @param chars The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.
* @param charsPerRow The number of characters per row in the font set. If not given charsPerRow will be the image width / characterWidth.
* @param xSpacing If the characters in the font set have horizontal spacing between them set the required amount here. - Default: 0
* @param ySpacing If the characters in the font set have vertical spacing between them set the required amount here. - Default: 0
* @param xOffset If the font set doesn't start at the top left of the given image, specify the X coordinate offset here. - Default: 0
* @param yOffset If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, key: string, characterWidth: number, characterHeight: number, chars: string, charsPerRow?: number, xSpacing?: number, ySpacing?: number, xOffset?: number, yOffset?: number);
/**
* Align each line of multi-line text in the center.
*/
static ALIGN_CENTER: string;
/**
* Align each line of multi-line text to the left.
*/
static ALIGN_LEFT: string;
/**
* Align each line of multi-line text to the right.
*/
static ALIGN_RIGHT: string;
/**
* Text Set 1 = !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
*/
static TEXT_SET1: string;
/**
* Text Set 2 = !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ
*/
static TEXT_SET2: string;
/**
* Text Set 3 = ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789
*/
static TEXT_SET3: string;
/**
* Text Set 4 = ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789
*/
static TEXT_SET4: string;
/**
* Text Set 5 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,/() '!?-*:0123456789
*/
static TEXT_SET5: string;
/**
* Text Set 6 = ABCDEFGHIJKLMNOPQRSTUVWXYZ!?:;0123456789"(),-.'
*/
static TEXT_SET6: string;
/**
* Text Set 7 = AGMSY+:4BHNTZ!;5CIOU.?06DJPV,(17EKQW")28FLRX-'39
*/
static TEXT_SET7: string;
/**
* Text Set 8 = 0123456789 .ABCDEFGHIJKLMNOPQRSTUVWXYZ
*/
static TEXT_SET8: string;
/**
* Text Set 9 = ABCDEFGHIJKLMNOPQRSTUVWXYZ()-0123456789.:,'"?!
*/
static TEXT_SET9: string;
/**
* Text Set 10 = ABCDEFGHIJKLMNOPQRSTUVWXYZ
*/
static TEXT_SET10: string;
/**
* Text Set 11 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,"-+!?()':;0123456789
*/
static TEXT_SET11: string;
/**
* Alignment of the text when multiLine = true or a fixedWidth is set. Set to RetroFont.ALIGN_LEFT (default), RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.
*/
align: string;
/**
* Automatically convert any text to upper case. Lots of old bitmap fonts only contain upper-case characters, so the default is true.
* Default: true
*/
autoUpperCase: boolean;
/**
* The height of each character in the font set.
*/
characterHeight: number;
/**
* The number of characters per row in the font set.
*/
characterPerRow: number;
/**
* If the characters in the font set have horizontal spacing between them set the required amount here.
*/
characterSpacingX: number;
/**
* If the characters in the font set have vertical spacing between them set the required amount here.
*/
characterSpacingY: number;
/**
* The width of each character in the font set.
*/
characterWidth: number;
/**
* Adds horizontal spacing between each character of the font, in pixels.
* Default: 0
*/
customSpacingX: number;
/**
* Adds vertical spacing between each line of multi-line text, set in pixels.
* Default: 0
*/
customSpacingY: number;
/**
* If you need this RetroFont image to have a fixed width you can set the width in this value.
* If text is wider than the width specified it will be cropped off.
*/
fixedWidth: number;
/**
* A reference to the image stored in the Game.Cache that contains the font.
*/
fontSet: Image;
/**
* The FrameData representing this Retro Font.
*/
frameData: Phaser.FrameData;
/**
* If set to true all carriage-returns in text will form new lines (see align). If false the font will only contain one single line of text (the default)
* Default: false
*/
multiLine: boolean;
/**
* If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.
*/
offsetX: number;
/**
* If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.
*/
offsetY: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Set this value to update the text in this sprite. Carriage returns are automatically stripped out if multiLine is false. Text is converted to upper case if autoUpperCase is true.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
smoothed: string;
/**
* The image that is stamped to the RenderTexture for each character in the font.
*/
stamp: Phaser.Image;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Set this value to update the text in this sprite. Carriage returns are automatically stripped out if multiLine is false. Text is converted to upper case if autoUpperCase is true.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
text: string;
/**
* Updates the texture with the new text.
*/
buildRetroFontText(): void;
/**
* Works out the longest line of text in _text and returns its length
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The length of the longest line of text.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getLongestLine(): number;
/**
* Internal function that takes a single line of text (2nd parameter) and pastes it into the BitmapData at the given coordinates.
* Used by getLine and getMultiLine
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param line The single line of text to paste.
* @param x The x coordinate.
* @param y The y coordinate.
* @param customSpacingX Custom X spacing.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pasteLine(line: string, x: number, y: number, customSpacingX: number): void;
/**
* Internal helper function that removes all unsupported characters from the _text String, leaving only characters contained in the font set.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param stripCR Should it strip carriage returns as well? - Default: true
* @return A clean version of the string.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeUnsupportedCharacters(stripCR?: boolean): string;
/**
* If you need this RetroFont to have a fixed width and custom alignment you can set the width here.
* If text is wider than the width specified it will be cropped off.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width Width in pixels of this RetroFont. Set to zero to disable and re-enable automatic resizing.
* @param lineAlignment Align the text within this width. Set to RetroFont.ALIGN_LEFT (default), RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER. - Default: 'left'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setFixedWidth(width: number, lineAlignment?: string): void;
/**
* A helper function that quickly sets lots of variables at once, and then updates the text.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param content The text of this sprite.
* @param multiLine Set to true if you want to support carriage-returns in the text and create a multi-line sprite instead of a single line. - Default: false
* @param characterSpacing To add horizontal spacing between each character specify the amount in pixels. - Default: 0
* @param lineSpacing To add vertical spacing between each line of text, set the amount in pixels. - Default: 0
* @param lineAlignment Align each line of multi-line text. Set to RetroFont.ALIGN_LEFT, RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER. - Default: 'left'
* @param allowLowerCase Lots of bitmap font sets only include upper-case characters, if yours needs to support lower case then set this to true. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setText(content: string, multiLine?: boolean, characterSpacing?: number, lineSpacing?: number, lineAlignment?: string, allowLowerCase?: boolean): void;
/**
* Updates the x and/or y offset that the font is rendered from. This updates all of the texture frames, so be careful how often it is called.
* Note that the values given for the x and y properties are either ADDED to or SUBTRACTED from (if negative) the existing offsetX/Y values of the characters.
* So if the current offsetY is 8 and you want it to start rendering from y16 you would call updateOffset(0, 8) to add 8 to the current y offset.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param xOffset If the font set doesn't start at the top left of the given image, specify the X coordinate offset here. - Default: 0
* @param yOffset If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateOffset(x?: number, y?: number): void;
}
/**
* A Rope is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so.
* Please note that Ropes, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling.
* Example usage: https://github.com/codevinsky/phaser-rope-demo/blob/master/dist/demo.js
*/
class Rope extends PIXI.Rope {
/**
* A Rope is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so.
* Please note that Ropes, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling.
* Example usage: https://github.com/codevinsky/phaser-rope-demo/blob/master/dist/demo.js
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param x The x coordinate (in world space) to position the Rope at.
* @param y The y coordinate (in world space) to position the Rope at.
* @param key This is the image or texture used by the Rope during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If this Rope is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
* @param points An array of {Phaser.Point}.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, x: number, y: number, key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture, frame?: string|number, points?: Phaser.Point[]);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angle property is the rotation of the Game Object in *degrees* from its original orientation.
*
* Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
*
* Values outside this range are added to or subtracted from 360 to obtain a value within the range.
* For example, the statement player.angle = 450 is the same as player.angle = 90.
*
* If you wish to work in radians instead of degrees you can use the property `rotation` instead.
* Working in radians is slightly faster as it doesn't have to perform any calculations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance.
* Through it you can create, play, pause and stop animations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
animations: AnimationManager;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object with `autoCull` set to true will check its bounds against the World Camera every frame.
* If it is not intersecting the Camera bounds at any point then it has its `renderable` property set to `false`.
* This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.
*
* This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
* or you have tested performance and find it acceptable.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: false
*/
autoCull: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* `body` is the Game Objects physics body. Once a Game Object is enabled for physics you access all associated
* properties and methods via it.
*
* By default Game Objects won't add themselves to any physics system and their `body` property will be `null`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* To enable this Game Object for physics you need to call `game.physics.enable(object, system)` where `object` is this object
* and `system` is the Physics system you are using. If none is given it defaults to `Phaser.Physics.Arcade`.
*
* You can alternatively call `game.physics.arcade.enable(object)`, or add this Game Object to a physics enabled Group.
*
* Important: Enabling a Game Object for P2 or Ninja physics will automatically set its `anchor` property to 0.5,
* so the physics body is centered on the Game Object.
*
* If you need a different result then adjust or re-create the Body shape offsets manually or reset the anchor after enabling physics.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: null
*/
body: any;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if `fixedToCamera` is true.
*
* The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraOffset: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If this is set to `true` the Game Object checks if it is within the World bounds each frame.
*
* When it is no longer intersecting the world bounds it dispatches the `onOutOfBounds` event.
*
* If it was *previously* out of bounds but is now intersecting the world bounds again it dispatches the `onEnterBounds` event.
*
* It also optionally kills the Game Object if `outOfBoundsKill` is `true`.
*
* When `checkWorldBounds` is enabled it forces the Game Object to calculate its full bounds every frame.
*
* This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
* or you have tested performance and find it acceptable.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: false
*/
checkWorldBounds: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* As a Game Object runs through its destroy method this flag is set to true,
* and can be checked in any sub-systems or plugins it is being destroyed from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroyPhase: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Controls if this Game Object is processed by the core game loop.
* If this Game Object has a physics body it also controls if its physics body is updated or not.
* When `exists` is set to `false` it will remove its physics body from the physics world if it has one.
* It also toggles the `visible` property to false as well.
*
* Setting `exists` to true will add its physics body back in to the physics world, if it has one.
* It will also set the `visible` property to `true`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
exists: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
* Game Object, or any of its components.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
events: Phaser.Events;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object that is "fixed" to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.
*
* The values are adjusted at the rendering stage, overriding the Game Objects actual world position.
*
* The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
* the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
* regardless where in the world the camera is.
*
* The offsets are stored in the `cameraOffset` property.
*
* Note that the `cameraOffset` values are in addition to any parent of this Game Object on the display list.
*
* Be careful not to set `fixedToCamera` on Game Objects which are in Groups that already have `fixedToCamera` enabled on them.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fixedToCamera: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Gets or sets the current frame index of the texture being used to render this Game Object.
*
* To change the frame set `frame` to the index of the new frame in the sprite sheet you wish this Game Object to use,
* for example: `player.frame = 4`.
*
* If the frame index given doesn't exist it will revert to the first frame found in the texture.
*
* If you are using a texture atlas then you should use the `frameName` property instead.
*
* If you wish to fully replace the texture being used see `loadTexture`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
frame: string|number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Gets or sets the current frame name of the texture being used to render this Game Object.
*
* To change the frame set `frameName` to the name of the new frame in the texture atlas you wish this Game Object to use,
* for example: `player.frameName = "idle"`.
*
* If the frame name given doesn't exist it will revert to the first frame found in the texture and throw a console warning.
*
* If you are using a sprite sheet then you should use the `frame` property instead.
*
* If you wish to fully replace the texture being used see `loadTexture`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
frameName: string;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* A Game Object is considered `fresh` if it has just been created or reset and is yet to receive a renderer transform update.
* This property is mostly used internally by the physics systems, but is exposed for the use of plugins.
*/
fresh: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The Input Handler for this Game Object.
*
* By default it is disabled. If you wish this Game Object to process input events you should enable it with: `inputEnabled = true`.
*
* After you have done this, this property will be a reference to the Phaser InputHandler.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
input: Phaser.InputHandler;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* By default a Game Object won't process any input events. By setting `inputEnabled` to true a Phaser.InputHandler is created
* for this Game Object and it will then start to process click / touch events and more.
*
* You can then access the Input Handler via `this.input`.
*
* Note that Input related events are dispatched from `this.events`, i.e.: `events.onInputDown`.
*
* If you set this property to false it will stop the Input Handler from processing any more input events.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inputEnabled: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The key of the image or texture used by this Game Object during rendering.
* If it is a string it's the string used to retrieve the texture from the Phaser.Cache.
* It can also be an instance of a RenderTexture, BitmapData or PIXI.Texture.
* If a Game Object is created without a key it is automatically assigned the key `__default` which is a 32x32 transparent PNG stored within the Cache.
* If a Game Object is given a key which doesn't exist in the Cache it is re-assigned the key `__missing` which is a 32x32 PNG of a green box with a line through it.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A user defined name given to this Game Object.
* This value isn't ever used internally by Phaser, it is meant as a game level property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
name: string;
points: Phaser.Point[];
/**
* The coordinate of the object relative to the local coordinates of the parent.
*/
position: Phaser.Point;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The position the Game Object was located in the previous frame.
*/
previousPosition: Phaser.Point;
/**
* The rotation the Game Object was in set to in the previous frame. Value is in radians.
*/
previousRotation: number;
/**
* The render order ID is used internally by the renderer and Input Manager and should not be modified.
* This property is mostly used internally by the renderers, but is exposed for the use of plugins.
*/
renderOrderID: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The segments that make up the rope body as an array of Phaser.Rectangles
*/
segments: Phaser.Rectangle[];
/**
* The const type of this object.
*/
type: number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* A Rope will call it's updateAnimation function on each update loop if it has one Set to a function if you'd like the rope to animate during the update phase. Set to false or null to remove it.
*/
updateAnimation: Function;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The world coordinates of this Game Object in pixels.
* Depending on where in the display list this Game Object is placed this value can differ from `position`,
* which contains the x/y coordinates relative to the Game Objects parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
world: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The position of the displayObject on the x axis relative to the local coordinates of the parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
x: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The position of the displayObject on the y axis relative to the local coordinates of the parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
y: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The z depth of this Game Object within its parent Group.
* No two objects in a Group can have the same z value.
* This value is adjusted automatically whenever the Group hierarchy changes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
z: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Destroy this DisplayObject.
* Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(destroyChildren?: boolean): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the `frame` or `frameName` properties instead.
*
* You should only use `loadTexture` if you want to replace the base texture entirely.
*
* Calling this method causes a WebGL texture update, so use sparingly or in low-intensity portions of your game, or if you know the new texture is already on the GPU.
*
* @param key This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
* @param frame If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
* @param stopAnimation If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
loadTexture(key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture, frame?: string|number): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Plays an Animation.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The animation should have previously been created via `animations.add`.
*
* If the animation is already playing calling this again won't do anything.
* If you need to reset an already running animation do so directly on the Animation object itself or via `AnimationManager.stop`.
*
* @param name The name of the animation to be played, e.g. "fire", "walk", "jump". Must have been previously created via 'AnimationManager.add'.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frameRate The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used. - Default: null
* @param loop Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used. - Default: false
* @param killOnComplete If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed. - Default: false
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @return A reference to playing Animation.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
play(): void;
/**
* Automatically called by World.preUpdate.
*/
preUpdate(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Internal method called by the World postUpdate cycle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
postUpdate(): void;
/**
* Resets the Rope. This places the Rope at the given x/y world coordinates, resets the tilePosition and then
* sets alive, exists, visible and renderable all to true. Also resets the outOfBounds state.
* If the Rope has a physics body that too is reset.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate (in world space) to position the Sprite at.
* @param y The y coordinate (in world space) to position the Sprite at.
* @return (Phaser.Rope) This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(x: number, y: number): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Sets the texture frame the Game Object uses for rendering.
*
* This is primarily an internal method used by `loadTexture`, but is exposed for the use of plugins and custom classes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param frame The Frame to be used by the texture.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setFrame(frame: Phaser.Frame): void;
/**
* Override and use this function in your own custom objects to handle any update requirements you may have.
*/
update(): void;
}
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
class RoundedRectangle extends PIXI.RoundedRectangle {
x: number;
y: number;
width: number;
height: number;
radius: number;
type: number;
clone(): RoundedRectangle;
contains(x: number, y: number): boolean;
}
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A Signal is an event dispatch mechansim than supports broadcasting to multiple listeners.
*
* Event listeners are uniquely identified by the listener/callback function and the context.
*/
class Signal {
/**
* Is the Signal active? Only active signal will broadcast dispatched events.
*
* Setting this property during a dispatch will only affect the next dispatch. To stop the propagation of a signal from a listener use {@link Phaser.Signal#halt halt}.
* Default: true
*/
active: boolean;
boundDispatch: Function;
/**
* Memorize the previously dispatched event?
*
* If an event has been memorized it is automatically dispatched when a new listener is added with {@link Phaser.Signal#add add} or {@link Phaser.Signal#addOnce addOnce}.
* Use {@link Phaser.Signal#forget forget} to clear any currently memorized event.
*/
memorize: boolean;
/**
* Add an event listener.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param listener The function to call when this Signal is dispatched.
* @param listenerContext The context under which the listener will be executed (i.e. the object that should represent the `this` variable).
* @param priority The priority level of the event listener. Listeners with higher priority will be executed before listeners with lower priority. Listeners with same priority level will be executed at the same order as they were added (default = 0)
* @return An Object representing the binding between the Signal and listener.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(listener: Function, listenerContext?: any, priority?: number): Phaser.SignalBinding;
/**
* Add a one-time listener - the listener is automatically removed after the first execution.
*
* If there is as {@link Phaser.Signal#memorize memorized} event then it will be dispatched and
* the listener will be removed immediately.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param listener The function to call when this Signal is dispatched.
* @param listenerContext The context under which the listener will be executed (i.e. the object that should represent the `this` variable).
* @param priority The priority level of the event listener. Listeners with higher priority will be executed before listeners with lower priority. Listeners with same priority level will be executed at the same order as they were added (default = 0)
* @return An Object representing the binding between the Signal and listener.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addOnce(listener: Function, listenerContext?: any, priority?: number): Phaser.SignalBinding;
/**
* Dispatch / broadcast the event to all listeners.
*
* To create an instance-bound dispatch for this Signal, use {@link Phaser.Signal#boundDispatch boundDispatch}.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param params Parameters that should be passed to each handler.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
dispatch(...params: any[]): void;
/**
* Dispose the signal - no more events can be dispatched.
*
* This removes all event listeners and clears references to external objects.
* Calling methods on a disposed objects results in undefined behavior.
*/
dispose(): void;
/**
* Forget the currently {@link Phaser.Signal#memorize memorized} event, if any.
*/
forget(): void;
/**
* Gets the total number of listeners attached to this Signal.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Number of listeners attached to the Signal.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getNumListeners(): number;
/**
* Stop propagation of the event, blocking the dispatch to next listener on the queue.
*
* This should be called only during event dispatch as calling it before/after dispatch won't affect other broadcast.
* See {@link Phaser.Signal#active active} to enable/disable the signal entirely.
*/
halt(): void;
/**
* Check if a specific listener is attached.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param listener Signal handler function.
* @param context Context on which listener will be executed (object that should represent the `this` variable inside listener function).
* @return If Signal has the specified listener.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
has(listener: Function, context?: any): boolean;
/**
* Remove a single event listener.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param listener Handler function that should be removed.
* @param context Execution context (since you can add the same handler multiple times if executing in a different context). - Default: null
* @return Listener handler function.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(listener: Function, context?: any): Function;
/**
* Remove all event listeners.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context If specified only listeners for the given context will be removed. - Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeAll(context?: any): void;
/**
* A string representation of the object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return String representation of the object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
toString(): string;
/**
*
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param listener Signal handler function.
* @param fnName Function name.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
validateListener(listener: Function, fnName: string): void;
}
/**
* Object that represents a binding between a Signal and a listener function.
* This is an internal constructor and shouldn't be created directly.
* Inspired by Joa Ebert AS3 SignalBinding and Robert Penner's Slot classes.
*/
class SignalBinding {
/**
* Object that represents a binding between a Signal and a listener function.
* This is an internal constructor and shouldn't be created directly.
* Inspired by Joa Ebert AS3 SignalBinding and Robert Penner's Slot classes.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param signal Reference to Signal object that listener is currently bound to.
* @param listener Handler function bound to the signal.
* @param isOnce If binding should be executed just once.
* @param listenerContext Context on which listener will be executed (object that should represent the `this` variable inside listener function). - Default: null
* @param priority The priority level of the event listener. (default = 0).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(signal: Phaser.Signal, listener: Function, isOnce: boolean, listenerContext?: any, priority?: number);
/**
* If binding is active and should be executed.
* Default: true
*/
active: boolean;
/**
* The number of times the handler function has been called.
*/
callCount: number;
/**
* Context on which listener will be executed (object that should represent the `this` variable inside listener function).
*/
context: any;
/**
* Default parameters passed to listener during `Signal.dispatch` and `SignalBinding.execute` (curried parameters).
* Default: null
*/
params: any[];
/**
* Call listener passing arbitrary parameters.
* If binding was added using `Signal.addOnce()` it will be automatically removed from signal dispatch queue, this method is used internally for the signal dispatch.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param paramsArr Array of parameters that should be passed to the listener.
* @return Value returned by the listener.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
execute(paramsArr?: any[]): void;
/**
* Detach binding from signal.
* alias to: @see mySignal.remove(myBinding.getListener());
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Handler function bound to the signal or `null` if binding was previously detached.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
detach(): Function;
/**
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if binding is still bound to the signal and has a listener.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isBound(): boolean;
/**
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return If SignalBinding will only be executed once.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isOnce(): boolean;
/**
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Handler function bound to the signal.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getListener(): Function;
/**
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Signal that listener is currently bound to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getSignal(): Phaser.Signal;
/**
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return String representation of the object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
toString(): string;
}
/**
* A single Phaser Gamepad
*/
class SinglePad {
/**
* A single Phaser Gamepad
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Current game instance.
* @param padParent The parent Phaser.Gamepad object (all gamepads reside under this)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, padParent: any);
/**
* The context under which the callbacks are run.
*/
callbackContext: any;
/**
* Whether or not this particular gamepad is connected or not.
*/
connected: boolean;
/**
* Dead zone for axis feedback - within this value you won't trigger updates.
*/
deadZone: number;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* The gamepad index as per browsers data
*/
index: number;
/**
* This callback is invoked every time an axis is changed.
*/
onAxisCallback: Function;
/**
* This callback is invoked every time this gamepad is connected
*/
onConnectCallback: Function;
/**
* This callback is invoked every time this gamepad is disconnected
*/
onDisconnectCallback: Function;
/**
* This callback is invoked every time a button is pressed down.
*/
onDownCallback: Function;
/**
* This callback is invoked every time a button is changed to a value where value > 0 and value < 1.
*/
onFloatCallback: Function;
/**
* This callback is invoked every time a gamepad button is released.
*/
onUpCallback: Function;
/**
* Returns value of requested axis.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param axisCode The index of the axis to check
* @return Axis value if available otherwise false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
axis(axisCode: number): number;
/**
* Add callbacks to this Gamepad to handle connect / disconnect / button down / button up / axis change / float value buttons.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context under which the callbacks are run.
* @param callbacks Object that takes six different callbak methods:
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* onConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addCallbacks(context: any, callbacks: any): void;
/**
* Returns the value of a gamepad button. Intended mainly for cases when you have floating button values, for example
* analog trigger buttons on the XBOX 360 controller.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode The buttonCode of the button to check.
* @return Button value if available otherwise null. Be careful as this can incorrectly evaluate to 0.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
buttonValue(buttonCode: number): number;
/**
* Gamepad connect function, should be called by Phaser.Gamepad.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rawPad The raw gamepad object
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
connect(rawPad: any): void;
/**
* Destroys this object and associated callback references.
*/
destroy(): void;
/**
* Gamepad disconnect function, should be called by Phaser.Gamepad.
*/
disconnect(): void;
/**
* Gets a GamepadButton object from this controller to be stored and referenced locally.
* The GamepadButton object can then be polled, have events attached to it, etc.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode The buttonCode of the button, i.e. Phaser.Gamepad.BUTTON_0, Phaser.Gamepad.XBOX360_A, etc.
* @return The GamepadButton object which you can store locally and reference directly.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getButton(buttonCode: number): Phaser.GamepadButton;
/**
* Returns true if the button is pressed down.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode The buttonCode of the button to check.
* @return True if the button is pressed down.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isDown(buttonCode: number): boolean;
/**
* Returns true if the button is not currently pressed.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode The buttonCode of the button to check.
* @return True if the button is not currently pressed down.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isUp(buttonCode: number): boolean;
/**
* Returns the "just pressed" state of a button from this gamepad. Just pressed is considered true if the button was pressed down within the duration given (default 250ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode The buttonCode of the button to check for.
* @param duration The duration below which the button is considered as being just pressed. - Default: 250
* @return True if the button is just pressed otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justPressed(buttonCode: number, duration?: number): boolean;
/**
* Returns the "just released" state of a button from this gamepad. Just released is considered as being true if the button was released within the duration given (default 250ms).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode The buttonCode of the button to check for.
* @param duration The duration below which the button is considered as being just released. - Default: 250
* @return True if the button is just released otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
justReleased(buttonCode: number, duration?: number): boolean;
/**
* Main update function called by Phaser.Gamepad.
*/
pollStatus(): void;
/**
* Handles changes in axis.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param axisState State of the relevant axis
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processAxisChange(axisState: any): void;
/**
* Handles button down press.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode Which buttonCode of this button
* @param value Button value
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processButtonDown(buttonCode: number, value: any): void;
/**
* Handles buttons with floating values (like analog buttons that acts almost like an axis but still registers like a button)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode Which buttonCode of this button
* @param value Button value (will range somewhere between 0 and 1, but not specifically 0 or 1.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processButtonFloat(buttonCode: number, value: any): void;
/**
* Handles button release.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param buttonCode Which buttonCode of this button
* @param value Button value
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
processButtonUp(buttonCode: number, value: any): void;
/**
* Reset all buttons/axes of this gamepad.
*/
reset(): void;
}
/**
* The Sound class constructor.
*/
class Sound {
/**
* The Sound class constructor.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Reference to the current game instance.
* @param key Asset key for the sound.
* @param volume Default value for the volume, between 0 and 1. - Default: 1
* @param loop Whether or not the sound will loop. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, key: string, volume?: number, loop?: boolean, connect?: boolean);
/**
* Boolean indicating whether the sound should start automatically.
*/
autoplay: boolean;
/**
* This will allow you to have multiple instances of this Sound playing at once. This is only useful when running under Web Audio, and we recommend you implement a local pooling system to not flood the sound channels.
* Default: false
*/
allowMultiple: boolean;
/**
* Reference to the AudioContext instance.
*/
context: any;
/**
* The string ID of the currently playing marker, if any.
*/
currentMarker: string;
/**
* The current time the sound is at.
*/
currentTime: number;
/**
* Destroys this sound and all associated events and removes it from the SoundManager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param remove If true this Sound is automatically removed from the SoundManager. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(remove?: boolean): void;
/**
* The duration of the current sound marker in seconds.
*/
duration: number;
/**
* The duration of the current sound marker in ms.
*/
durationMS: number;
/**
* If defined this Sound won't connect to the SoundManager master gain node, but will instead connect to externalNode.
*/
externalNode: any;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The tween that fades the audio, set via Sound.fadeIn and Sound.fadeOut.
*/
fadeTween: Phaser.Tween;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* The gain node in a Web Audio system.
*/
gainNode: any;
/**
* Returns true if the sound file has decoded.
*/
isDecoded: boolean;
/**
* Returns true if the sound file is still decoding.
*/
isDecoding: boolean;
/**
* true if the sound is currently playing, otherwise false.
* Default: false
*/
isPlaying: boolean;
/**
* Asset key for the sound.
*/
key: string;
/**
* Whether or not the sound or current sound marker will loop.
*/
loop: boolean;
/**
* The sound markers.
*/
markers: any;
/**
* The master gain node in a Web Audio system.
*/
masterGainNode: any;
/**
* Gets or sets the muted state of this sound.
*/
mute: boolean;
/**
* Name of the sound.
*/
name: string;
/**
* The onDecoded event is dispatched when the sound has finished decoding (typically for mp3 files)
*/
onDecoded: Phaser.Signal;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
onEndedHandler: () => void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The onFadeComplete event is dispatched when this sound finishes fading either in or out.
*/
onFadeComplete: Phaser.Signal;
/**
* The onLoop event is dispatched when this sound loops during playback.
*/
onLoop: Phaser.Signal;
/**
* The onMarkerComplete event is dispatched when a marker within this sound completes playback.
*/
onMarkerComplete: Phaser.Signal;
/**
* The onMouse event is dispatched when this sound is muted.
*/
onMute: Phaser.Signal;
/**
* The onPause event is dispatched when this sound is paused.
*/
onPause: Phaser.Signal;
/**
* The onPlay event is dispatched each time this sound is played.
*/
onPlay: Phaser.Signal;
/**
* The onResume event is dispatched when this sound is resumed from a paused state.
*/
onResume: Phaser.Signal;
/**
* The onStop event is dispatched when this sound stops playback.
*/
onStop: Phaser.Signal;
/**
* if true when you play this sound it will always start from the beginning.
* Default: false
*/
override: boolean;
/**
* true if the sound is paused, otherwise false.
* Default: false
*/
paused: boolean;
/**
* The position the sound had reached when it was paused.
*/
pausedPosition: number;
/**
* The game time at which the sound was paused.
*/
pausedTime: number;
/**
* true if the sound file is pending playback
*/
pendingPlayback: boolean;
/**
* The position of the current sound marker.
*/
position: number;
/**
* The time the Sound starts at (typically 0 unless starting from a marker)
* Default: 0
*/
startTime: number;
/**
* The time the sound stopped.
*/
stopTime: number;
/**
* The total duration of the sound in seconds.
*/
totalDuration: number;
/**
* true if the sound is being played via the Audio tag.
*/
usingAudioTag: boolean;
/**
* true if this sound is being played with Web Audio.
*/
usingWebAudio: boolean;
/**
* The sound or sound marker volume. A value between 0 (silence) and 1 (full volume).
*/
volume: number;
/**
* Adds a marker into the current Sound. A marker is represented by a unique key and a start time and duration.
* This allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name A unique name for this marker, i.e. 'explosion', 'gunshot', etc.
* @param start The start point of this marker in the audio file, given in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.
* @param duration The duration of the marker in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.
* @param volume The volume the sound will play back at, between 0 (silent) and 1 (full volume). - Default: 1
* @param loop Sets if the sound will loop or not. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addMarker(name: string, start: number, duration: number, volume?: number, loop?: boolean): void;
/**
* Destroys this sound and all associated events and removes it from the SoundManager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param remove If true this Sound is automatically removed from the SoundManager. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(): void;
/**
* Starts this sound playing (or restarts it if already doing so) and sets the volume to zero.
* Then increases the volume from 0 to 1 over the duration specified.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* At the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,
* and the final volume (1) as the second parameter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration The time in milliseconds over which the Sound should fade in. - Default: 1000
* @param loop Should the Sound be set to loop? Note that this doesn't cause the fade to repeat. - Default: false
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param marker The marker to start at; defaults to the current (last played) marker. To start playing from the beginning specify specify a marker of `''`. - Default: (current marker)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
fadeIn(duration?: number, loop?: boolean, marker?: string): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Decreases the volume of this Sound from its current value to 0 over the duration specified.
* At the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,
* and the final volume (0) as the second parameter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration The time in milliseconds over which the Sound should fade out. - Default: 1000
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fadeOut(duration?: number): void;
/**
* Fades the volume of this Sound from its current value to the given volume over the duration specified.
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* At the end of the fade Sound.onFadeComplete is dispatched with this Sound object as the first parameter,
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* and the final volume (volume) as the second parameter.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration The time in milliseconds during which the Sound should fade out. - Default: 1000
* @param volume The volume which the Sound should fade to. This is a value between 0 and 1.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fadeTo(duration?: number, volume?: number): void;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Loops this entire sound. If you need to loop a section of it then use Sound.play and the marker and loop parameters.
*
* @param volume Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified). - Default: 1
* @return This sound instance.
*/
loopFull(volume?: number): Phaser.Sound;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Pauses the sound.
*/
pause(): void;
/**
* Play this sound, or a marked section of it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param marker If you want to play a marker then give the key here, otherwise leave blank to play the full sound. - Default: ''
* @param position The starting position to play the sound from - this is ignored if you provide a marker. - Default: 0
* @param volume Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified). - Default: 1
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param loop Loop when finished playing? If not using a marker / audio sprite the looping will be done via the WebAudio loop property, otherwise it's time based. - Default: false
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param forceRestart If the sound is already playing you can set forceRestart to restart it from the beginning. - Default: true
* @return This sound instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
play(marker?: string, position?: number, volume?: number, loop?: boolean, forceRestart?: boolean): Phaser.Sound;
/**
* Removes a marker from the sound.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The key of the marker to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeMarker(name: string): void;
/**
* Restart the sound, or a marked section of it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param marker If you want to play a marker then give the key here, otherwise leave blank to play the full sound. - Default: ''
* @param position The starting position to play the sound from - this is ignored if you provide a marker. - Default: 0
* @param volume Volume of the sound you want to play. - Default: 1
* @param loop Loop when it finished playing? - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
restart(marker: string, position: number, volume?: number, loop?: boolean): void;
/**
* Resumes the sound.
*/
resume(): void;
/**
* Called automatically when this sound is unlocked.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The Phaser.Cache key of the sound file to check for decoding.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
soundHasUnlocked(key: string): void;
/**
* Stop playing this sound.
*/
stop(): void;
/**
* Called automatically by Phaser.SoundManager.
*/
update(): void;
}
/**
* The Sound Manager is responsible for playing back audio via either the Legacy HTML Audio tag or via Web Audio if the browser supports it.
* Note: On Firefox 25+ on Linux if you have media.gstreamer disabled in about:config then it cannot play back mp3 or m4a files.
* The audio file type and the encoding of those files are extremely important. Not all browsers can play all audio formats.
* There is a good guide to what's supported here: http://hpr.dogphilosophy.net/test/
*
* If you are reloading a Phaser Game on a page that never properly refreshes (such as in an AngularJS project) then you will quickly run out
* of AudioContext nodes. If this is the case create a global var called PhaserGlobal on the window object before creating the game. The active
* AudioContext will then be saved to window.PhaserGlobal.audioContext when the Phaser game is destroyed, and re-used when it starts again.
*/
class SoundManager {
/**
* The Sound Manager is responsible for playing back audio via either the Legacy HTML Audio tag or via Web Audio if the browser supports it.
* Note: On Firefox 25+ on Linux if you have media.gstreamer disabled in about:config then it cannot play back mp3 or m4a files.
* The audio file type and the encoding of those files are extremely important. Not all browsers can play all audio formats.
* There is a good guide to what's supported here: http://hpr.dogphilosophy.net/test/
*
* If you are reloading a Phaser Game on a page that never properly refreshes (such as in an AngularJS project) then you will quickly run out
* of AudioContext nodes. If this is the case create a global var called PhaserGlobal on the window object before creating the game. The active
* AudioContext will then be saved to window.PhaserGlobal.audioContext when the Phaser game is destroyed, and re-used when it starts again.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Reference to the current game instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* The number of audio channels to use in playback.
* Default: 32
*/
channels: number;
/**
* Used in conjunction with Sound.externalNode this allows you to stop a Sound node being connected to the SoundManager master gain node.
* Default: true
*/
connectToMaster: boolean;
/**
* The AudioContext being used for playback.
* Default: null
*/
context: any;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* Gets or sets the muted state of the SoundManager. This effects all sounds in the game.
*/
mute: boolean;
/**
* Has audio been disabled via the PhaserGlobal object? Useful if you need to use a 3rd party audio library instead.
* Default: false
*/
noAudio: boolean;
/**
* The event dispatched when a sound decodes (typically only for mp3 files)
*/
onSoundDecode: Phaser.Signal;
/**
* true if the audio system is currently locked awaiting a touch event.
* Default: false
*/
touchLocked: boolean;
/**
* true if the sound is being played via the Audio tag.
*/
usingAudioTag: boolean;
/**
* true if this sound is being played with Web Audio.
*/
usingWebAudio: boolean;
/**
* Gets or sets the global volume of the SoundManager, a value between 0 and 1.
*/
volume: number;
/**
* Adds a new Sound into the SoundManager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the sound.
* @param volume Default value for the volume. - Default: 1
* @param loop Whether or not the sound will loop. - Default: false
* @param connect Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio. - Default: true
* @return The new sound instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(key: string, volume?: number, loop?: boolean, connect?: boolean): Phaser.Sound;
/**
* Adds a new AudioSprite into the SoundManager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the sound.
* @return The new AudioSprite instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addSprite(key: string): Phaser.AudioSprite;
/**
* Initialises the sound manager.
*/
boot(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Decode a sound by its asset key.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Assets key of the sound to be decoded.
* @param sound Its buffer will be set to decoded data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
decode(key: string, sound?: Phaser.Sound): void;
/**
* Stops all the sounds in the game, then destroys them and finally clears up any callbacks.
*/
destroy(): void;
/**
* Pauses all the sounds in the game.
*/
pauseAll(): void;
/**
* Adds a new Sound into the SoundManager and starts it playing.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key Asset key for the sound.
* @param volume Default value for the volume. - Default: 1
* @param loop Whether or not the sound will loop. - Default: false
* @return The new sound instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
play(key: string, volume?: number, loop?: boolean): Phaser.Sound;
/**
* Removes a Sound from the SoundManager. The removed Sound is destroyed before removal.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sound The sound object to remove.
* @return True if the sound was removed successfully, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(sound: Phaser.Sound): boolean;
/**
* Removes all Sounds from the SoundManager that have an asset key matching the given value.
* The removed Sounds are destroyed before removal.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The key to match when removing sound objects.
* @return The number of matching sound objects that were removed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeByKey(key: string): number;
/**
* Resumes every sound in the game.
*/
resumeAll(): void;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* This method allows you to give the SoundManager a list of Sound files, or keys, and a callback.
* Once all of the Sound files have finished decoding the callback will be invoked.
* The amount of time spent decoding depends on the codec used and file size.
* If all of the files given have already decoded the callback is triggered immediately.
*
* @param files An array containing either Phaser.Sound objects or their key strings as found in the Phaser.Cache.
* @param callback The callback which will be invoked once all files have finished decoding.
* @param callbackContext The context in which the callback will run.
*/
setDecodedCallback(files: string[]|Phaser.Sound[], callback: Function, callbackContext: any): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Stops all the sounds in the game.
*/
stopAll(): void;
/**
* Enables the audio, usually after the first touch.
*/
unlock(): void;
/**
* Updates every sound in the game.
*/
update(): void;
}
/**
* Sprites are the lifeblood of your game, used for nearly everything visual.
*
* At its most basic a Sprite consists of a set of coordinates and a texture that is rendered to the canvas.
* They also contain additional properties allowing for physics motion (via Sprite.body), input handling (via Sprite.input),
* events (via Sprite.events), animation (via Sprite.animations), camera culling and more. Please see the Examples for use cases.
*/
class Sprite extends PIXI.Sprite {
/**
* Sprites are the lifeblood of your game, used for nearly everything visual.
*
* At its most basic a Sprite consists of a set of coordinates and a texture that is rendered to the canvas.
* They also contain additional properties allowing for physics motion (via Sprite.body), input handling (via Sprite.input),
* events (via Sprite.events), animation (via Sprite.animations), camera culling and more. Please see the Examples for use cases.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param x The x coordinate (in world space) to position the Sprite at.
* @param y The y coordinate (in world space) to position the Sprite at.
* @param key This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, x: number, y: number, key?: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture, frame?: string|number);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A useful flag to control if the Game Object is alive or dead.
*
* This is set automatically by the Health components `damage` method should the object run out of health.
* Or you can toggle it via your game code.
*
* This property is mostly just provided to be used by your game - it doesn't effect rendering or logic updates.
* However you can use `Group.getFirstAlive` in conjunction with this property for fast object pooling and recycling.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: true
*/
alive: boolean;
/**
* The anchor sets the origin point of the texture.
* The default is 0,0 this means the texture's origin is the top left
* Setting than anchor to 0.5,0.5 means the textures origin is centered
* Setting the anchor to 1,1 would mean the textures origin points will be the bottom right corner
*/
anchor: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angle property is the rotation of the Game Object in *degrees* from its original orientation.
*
* Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
*
* Values outside this range are added to or subtracted from 360 to obtain a value within the range.
* For example, the statement player.angle = 450 is the same as player.angle = 90.
*
* If you wish to work in radians instead of degrees you can use the property `rotation` instead.
* Working in radians is slightly faster as it doesn't have to perform any calculations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance.
* Through it you can create, play, pause and stop animations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
animations: Phaser.AnimationManager;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object with `autoCull` set to true will check its bounds against the World Camera every frame.
* If it is not intersecting the Camera bounds at any point then it has its `renderable` property set to `false`.
* This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.
*
* This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
* or you have tested performance and find it acceptable.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: false
*/
autoCull: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* `body` is the Game Objects physics body. Once a Game Object is enabled for physics you access all associated
* properties and methods via it.
*
* By default Game Objects won't add themselves to any physics system and their `body` property will be `null`.
*
* To enable this Game Object for physics you need to call `game.physics.enable(object, system)` where `object` is this object
* and `system` is the Physics system you are using. If none is given it defaults to `Phaser.Physics.Arcade`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* You can alternatively call `game.physics.arcade.enable(object)`, or add this Game Object to a physics enabled Group.
*
* Important: Enabling a Game Object for P2 or Ninja physics will automatically set its `anchor` property to 0.5,
* so the physics body is centered on the Game Object.
*
* If you need a different result then adjust or re-create the Body shape offsets manually or reset the anchor after enabling physics.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: null
*/
body: any;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The sum of the y and height properties.
* This is the same as `y + height - offsetY`.
*/
bottom: number;
/**
* The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if `fixedToCamera` is true.
*
* The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraOffset: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If this is set to `true` the Game Object checks if it is within the World bounds each frame.
*
* When it is no longer intersecting the world bounds it dispatches the `onOutOfBounds` event.
*
* If it was *previously* out of bounds but is now intersecting the world bounds again it dispatches the `onEnterBounds` event.
*
* It also optionally kills the Game Object if `outOfBoundsKill` is `true`.
*
* When `checkWorldBounds` is enabled it forces the Game Object to calculate its full bounds every frame.
*
* This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
* or you have tested performance and find it acceptable.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: false
*/
checkWorldBounds: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The Rectangle used to crop the texture this Game Object uses.
* Set this property via `crop`.
* If you modify this property directly you must call `updateCrop` in order to have the change take effect.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: null
*/
cropRect: Phaser.Rectangle;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A debug flag designed for use with `Game.enableStep`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: false
*/
debug: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Returns the delta x value. The difference between world.x now and in the previous frame.
*
* The value will be positive if the Game Object has moved to the right or negative if to the left.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaX: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Returns the delta y value. The difference between world.y now and in the previous frame.
*
* The value will be positive if the Game Object has moved down or negative if up.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaY: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Returns the delta z value. The difference between rotation now and in the previous frame. The delta value.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
deltaZ: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* As a Game Object runs through its destroy method this flag is set to true,
* and can be checked in any sub-systems or plugins it is being destroyed from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroyPhase: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
* Game Object, or any of its components.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
events: Phaser.Events;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Controls if this Game Object is processed by the core game loop.
* If this Game Object has a physics body it also controls if its physics body is updated or not.
* When `exists` is set to `false` it will remove its physics body from the physics world if it has one.
* It also toggles the `visible` property to false as well.
*
* Setting `exists` to true will add its physics body back in to the physics world, if it has one.
* It will also set the `visible` property to `true`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
exists: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object that is "fixed" to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.
*
* The values are adjusted at the rendering stage, overriding the Game Objects actual world position.
*
* The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
* the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
* regardless where in the world the camera is.
*
* The offsets are stored in the `cameraOffset` property.
*
* Note that the `cameraOffset` values are in addition to any parent of this Game Object on the display list.
*
* Be careful not to set `fixedToCamera` on Game Objects which are in Groups that already have `fixedToCamera` enabled on them.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fixedToCamera: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Gets or sets the current frame index of the texture being used to render this Game Object.
*
* To change the frame set `frame` to the index of the new frame in the sprite sheet you wish this Game Object to use,
* for example: `player.frame = 4`.
*
* If the frame index given doesn't exist it will revert to the first frame found in the texture.
*
* If you are using a texture atlas then you should use the `frameName` property instead.
*
* If you wish to fully replace the texture being used see `loadTexture`.
*/
frame: string|number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Gets or sets the current frame name of the texture being used to render this Game Object.
*
* To change the frame set `frameName` to the name of the new frame in the texture atlas you wish this Game Object to use,
* for example: `player.frameName = "idle"`.
*
* If the frame name given doesn't exist it will revert to the first frame found in the texture and throw a console warning.
*
* If you are using a sprite sheet then you should use the `frame` property instead.
*
* If you wish to fully replace the texture being used see `loadTexture`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
frameName: string;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object is considered `fresh` if it has just been created or reset and is yet to receive a renderer transform update.
* This property is mostly used internally by the physics systems, but is exposed for the use of plugins.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
fresh: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A reference to the currently running Game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
game: Phaser.Game;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
health: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Checks if the Game Objects bounds intersect with the Game Camera bounds.
* Returns `true` if they do, otherwise `false` if fully outside of the Cameras bounds.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inCamera: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The Input Handler for this Game Object.
*
* By default it is disabled. If you wish this Game Object to process input events you should enable it with: `inputEnabled = true`.
*
* After you have done this, this property will be a reference to the Phaser InputHandler.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
input: Phaser.InputHandler;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* By default a Game Object won't process any input events. By setting `inputEnabled` to true a Phaser.InputHandler is created
* for this Game Object and it will then start to process click / touch events and more.
*
* You can then access the Input Handler via `this.input`.
*
* Note that Input related events are dispatched from `this.events`, i.e.: `events.onInputDown`.
*
* If you set this property to false it will stop the Input Handler from processing any more input events.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inputEnabled: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Checks if the Game Objects bounds are within, or intersect at any point with the Game World bounds.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inWorld: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The key of the image or texture used by this Game Object during rendering.
* If it is a string it's the string used to retrieve the texture from the Phaser.Cache.
* It can also be an instance of a RenderTexture, BitmapData or PIXI.Texture.
* If a Game Object is created without a key it is automatically assigned the key `__default` which is a 32x32 transparent PNG stored within the Cache.
* If a Game Object is given a key which doesn't exist in the Cache it is re-assigned the key `__missing` which is a 32x32 PNG of a green box with a line through it.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture;
/**
* The left coordinate of the Game Object.
* This is the same as `x - offsetX`.
*/
left: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The lifespan allows you to give a Game Object a lifespan in milliseconds.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Once the Game Object is 'born' you can set this to a positive value.
*
* It is automatically decremented by the millisecond equivalent of `game.time.physicsElapsed` each frame.
* When it reaches zero it will call the `kill` method.
*
* Very handy for particles, bullets, collectibles, or any other short-lived entity.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: 0
*/
lifespan: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A user defined name given to this Game Object.
* This value isn't ever used internally by Phaser, it is meant as a game level property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
name: string;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The amount the Game Object is visually offset from its x coordinate.
* This is the same as `width * anchor.x`.
* It will only be > 0 if anchor.x is not equal to zero.
*/
offsetX: number;
/**
* The amount the Game Object is visually offset from its y coordinate.
* This is the same as `height * anchor.y`.
* It will only be > 0 if anchor.y is not equal to zero.
*/
offsetY: number;
/**
* If this and the `checkWorldBounds` property are both set to `true` then the `kill` method is called as soon as `inWorld` returns false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: false
*/
outOfBoundsKill: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The position the Game Object was located in the previous frame.
*/
previousPosition: Phaser.Point;
/**
* The rotation the Game Object was in set to in the previous frame. Value is in radians.
*/
previousRotation: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The coordinate of the object relative to the local coordinates of the parent.
*/
position: Phaser.Point;
physicsEnabled: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The const physics body type of this object.
*/
physicsType: number;
/**
* The render order ID is used internally by the renderer and Input Manager and should not be modified.
* This property is mostly used internally by the renderers, but is exposed for the use of plugins.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
renderOrderID: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The right coordinate of the Game Object.
* This is the same as `x + width - offsetX`.
*/
right: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The scale factor of the object.
*/
scale: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The minimum scale this Game Object will scale down to.
*
* It allows you to prevent a parent from scaling this Game Object lower than the given value.
*
* Set it to `null` to remove the limit.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
scaleMin: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The maximum scale this Game Object will scale up to.
*
* It allows you to prevent a parent from scaling this Game Object higher than the given value.
*
* Set it to `null` to remove the limit.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
scaleMax: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Enable or disable texture smoothing for this Game Object.
*
* It only takes effect if the Game Object is using an image based texture.
*
* Smoothing is enabled by default.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
smoothed: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The y coordinate of the Game Object.
* This is the same as `y - offsetY`.
*/
top: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The const type of this object.
*/
type: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The world coordinates of this Game Object in pixels.
* Depending on where in the display list this Game Object is placed this value can differ from `position`,
* which contains the x/y coordinates relative to the Game Objects parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
world: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The position of the displayObject on the x axis relative to the local coordinates of the parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
x: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The position of the displayObject on the y axis relative to the local coordinates of the parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
y: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The z depth of this Game Object within its parent Group.
* No two objects in a Group can have the same z value.
* This value is adjusted automatically whenever the Group hierarchy changes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
z: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Brings this Game Object to the top of its parents display list.
* Visually this means it will render over the top of any old child in the same Group.
*
* If this Game Object hasn't been added to a custom Group then this method will bring it to the top of the Game World,
* because the World is the root Group from which all Game Objects descend.
* @return This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
bringToTop(): Phaser.Sprite;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Crop allows you to crop the texture being used to display this Game Object.
* Setting a crop rectangle modifies the core texture frame. The Game Object width and height properties will be adjusted accordingly.
*
* Cropping takes place from the top-left and can be modified in real-time either by providing an updated rectangle object to this method,
* or by modifying `cropRect` property directly and then calling `updateCrop`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The rectangle object given to this method can be either a `Phaser.Rectangle` or any other object
* so long as it has public `x`, `y`, `width`, `height`, `right` and `bottom` properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A reference to the rectangle is stored in `cropRect` unless the `copy` parameter is `true`,
* in which case the values are duplicated to a local object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rect The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param copy If false `cropRect` will be stored as a reference to the given rect. If true it will copy the rect values into a local Phaser Rectangle object stored in cropRect. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
crop(rect: Phaser.Rectangle, copy: boolean): void;
damage(amount: number): Phaser.Sprite;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Destroy this DisplayObject.
* Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(destroyChildren?: boolean): void;
drawPolygon(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Kills a Game Object. A killed Game Object has its `alive`, `exists` and `visible` properties all set to false.
*
* It will dispatch the `onKilled` event. You can listen to `events.onKilled` for the signal.
*
* Note that killing a Game Object is a way for you to quickly recycle it in an object pool,
* it doesn't destroy the object or free it up from memory.
*
* If you don't need this Game Object any more you should call `destroy` instead.
* @return This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
kill(): Phaser.Sprite;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache.
*
* If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the `frame` or `frameName` properties instead.
*
* You should only use `loadTexture` if you want to replace the base texture entirely.
*
* Calling this method causes a WebGL texture update, so use sparingly or in low-intensity portions of your game, or if you know the new texture is already on the GPU.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
* @param frame If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
* @param stopAnimation If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
loadTexture(key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture, frame?: string|number, stopAnimation?: boolean): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Checks to see if the bounds of this Game Object overlaps with the bounds of the given Display Object,
* which can be a Sprite, Image, TileSprite or anything that extends those such as Button or provides a `getBounds` method and result.
*
* This check ignores the `hitArea` property if set and runs a `getBounds` comparison on both objects to determine the result.
*
* Therefore it's relatively expensive to use in large quantities, i.e. with lots of Sprites at a high frequency.
* It should be fine for low-volume testing where physics isn't required.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param displayObject The display object to check against.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @return True if the bounds of this Game Object intersects at any point with the bounds of the given display object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
overlap(displayObject: PIXI.DisplayObject): boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Plays an Animation.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The animation should have previously been created via `animations.add`.
*
* If the animation is already playing calling this again won't do anything.
* If you need to reset an already running animation do so directly on the Animation object itself or via `AnimationManager.stop`.
*
* @param name The name of the animation to be played, e.g. "fire", "walk", "jump". Must have been previously created via 'AnimationManager.add'.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frameRate The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used. - Default: null
* @param loop Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used. - Default: false
* @param killOnComplete If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed. - Default: false
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @return A reference to playing Animation.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
play(name: string, frameRate?: number, loop?: boolean, killOnComplete?: boolean): Phaser.Animation;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Internal method called by the World postUpdate cycle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
postUpdate(): void;
/**
* Automatically called by World.preUpdate.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if the Sprite was rendered, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
preUpdate(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Resets the Game Object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This moves the Game Object to the given x/y world coordinates and sets `fresh`, `exists`,
* `visible` and `renderable` to true.
*
* If this Game Object has the LifeSpan component it will also set `alive` to true and `health` to the given value.
*
* If this Game Object has a Physics Body it will reset the Body.
*
* @param x The x coordinate (in world space) to position the Game Object at.
* @param y The y coordinate (in world space) to position the Game Object at.
* @param health The health to give the Game Object if it has the Health component. - Default: 1
* @return This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(x: number, y: number, health?: number): Phaser.Sprite;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Resets the texture frame dimensions that the Game Object uses for rendering.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
resetFrame(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Brings a 'dead' Game Object back to life, optionally resetting its health value in the process.
*
* A resurrected Game Object has its `alive`, `exists` and `visible` properties all set to true.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* It will dispatch the `onRevived` event. Listen to `events.onRevived` for the signal.
*
* @param health The health to give the Game Object. Only set if the GameObject has the Health component. - Default: 1
* @return This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
revive(health?: number): Phaser.Sprite;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Sets the texture frame the Game Object uses for rendering.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This is primarily an internal method used by `loadTexture`, but is exposed for the use of plugins and custom classes.
*
* @param frame The Frame to be used by the texture.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setFrame(frame: Phaser.Frame): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Sets the scaleMin and scaleMax values. These values are used to limit how far this Game Object will scale based on its parent.
*
* For example if this Game Object has a `minScale` value of 1 and its parent has a `scale` value of 0.5, the 0.5 will be ignored
* and the scale value of 1 will be used, as the parents scale is lower than the minimum scale this Game Object should adhere to.
*
* By setting these values you can carefully control how Game Objects deal with responsive scaling.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* If only one parameter is given then that value will be used for both scaleMin and scaleMax:
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* `setScaleMinMax(1)` = scaleMin.x, scaleMin.y, scaleMax.x and scaleMax.y all = 1
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* If only two parameters are given the first is set as scaleMin.x and y and the second as scaleMax.x and y:
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* `setScaleMinMax(0.5, 2)` = scaleMin.x and y = 0.5 and scaleMax.x and y = 2
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If you wish to set `scaleMin` with different values for x and y then either modify Game Object.scaleMin directly,
* or pass `null` for the `maxX` and `maxY` parameters.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Call `setScaleMinMax(null)` to clear all previously set values.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param minX The minimum horizontal scale value this Game Object can scale down to.
* @param minY The minimum vertical scale value this Game Object can scale down to.
* @param maxX The maximum horizontal scale value this Game Object can scale up to.
* @param maxY The maximum vertical scale value this Game Object can scale up to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setScaleMinMax(minX?: number, minY?: number, maxX?: number, maxY?: number): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Override this method in your own custom objects to handle any update requirements.
* It is called immediately after `preUpdate` and before `postUpdate`.
* Remember if this Game Object has any children you should call update on those too.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If you have set a crop rectangle on this Game Object via `crop` and since modified the `cropRect` property,
* or the rectangle it references, then you need to update the crop frame by calling this method.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
updateCrop(): void;
}
/**
* The SpriteBatch class is a really fast version of the DisplayObjectContainer built purely for speed, so use when you need a lot of sprites or particles.
* It's worth mentioning that by default sprite batches are used through-out the renderer, so you only really need to use a SpriteBatch if you have over
* 1000 sprites that all share the same texture (or texture atlas). It's also useful if running in Canvas mode and you have a lot of un-rotated or un-scaled
* Sprites as it skips all of the Canvas setTransform calls, which helps performance, especially on mobile devices.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
*
* Please note that any Sprite that is part of a SpriteBatch will not have its bounds updated, so will fail checks such as outOfBounds.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class SpriteBatch extends Phaser.Group {
/**
* The SpriteBatch class is a really fast version of the DisplayObjectContainer built purely for speed, so use when you need a lot of sprites or particles.
* It's worth mentioning that by default sprite batches are used through-out the renderer, so you only really need to use a SpriteBatch if you have over
* 1000 sprites that all share the same texture (or texture atlas). It's also useful if running in Canvas mode and you have a lot of un-rotated or un-scaled
* Sprites as it skips all of the Canvas setTransform calls, which helps performance, especially on mobile devices.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Please note that any Sprite that is part of a SpriteBatch will not have its bounds updated, so will fail checks such as outOfBounds.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param parent The parent Group, DisplayObject or DisplayObjectContainer that this Group will be added to. If `undefined` or `null` it will use game.world.
* @param name A name for this Group. Not used internally but useful for debugging. - Default: group
* @param addToStage If set to true this Group will be added directly to the Game.Stage instead of Game.World. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, parent: PIXI.DisplayObjectContainer, name?: string, addedToStage?: boolean);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Internal Phaser Type value.
*/
type: number;
}
/**
* The Stage controls root level display objects upon which everything is displayed.
* It also handles browser visibility handling and the pausing due to loss of focus.
*/
class Stage extends PIXI.Stage {
/**
* The Stage controls root level display objects upon which everything is displayed.
* It also handles browser visibility handling and the pausing due to loss of focus.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Game reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* Gets and sets the background color of the stage. The color can be given as a number: 0xff0000 or a hex string: '#ff0000'
*/
backgroundColor: any;
/**
* Reset each frame, keeps a count of the total number of objects updated.
*/
currentRenderOrderID: number;
/**
* By default if the browser tab loses focus the game will pause. You can stop that behaviour by setting this property to true.
* Default: false
*/
disableVisibilityChange: boolean;
/**
* If exists is true the Stage and all children are updated, otherwise it is skipped.
* Default: true
*/
exists: boolean;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* The name of this object.
* Default: _stage_root
*/
name: string;
/**
* Enable or disable texture smoothing for all objects on this Stage. Only works for bitmap/image textures. Smoothing is enabled by default. Set to true to smooth all sprites rendered on this Stage, or false to disable smoothing (great for pixel art)
*/
smoothed: boolean;
/**
* Initialises the stage and adds the event listeners.
*/
boot(): void;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Starts a page visibility event listener running, or window.onpagehide/onpageshow if not supported by the browser.
* Also listens for window.onblur and window.onfocus.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
*/
checkVisibility(): void;
/**
* Destroys the Stage and removes event listeners.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
destroy(): void;
/**
* Parses a Game configuration object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param config The configuration object to parse.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
parseConfig(config: any): void;
/**
* This is called automatically before the renderer runs and after the plugins have updated.
* In postUpdate this is where all the final physics calculatations and object positioning happens.
* The objects are processed in the order of the display list.
* The only exception to this is if the camera is following an object, in which case that is updated first.
*/
postUpdate(): void;
/**
* This is called automatically after the plugins preUpdate and before the State.update.
* Most objects have preUpdate methods and it's where initial movement and positioning is done.
*/
preUpdate(): void;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Sets the background color for the Stage.
*
* The color can be given as a hex string (`'#RRGGBB'`), a CSS color string (`'rgb(r,g,b)'`), or a numeric value (`0xRRGGBB`).
*
* An alpha channel is _not_ supported and will be ignored.
*
* @param backgroundColor The color of the background.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
setBackgroundColor(backgroundColor: number|string): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* This is called automatically after the State.update, but before particles or plugins update.
*/
update(): void;
/**
* Updates the transforms for all objects on the display list.
* This overrides the Pixi default as we don't need the interactionManager, but do need the game property check.
*/
updateTransform(): void;
/**
* This method is called when the document visibility is changed.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event Its type will be used to decide whether the game should be paused or not.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
visibilityChange(event: Event): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
interface ResizeCallback {
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
(scale: ScaleManager, parentBounds: Rectangle): any;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
/**
* The ScaleManager object handles the the scaling, resizing, and alignment of the
* Game size and the game Display canvas.
*
* The Game size is the logical size of the game; the Display canvas has size as an HTML element.
*
* The calculations of these are heavily influenced by the bounding Parent size which is the computed
* dimensions of the Display canvas's Parent container/element - the _effective CSS rules of the
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* canvas's Parent element play an important role_ in the operation of the ScaleManager.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* The Display canvas - or Game size, depending {@link Phaser.ScaleManager#scaleMode scaleMode} - is updated to best utilize the Parent size.
* When in Fullscreen mode or with {@link Phaser.ScaleManager#parentIsWindow parentIsWindow} the Parent size is that of the visual viewport (see {@link Phaser.ScaleManager#getParentBounds getParentBounds}).
*
* Parent and Display canvas containment guidelines:
*
* - Style the Parent element (of the game canvas) to control the Parent size and
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* thus the Display canvas's size and layout.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* - The Parent element's CSS styles should _effectively_ apply maximum (and minimum) bounding behavior.
*
* - The Parent element should _not_ apply a padding as this is not accounted for.
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* If a padding is required apply it to the Parent's parent or apply a margin to the Parent.
* If you need to add a border, margin or any other CSS around your game container, then use a parent element and
* apply the CSS to this instead, otherwise you'll be constantly resizing the shape of the game container.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* - The Display canvas layout CSS styles (i.e. margins, size) should not be altered/specified as
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* they may be updated by the ScaleManager.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class ScaleManager {
/**
* Create a new ScaleManager object - this is done automatically by {@link Phaser.Game}
*
* The `width` and `height` constructor parameters can either be a number which represents pixels or a string that represents a percentage: e.g. `800` (for 800 pixels) or `"80%"` for 80%.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param width The width of the game. See above.
* @param height The height of the game. See above.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, width: number|string, height: number|string);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A scale mode that stretches content to fill all available space - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
*/
static EXACT_FIT: number;
/**
* A scale mode that prevents any scaling - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
*/
static NO_SCALE: number;
/**
* A scale mode that shows the entire game while maintaining proportions - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
*/
static SHOW_ALL: number;
/**
* A scale mode that causes the Game size to change - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
*/
static RESIZE: number;
/**
* A scale mode that allows a custom scale factor - see {@link Phaser.ScaleManager#scaleMode scaleMode}.
*/
static USER_SCALE: number;
/**
* The aspect ratio of the scaled Display canvas.
*/
aspectRatio: number;
/**
* The bounds of the scaled game. The x/y will match the offset of the canvas element and the width/height the scaled width and height.
*/
bounds: Rectangle;
/**
* The DOM element that is considered the Parent bounding element, if any.
*
* This `null` if {@link Phaser.ScaleManager#parentIsWindow parentIsWindow} is true or if fullscreen mode is entered and {@link Phaser.ScaleManager#fullScreenTarget fullScreenTarget} is specified.
* It will also be null if there is no game canvas or if the game canvas has no parent.
*/
boundingParent: HTMLElement;
/**
* Various compatibility settings.
* A value of "(auto)" indicates the setting is configured based on device and runtime information.
*
* A {@link Phaser.ScaleManager#refresh refresh} may need to be performed after making changes.
*/
compatibility: {
canExpandParent: boolean;
clickTrampoline: string;
forceMinimumDocumentHeight: boolean;
noMargins: boolean;
scrollTo: Point;
supportsFullScreen: boolean;
};
/**
* Returns the current scale mode - for normal or fullscreen operation.
*
* See {@link Phaser.ScaleManager#scaleMode scaleMode} for the different modes allowed.
*/
currentScaleMode: number;
/**
* Provides access to some cross-device DOM functions.
*/
dom: Phaser.DOM;
/**
* This signal is dispatched when the browser enters an incorrect orientation, as defined by {@link Phaser.ScaleManager#forceOrientation forceOrientation}.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*/
enterIncorrectOrientation: Signal;
/**
* This signal is dispatched when the browser enters fullscreen mode, if supported.
*/
enterFullScreen: Signal;
/**
* This signal is dispatched when the browser enters landscape orientation, having been in portrait.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*/
enterLandscape: Signal;
/**
* This signal is dispatched when the browser enters portrait orientation, having been in landscape.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*/
enterPortrait: Signal;
/**
* The native browser events from Fullscreen API changes.
*/
event: any;
/**
* If true, the game should only run in a landscape orientation.
* Change with {@link Phaser.ScaleManager#forceOrientation forceOrientation}.
* Default: false
*/
forceLandscape: boolean;
/**
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* If true, the game should only run in a portrait
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Change with {@link Phaser.ScaleManager#forceOrientation forceOrientation}.
* Default: false
*/
forcePortrait: boolean;
/**
* The scaling method used by the ScaleManager when in fullscreen.
*
* See {@link Phaser.ScaleManager#scaleMode scaleMode} for the different modes allowed.
*/
fullScreenScaleMode: number;
/**
* This signal is dispatched when the browser fails to enter fullscreen mode;
* or if the device does not support fullscreen mode and {@link Phaser.ScaleManager#startFullScreen startFullScreen} is invoked.
*/
fullScreenFailed: Signal;
/**
* If specified, this is the DOM element on which the Fullscreen API enter request will be invoked.
* The target element must have the correct CSS styling and contain the Display canvas.
*
* The elements style will be modified (ie. the width and height might be set to 100%)
* but it will not be added to, removed from, or repositioned within the DOM.
* An attempt is made to restore relevant style changes when fullscreen mode is left.
*
* For pre-2.2.0 behavior set `game.scale.fullScreenTarget = game.canvas`.
* Default: null
*/
fullScreenTarget: HTMLElement;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* _EXPERIMENTAL:_ A responsive grid on which you can align game objects.
*/
grid: Phaser.FlexGrid;
/**
* Target height (in pixels) of the Display canvas.
*/
height: number;
/**
* True if {@link Phaser.ScaleManager#forceLandscape forceLandscape} or {@link Phaser.ScaleManager#forcePortrait forcePortrait} are set and do not agree with the browser orientation.
*
* This value is not updated immediately.
*/
incorrectOrientation: boolean;
/**
* Returns true if the browser is in fullscreen mode, otherwise false.
*/
isFullScreen: boolean;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Returns true if the game dimensions are landscape (width > height).
* This is especially useful to check when using the RESIZE scale mode
* but wanting to maintain game orientation on desktop browsers,
* where typically the screen orientation will always be landscape regardless of the browser viewport.
*/
isGameLandscape: boolean; //readonly
/**
* Returns true if the game dimensions are portrait (height > width).
* This is especially useful to check when using the RESIZE scale mode
* but wanting to maintain game orientation on desktop browsers,
* where typically the screen orientation will always be landscape regardless of the browser viewport.
*/
isGamePortrait: boolean; //readonly
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Returns true if the screen orientation is in portrait mode.
*/
isPortrait: boolean;
/**
* Returns true if the screen orientation is in landscape mode.
*/
isLandscape: boolean;
/**
* This signal is dispatched when the browser leaves fullscreen mode.
*/
leaveFullScreen: Signal;
/**
* This signal is dispatched when the browser leaves an incorrect orientation, as defined by {@link Phaser.ScaleManager#forceOrientation forceOrientation}.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*/
leaveIncorrectOrientation: Signal;
/**
* The Display canvas is aligned by adjusting the margins; the last margins are stored here.
*/
margin: { left: number; top: number; right: number; bottom: number; x: number; y: number; };
/**
* The maximum number of times a canvas will be resized (in a row) in order to fill the browser.
*/
maxIterations: number;
/**
* Maximum height the canvas should be scaled to (in pixels).
* If null it will scale to whatever height the browser can handle.
* Change with {@link Phaser.ScaleManager#setMinMax setMinMax}.
*/
maxHeight: number;
/**
* Maximum width the canvas should be scaled to (in pixels).
* If null it will scale to whatever width the browser can handle.
* Change with {@link Phaser.ScaleManager#setMinMax setMinMax}.
*/
maxWidth: number;
/**
* Minimum height the canvas should be scaled to (in pixels).
* Change with {@link Phaser.ScaleManager#setMinMax setMinMax}.
*/
minHeight: number;
/**
* Minimum width the canvas should be scaled to (in pixels).
* Change with {@link Phaser.ScaleManager#setMinMax setMinMax}.
*/
minWidth: number;
/**
* The offset coordinates of the Display canvas from the top-left of the browser window.
* The is used internally by Phaser.Pointer (for Input) and possibly other types.
*/
offset: Point;
/**
* This signal is dispatched when fullscreen mode is ready to be initialized but
* before the fullscreen request.
*
* The signal is passed two arguments: `scale` (the ScaleManager), and an object in the form `{targetElement: DOMElement}`.
*
* The `targetElement` is the {@link Phaser.ScaleManager#fullScreenTarget fullScreenTarget} element,
* if such is assigned, or a new element created by {@link Phaser.ScaleManager#createFullScreenTarget createFullScreenTarget}.
*
* Custom CSS styling or resets can be applied to `targetElement` as required.
*
* If `targetElement` is _not_ the same element as {@link Phaser.ScaleManager#fullScreenTarget fullScreenTarget}:
* - After initialization the Display canvas is moved onto the `targetElement` for
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* the duration of the fullscreen mode, and restored to it's original DOM location when fullscreen is exited.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* - The `targetElement` is moved/re-parented within the DOM and may have its CSS styles updated.
*
* The behavior of a pre-assigned target element is covered in {@link Phaser.ScaleManager#fullScreenTarget fullScreenTarget}.
*/
onFullScreenInit: Phaser.Signal;
/**
* This signal is dispatched when the browser enters or leaves fullscreen mode, if supported.
*
* The signal is supplied with a single argument: `scale` (the ScaleManager). Use `scale.isFullScreen` to determine
* if currently running in Fullscreen mode.
*/
onFullScreenChange: Phaser.Signal;
/**
* This signal is dispatched when the browser fails to enter fullscreen mode;
* or if the device does not support fullscreen mode and `startFullScreen` is invoked.
*
* The signal is supplied with a single argument: `scale` (the ScaleManager).
*/
onFullScreenError: Phaser.Signal;
/**
* This signal is dispatched when the orientation changes _or_ the validity of the current orientation changes.
*
* The signal is supplied with the following arguments:
* - `scale` - the ScaleManager object
* - `prevOrientation`, a string - The previous orientation as per {@link Phaser.ScaleManager#screenOrientation screenOrientation}.
* - `wasIncorrect`, a boolean - True if the previous orientation was last determined to be incorrect.
*
* Access the current orientation and validity with `scale.screenOrientation` and `scale.incorrectOrientation`.
* Thus the following tests can be done:
*
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* // The orientation itself changed:
* scale.screenOrientation !== prevOrientation
* // The orientation just became incorrect:
* scale.incorrectOrientation && !wasIncorrect
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* It is possible that this signal is triggered after {@link Phaser.ScaleManager#forceOrientation forceOrientation} so the orientation
* correctness changes even if the orientation itself does not change.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*/
onOrientationChange: Phaser.Signal;
/**
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* This signal is dispatched when the size of the Display canvas changes _or_ the size of the Game changes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* When invoked this is done _after_ the Canvas size/position have been updated.
*
* This signal is _only_ called when a change occurs and a reflow may be required.
* For example, if the canvas does not change sizes because of CSS settings (such as min-width)
* then this signal will _not_ be triggered.
*
* Use this to handle responsive game layout options.
*
* This is signaled from `preUpdate` (or `pauseUpdate`) _even when_ the game is paused.
*/
onSizeChange: Signal;
/**
* The _last known_ orientation value of the screen. A value of 90 is landscape and 0 is portrait.
*/
orientation: number;
/**
* When enabled the Display canvas will be horizontally-aligned _in the Parent container_ (or {@link Phaser.ScaleManager#parentIsWindow window}).
*
* To align horizontally across the page the Display canvas should be added directly to page;
* or the parent container should itself be horizontally aligned.
*
* Horizontal alignment is not applicable with the {@link Phaser.ScaleManager.RESIZE RESIZE} scaling mode.
* Default: false
*/
pageAlignHorizontally: boolean;
/**
* When enabled the Display canvas will be vertically-aligned _in the Parent container_ (or {@link Phaser.ScaleManager#parentIsWindow window}).
*
* To align vertically the Parent element should have a _non-collapsible_ height, such that it will maintain
* a height _larger_ than the height of the contained Game canvas - the game canvas will then be scaled vertically
* _within_ the remaining available height dictated by the Parent element.
*
* One way to prevent the parent from collapsing is to add an absolute "min-height" CSS property to the parent element.
* If specifying a relative "min-height/height" or adjusting margins, the Parent height must still be non-collapsible (see note).
*
* _Note_: In version 2.2 the minimum document height is _not_ automatically set to the viewport/window height.
* To automatically update the minimum document height set {@link Phaser.ScaleManager#compatibility compatibility.forceMinimumDocumentHeight} to true.
*
* Vertical alignment is not applicable with the {@link Phaser.ScaleManager.RESIZE RESIZE} scaling mode.
* Default: false
*/
pageAlignVertically: boolean;
/**
* The _original_ DOM element for the parent of the Display canvas.
* This may be different in fullscreen - see {@link Phaser.ScaleManager#createFullScreenTarget createFullScreenTarget}.
*
* This should only be changed after moving the Game canvas to a different DOM parent.
*/
parentNode: HTMLElement;
/**
* If the parent container of the Game canvas is the browser window itself (i.e. document.body),
* rather than another div, this should set to `true`.
*
* The {@link Phaser.ScaleManager#parentNode parentNode} property is generally ignored while this is in effect.
*/
parentIsWindow: boolean;
/**
* The scale of the game in relation to its parent container.
*/
parentScaleFactor: Point;
/**
* The _current_ scale factor based on the game dimensions vs. the scaled dimensions.
*/
scaleFactor: Point;
/**
* The _current_ inversed scale factor. The displayed dimensions divided by the game dimensions.
*/
scaleFactorInversed: Point;
/**
* The scaling method used by the ScaleManager when not in fullscreen.
*
* <dl>
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* <dt>{@link Phaser.ScaleManager.NO_SCALE}</dt>
* <dd>
* The Game display area will not be scaled - even if it is too large for the canvas/screen.
* This mode _ignores_ any applied scaling factor and displays the canvas at the Game size.
* </dd>
* <dt>{@link Phaser.ScaleManager.EXACT_FIT}</dt>
* <dd>
* The Game display area will be _stretched_ to fill the entire size of the canvas's parent element and/or screen.
* Proportions are not mainted.
* </dd>
* <dt>{@link Phaser.ScaleManager.SHOW_ALL}</dt>
* <dd>
* Show the entire game display area while _maintaining_ the original aspect ratio.
* </dd>
* <dt>{@link Phaser.ScaleManager.RESIZE}</dt>
* <dd>
* The dimensions of the game display area are changed to match the size of the parent container.
* That is, this mode _changes the Game size_ to match the display size.
* <p>
* Any manually set Game size (see {@link Phaser.ScaleManager#setGameSize setGameSize}) is ignored while in effect.
* </dd>
* <dt>{@link Phaser.ScaleManager.USER_SCALE}</dt>
* <dd>
* The game Display is scaled according to the user-specified scale set by {@link Phaser.ScaleManager#setUserScale setUserScale}.
* <p>
* This scale can be adjusted in the {@link Phaser.ScaleManager#setResizeCallback resize callback}
* for flexible custom-sizing needs.
* </dd>
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* </dl>
*/
scaleMode: number;
/**
* The _last known_ orientation of the screen, as defined in the Window Screen Web API.
* See {@link Phaser.DOM.getScreenOrientation} for possible values.
*/
screenOrientation: string;
/**
* The aspect ratio of the original game dimensions.
*/
sourceAspectRatio: number;
/**
* The maximum time (in ms) between dimension update checks for the Canvas's parent element (or window).
* Update checks normally happen quicker in response to other events.
* Default: 2000
*/
trackParentInterval: number;
/**
* Target width (in pixels) of the Display canvas.
*/
width: number;
/**
* The edges on which to constrain the game Display/canvas in _addition_ to the restrictions of the parent container.
*
* The properties are strings and can be '', 'visual', 'layout', or 'layout-soft'.
* - If 'visual', the edge will be constrained to the Window / displayed screen area
* - If 'layout', the edge will be constrained to the CSS Layout bounds
* - An invalid value is treated as 'visual'
* Default: {"right":"layout","bottom":""}
*/
windowConstraints: {
bottom: boolean;
right: boolean;
};
/**
* Start the ScaleManager.
*/
boot(): void;
/**
* Checks if the browser is in the correct orientation for the game,
* dependent upon {@link Phaser.ScaleManager#forceLandscape forceLandscape} and {@link Phaser.ScaleManager#forcePortrait forcePortrait}, and updates the state.
*
* The appropriate event is dispatched if the orientation became valid or invalid.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if the orientation state changed (consider a refresh)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkOrientationState(): boolean;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Creates a fullscreen target. This is called automatically as as needed when entering
* fullscreen mode and the resulting element is supplied to {@link Phaser.ScaleManager#onFullScreenInit onFullScreenInit}.
*
* Use {@link Phaser.ScaleManager#onFullScreenInit onFullScreenInit} to customize the created object.
*/
createFullScreenTarget(): HTMLDivElement;
/**
* Destroys the ScaleManager and removes any event listeners.
* This should probably only be called when the game is destroyed.
*/
destroy(): void;
/**
* Force the game to run in only one orientation.
*
* This enables generation of incorrect orientation signals and affects resizing but does not otherwise rotate or lock the orientation.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Orientation checks are performed via the Screen Orientation API, if available in browser. This means it will check your monitor
* orientation on desktop, or your device orientation on mobile, rather than comparing actual game dimensions. If you need to check the
* viewport dimensions instead and bypass the Screen Orientation API then set: `ScaleManager.compatibility.orientationFallback = 'viewport'`
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param forceLandscape true if the game should run in landscape mode only.
* @param forcePortrait true if the game should run in portrait mode only. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
forceOrientation(forceLandscape: boolean, forcePortrait?: boolean): void;
/**
* Returns the computed Parent size/bounds that the Display canvas is allowed/expected to fill.
*
* If in fullscreen mode or without parent (see {@link Phaser.ScaleManager#parentIsWindow parentIsWindow}),
* this will be the bounds of the visual viewport itself.
*
* This function takes the {@link Phaser.ScaleManager#windowConstraints windowConstraints} into consideration - if the parent is partially outside
* the viewport then this function may return a smaller than expected size.
*
* Values are rounded to the nearest pixel.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param target The rectangle to update; a new one is created as needed. - Default: (new Rectangle)
* @return The established parent bounds.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getParentBounds(target?: Rectangle): Rectangle;
/**
* Load configuration settings.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param config The game configuration object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
parseConfig(config: any): void;
/**
* The ScaleManager.preUpdate is called automatically by the core Game loop.
*/
preUpdate(): void;
/**
* Update method while paused.
*/
pauseUpdate(): void;
/**
* The "refresh" methods informs the ScaleManager that a layout refresh is required.
*
* The ScaleManager automatically queues a layout refresh (eg. updates the Game size or Display canvas layout)
* when the browser is resized, the orientation changes, or when there is a detected change
* of the Parent size. Refreshing is also done automatically when public properties,
* such as {@link Phaser.ScaleManager#scaleMode scaleMode}, are updated or state-changing methods are invoked.
*
* The "refresh" method _may_ need to be used in a few (rare) situtations when
*
* - a device change event is not correctly detected; or
* - the Parent size changes (and an immediate reflow is desired); or
* - the ScaleManager state is updated by non-standard means; or
* - certain {@link Phaser.ScaleManager#compatibility compatibility} properties are manually changed.
*
* The queued layout refresh is not immediate but will run promptly in an upcoming `preRender`.
*/
refresh(): void;
/**
* Set the actual Game size.
* Use this instead of directly changing `game.width` or `game.height`.
*
* The actual physical display (Canvas element size) depends on various settings including
* - Scale mode
* - Scaling factor
* - Size of Canvas's parent element or CSS rules such as min-height/max-height;
* - The size of the Window
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width _Game width_, in pixels.
* @param height _Game height_, in pixels.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setGameSize(width: number, height: number): void;
/**
* Sets the callback that will be invoked before sizing calculations.
*
* This is the appropriate place to call {@link Phaser.ScaleManager#setUserScale setUserScale} if needing custom dynamic scaling.
*
* The callback is supplied with two arguments `scale` and `parentBounds` where `scale` is the ScaleManager
* and `parentBounds`, a Phaser.Rectangle, is the size of the Parent element.
*
* This callback
* - May be invoked even though the parent container or canvas sizes have not changed
* - Unlike {@link Phaser.ScaleManager#onSizeChange onSizeChange}, it runs _before_ the canvas is guaranteed to be updated
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* - Will be invoked from `preUpdate`, _even when_ the game is paused
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* See {@link Phaser.ScaleManager#onSizeChange onSizeChange} for a better way of reacting to layout updates.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The callback that will be called each time a window.resize event happens or if set, the parent container resizes.
* @param context The context in which the callback will be called.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setResizeCallback(callback: ResizeCallback, context: any): void;
/**
* Set a User scaling factor used in the USER_SCALE scaling mode.
*
* The target canvas size is computed by:
*
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* canvas.width = (game.width * hScale) - hTrim
* canvas.height = (game.height * vScale) - vTrim
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* This method can be used in the {@link Phaser.ScaleManager#setResizeCallback resize callback}.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param hScale Horizontal scaling factor.
* @param vScale Vertical scaling factor.
* @param hTrim Horizontal trim, applied after scaling. - Default: 0
* @param vTrim Vertical trim, applied after scaling. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setUserScale(hScale: number, vScale: number, hTrim?: number, vTrim?: number): void;
/**
* Set the min and max dimensions for the Display canvas.
*
* _Note:_ The min/max dimensions are only applied in some cases
* - When the device is not in an incorrect orientation; or
* - The scale mode is EXACT_FIT when not in fullscreen
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param minWidth The minimum width the game is allowed to scale down to.
* @param minHeight The minimum height the game is allowed to scale down to.
* @param maxWidth The maximum width the game is allowed to scale up to; only changed if specified.
* @param maxHeight The maximum height the game is allowed to scale up to; only changed if specified.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setMinMax(minWidth: number, minHeight: number, maxWidth?: number, maxHeight?: number): void;
/**
* Calculates and sets the game dimensions based on the given width and height.
*
* This should _not_ be called when in fullscreen mode.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of the game.
* @param height The height of the game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setupScale(width: number, height: number): void;
/**
* Calculates and sets the game dimensions based on the given width and height.
*
* This should _not_ be called when in fullscreen mode.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width The width of the game.
* @param height The height of the game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setupScale(width: string, height: string): void;
/**
* Takes a Sprite or Image object and scales it to fit the given dimensions.
* Scaling happens proportionally without distortion to the sprites texture.
* The letterBox parameter controls if scaling will produce a letter-box effect or zoom the
* sprite until it fills the given values. Note that with letterBox set to false the scaled sprite may spill out over either
* the horizontal or vertical sides of the target dimensions. If you wish to stop this you can crop the Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The sprite we want to scale.
* @param width The target width that we want to fit the sprite in to. If not given it defaults to ScaleManager.width.
* @param height The target height that we want to fit the sprite in to. If not given it defaults to ScaleManager.height.
* @param letterBox True if we want the `fitted` mode. Otherwise, the function uses the `zoom` mode. - Default: false
* @return The scaled sprite.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
scaleSprite(sprite: Sprite, width?: number, height?: number, letterBox?: boolean): Sprite;
/**
* Takes a Sprite or Image object and scales it to fit the given dimensions.
* Scaling happens proportionally without distortion to the sprites texture.
* The letterBox parameter controls if scaling will produce a letter-box effect or zoom the
* sprite until it fills the given values. Note that with letterBox set to false the scaled sprite may spill out over either
* the horizontal or vertical sides of the target dimensions. If you wish to stop this you can crop the Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The sprite we want to scale.
* @param width The target width that we want to fit the sprite in to. If not given it defaults to ScaleManager.width.
* @param height The target height that we want to fit the sprite in to. If not given it defaults to ScaleManager.height.
* @param letterBox True if we want the `fitted` mode. Otherwise, the function uses the `zoom` mode. - Default: false
* @return The scaled sprite.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
scaleSprite(sprite: Image, width?: number, height?: number, letterBox?: boolean): Sprite;
/**
* Start the browsers fullscreen mode - this _must_ be called from a user input Pointer or Mouse event.
*
* The Fullscreen API must be supported by the browser for this to work - it is not the same as setting
* the game size to fill the browser window. See {@link Phaser.ScaleManager#compatibility compatibility.supportsFullScreen} to check if the current
* device is reported to support fullscreen mode.
*
* The {@link Phaser.ScaleManager#fullScreenFailed fullScreenFailed} signal will be dispatched if the fullscreen change request failed or the game does not support the Fullscreen API.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param antialias Changes the anti-alias feature of the canvas before jumping in to fullscreen (false = retain pixel art, true = smooth art). If not specified then no change is made. Only works in CANVAS mode.
* @param allowTrampoline Internal argument. If `false` click trampolining is suppressed. - Default: undefined
* @return Returns true if the device supports fullscreen mode and fullscreen mode was attempted to be started. (It might not actually start, wait for the signals.)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
startFullScreen(antialias?: boolean, allowTrampoline?: boolean): boolean;
/**
* Stops / exits fullscreen mode, if active.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Returns true if the browser supports fullscreen mode and fullscreen mode will be exited.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
stopFullScreen(): boolean;
}
/**
* DOM utility class.
*
* Provides a useful Window and Element functions as well as cross-browser compatibility buffer.
*
* Some code originally derived from {@link https://github.com/ryanve/verge verge}.
* Some parts were inspired by the research of Ryan Van Etten, released under MIT License 2013.
*/
class DOM {
/**
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* The bounds of the Visual viewport, as discussed in
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* {@link http://www.quirksmode.org/mobile/viewports.html A tale of two viewports — part one}
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* with one difference: the viewport size _excludes_ scrollbars, as found on some desktop browsers.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* Supported mobile:
Improve d.ts comments generation Remove empty @returns.
2015-01-21 10:54:16 +00:00
* iOS/Safari, Android 4, IE10, Firefox OS (maybe not Firefox Android), Opera Mobile 16
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* The properties change dynamically.
*/
static visualBounds: Phaser.Rectangle;
/**
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* The bounds of the Layout viewport, as discussed in
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* {@link http://www.quirksmode.org/mobile/viewports2.html A tale of two viewports — part two};
* but honoring the constraints as specified applicable viewport meta-tag.
*
* The bounds returned are not guaranteed to be fully aligned with CSS media queries (see
* {@link http://www.matanich.com/2013/01/07/viewport-size/ What size is my viewport?}).
*
* This is _not_ representative of the Visual bounds: in particular the non-primary axis will
* generally be significantly larger than the screen height on mobile devices when running with a
* constrained viewport.
*
* The properties change dynamically.
*/
static layoutBounds: Phaser.Rectangle;
/**
* The size of the document / Layout viewport.
*
* This incorrectly reports the dimensions in IE.
*
* The properties change dynamically.
*/
static documentBounds: Phaser.Rectangle;
/**
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
* Calibrates element coordinates for `inLayoutViewport` checks.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param coords An object containing the following properties: `{top: number, right: number, bottom: number, left: number}`
* @param cushion A value to adjust the coordinates by.
* @return The calibrated element coordinates
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static calibrate(coords: any, cushion?: number): any;
/**
* Get the Visual viewport aspect ratio (or the aspect ratio of an object or element)
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The object to determine the aspect ratio for. Must have public `width` and `height` properties or methods. - Default: (visualViewport)
* @return The aspect ratio.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getAspectRatio(object: any): number;
/**
* Returns the device screen orientation.
*
* Orientation values: 'portrait-primary', 'landscape-primary', 'portrait-secondary', 'landscape-secondary'.
*
* Order of resolving:
* - Screen Orientation API, or variation of - Future track. Most desktop and mobile browsers.
* - Screen size ratio check - If fallback is 'screen', suited for desktops.
* - Viewport size ratio check - If fallback is 'viewport', suited for mobile.
* - window.orientation - If fallback is 'window.orientation', works iOS and probably most Android; non-recommended track.
* - Media query
* - Viewport size ratio check (probably only IE9 and legacy mobile gets here..)
*
* See
* - https://w3c.github.io/screen-orientation/ (conflicts with mozOrientation/msOrientation)
* - https://developer.mozilla.org/en-US/docs/Web/API/Screen.orientation (mozOrientation)
* - http://msdn.microsoft.com/en-us/library/ie/dn342934(v=vs.85).aspx
* - https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Testing_media_queries
* - http://stackoverflow.com/questions/4917664/detect-viewport-orientation
* - http://www.matthewgifford.com/blog/2011/12/22/a-misconception-about-window-orientation
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param primaryFallback Specify 'screen', 'viewport', or 'window.orientation'. - Default: (none)
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getScreenOrientation(primaryFallback?: string): string;
/**
* A cross-browser element.getBoundingClientRect method with optional cushion.
*
* Returns a plain object containing the properties `top/bottom/left/right/width/height` with respect to the top-left corner of the current viewport.
* Its properties match the native rectangle.
* The cushion parameter is an amount of pixels (+/-) to cushion the element.
* It adjusts the measurements such that it is possible to detect when an element is near the viewport.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param element The element or stack (uses first item) to get the bounds for.
* @param cushion A +/- pixel adjustment amount.
* @return A plain object containing the properties `top/bottom/left/right/width/height` or `false` if a non-valid element is given.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getBounds(element: any, cushion?: number): any;
/**
* Get the [absolute] position of the element relative to the Document.
*
* The value may vary slightly as the page is scrolled due to rounding errors.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param element The targeted element that we want to retrieve the offset.
* @param point The point we want to take the x/y values of the offset.
* @return - A point objet with the offsetX and Y as its properties.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getOffset(element: any, point?: Point): Point;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Tests if the given DOM element is within the Layout viewport.
*
* The optional cushion parameter allows you to specify a distance.
*
* inLayoutViewport(element, 100) is `true` if the element is in the viewport or 100px near it.
* inLayoutViewport(element, -100) is `true` if the element is in the viewport or at least 100px near it.
*
* @param element The DOM element to check. If no element is given it defaults to the Phaser game canvas.
* @param cushion The cushion allows you to specify a distance within which the element must be within the viewport.
* @return True if the element is within the viewport, or within `cushion` distance from it.
*/
static inLayoutViewport(element: any, cushion?: number): boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
/**
* This is a base State class which can be extended if you are creating your own game.
* It provides quick access to common functions such as the camera, cache, input, match, sound and more.
*/
class State {
/**
* A reference to the GameObjectFactory which can be used to add new objects to the World.
*/
add: Phaser.GameObjectFactory;
/**
* A reference to the game cache which contains any loaded or generated assets, such as images, sound and more.
*/
cache: Phaser.Cache;
/**
* A handy reference to World.camera.
*/
camera: Phaser.Camera;
/**
* This is a reference to the currently running Game.
*/
game: Phaser.Game;
/**
* A reference to the Input Manager.
*/
input: Phaser.Input;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The string based identifier given to the State when added into the State Manager.
*/
key: string;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A reference to the Loader, which you mostly use in the preload method of your state to load external assets.
*/
load: Phaser.Loader;
/**
* A reference to the GameObjectCreator which can be used to make new objects.
*/
make: Phaser.GameObjectCreator;
/**
* A reference to Math class with lots of helpful functions.
*/
math: Phaser.Math;
/**
* The Particle Manager. It is called during the core gameloop and updates any Particle Emitters it has created.
*/
particles: Phaser.Particles;
/**
* A reference to the physics manager which looks after the different physics systems available within Phaser.
*/
physics: Phaser.Physics;
/**
* A reference to the seeded and repeatable random data generator.
*/
rnd: Phaser.RandomDataGenerator;
/**
* A reference to the Scale Manager which controls the way the game scales on different displays.
*/
scale: Phaser.ScaleManager;
/**
* A reference to the Sound Manager which can create, play and stop sounds, as well as adjust global volume.
*/
sound: Phaser.SoundManager;
/**
* A reference to the Stage.
*/
stage: Phaser.Stage;
/**
* A reference to the game clock and timed events system.
*/
time: Phaser.Time;
/**
* A reference to the tween manager.
*/
tweens: Phaser.TweenManager;
/**
* A reference to the game world. All objects live in the Game World and its size is not bound by the display resolution.
*/
world: Phaser.World;
/**
* create is called once preload has completed, this includes the loading of any assets from the Loader.
* If you don't have a preload method then create is the first method called in your State.
*/
create(): void;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* init is the very first function called when your State starts up. It's called before preload, create or anything else.
* If you need to route the game away to another State you could do so here, or if you need to prepare a set of variables
* or objects before the preloading starts.
*/
init(): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* loadRender is called during the Loader process. This only happens if you've set one or more assets to load in the preload method.
* The difference between loadRender and render is that any objects you render in this method you must be sure their assets exist.
*/
loadRender(): void;
/**
* loadUpdate is called during the Loader process. This only happens if you've set one or more assets to load in the preload method.
*/
loadUpdate(): void;
/**
* This method will be called if the core game loop is paused.
*/
paused(): void;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* pauseUpdate is called while the game is paused instead of preUpdate, update and postUpdate.
*/
pauseUpdate(): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* preload is called first. Normally you'd use this to load your game assets (or those needed for the current State)
* You shouldn't create any objects in this method that require assets that you're also loading in this method, as
* they won't yet be available.
*/
preload(): void;
/**
* Nearly all display objects in Phaser render automatically, you don't need to tell them to render.
* However the render method is called AFTER the game renderer and plugins have rendered, so you're able to do any
* final post-processing style effects here. Note that this happens before plugins postRender takes place.
*/
render(): void;
/**
* If your game is set to Scalemode RESIZE then each time the browser resizes it will call this function, passing in the new width and height.
*/
resize(): void;
/**
* This method will be called when the State is shutdown (i.e. you switch to another state from this one).
*/
shutdown(): void;
/**
* The update method is left empty for your own use.
* It is called during the core game loop AFTER debug, physics, plugins and the Stage have had their preUpdate methods called.
* If is called BEFORE Stage, Tweens, Sounds, Input, Physics, Particles and Plugins have had their postUpdate methods called.
*/
update(): void;
}
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
interface IStateCycle {
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
preUpdate(): void;
update(): void;
render(): void;
postRender(): void;
destroy(): void;
}
/**
* The State Manager is responsible for loading, setting up and switching game states.
*/
class StateManager {
/**
* The State Manager is responsible for loading, setting up and switching game states.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param pendingState A State object to seed the manager with. - Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, pendingState?: Phaser.State);
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The current active State object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
current: string;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* This is called when the state preload has finished and creation begins.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onCreateCallback: Function;
/**
* This is called when the state is set as the active state.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onInitCallback: Function;
/**
* This is called when the State is rendered during the preload phase.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onLoadRenderCallback: Function;
/**
* This is called when the State is updated during the preload phase.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onLoadUpdateCallback: Function;
/**
* This is called when the game is paused.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onPausedCallback: Function;
/**
* This is called every frame while the game is paused.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onPauseUpdateCallback: Function;
/**
* This is called when the state starts to load assets.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onPreloadCallback: Function;
/**
* This is called before the state is rendered and before the stage is cleared but after all game objects have had their final properties adjusted.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onPreRenderCallback: Function;
/**
* This is called post-render. It doesn't happen during preload (see onLoadRenderCallback).
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onRenderCallback: Function;
/**
* This is called when the game is resumed from a paused state.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onResumedCallback: Function;
/**
* This is called if ScaleManager.scalemode is RESIZE and a resize event occurs. It's passed the new width and height.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onResizeCallback: Function;
/**
* This is called when the state is shut down (i.e. swapped to another state).
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onShutDownCallback: Function;
/**
* This is called when the state is updated, every game loop. It doesn't happen during preload (@see onLoadUpdateCallback).
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Default: null
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onUpdateCallback: Function;
/**
* The object containing Phaser.States.
*/
states: any;
/**
* Adds a new State into the StateManager. You must give each State a unique key by which you'll identify it.
* The State can be either a Phaser.State object (or an object that extends it), a plain JavaScript object or a function.
* If a function is given a new state object will be created by calling it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key A unique key you use to reference this state, i.e. "MainMenu", "Level1".
* @param state The state you want to switch to.
* @param autoStart If true the State will be started immediately after adding it. - Default: false
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(key: string, state: any, autoStart?: boolean): void;
/**
* Checks if a given phaser state is valid. A State is considered valid if it has at least one of the core functions: preload, create, update or render.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The key of the state you want to check.
* @return true if the State has the required functions, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
checkState(key: string): boolean;
/**
* This method clears the current State, calling its shutdown callback. The process also removes any active tweens,
* resets the camera, resets input, clears physics, removes timers and if set clears the world and cache too.
*/
clearCurrentState(): void;
/**
* Removes all StateManager callback references to the State object, nulls the game reference and clears the States object.
* You don't recover from this without rebuilding the Phaser instance again.
*/
destroy(): void;
/**
* Gets the current State.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Phaser.State
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getCurrentState(): Phaser.State;
/**
* Links game properties to the State given by the key.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key State key.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
link(key: string): void;
loadComplete(): void;
/**
*
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param elapsedTime The time elapsed since the last update.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
preRender(elapsedTime: number): void;
/**
* preUpdate is called right at the start of the game loop. It is responsible for changing to a new state that was requested previously.
*/
preUpdate(): void;
render(): void;
/**
* Delete the given state.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key A unique key you use to reference this state, i.e. "MainMenu", "Level1".
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(key: string): void;
resume(): void;
/**
* Restarts the current State. State.shutDown will be called (if it exists) before the State is restarted.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param clearWorld Clear everything in the world? This clears the World display list fully (but not the Stage, so if you've added your own objects to the Stage they will need managing directly) - Default: true
* @param clearCache Clear the Game.Cache? This purges out all loaded assets. The default is false and you must have clearWorld=true if you want to clearCache as well. - Default: false
* @param args Additional parameters that will be passed to the State.init function if it has one.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
restart(clearWorld?: boolean, clearCache?: boolean): void;
resize(width: number, height: number): void;
/**
* Start the given State. If a State is already running then State.shutDown will be called (if it exists) before switching to the new State.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The key of the state you want to start.
* @param clearWorld Clear everything in the world? This clears the World display list fully (but not the Stage, so if you've added your own objects to the Stage they will need managing directly) - Default: true
* @param clearCache Clear the Game.Cache? This purges out all loaded assets. The default is false and you must have clearWorld=true if you want to clearCache as well. - Default: false
* @param args Additional parameters that will be passed to the State.init function (if it has one).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
start(key: string, clearWorld?: boolean, clearCache?: boolean, ...args: any[]): void;
update(): void;
/**
* Nulls all State level Phaser properties, including a reference to Game.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key State key.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
unlink(key: string): void;
}
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Create a new game object for displaying Text.
*
* This uses a local hidden Canvas object and renders the type into it. It then makes a texture from this for rendering to the view.
* Because of this you can only display fonts that are currently loaded and available to the browser: fonts must be pre-loaded.
*
* See {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts across mobile browsers.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class Text extends PIXI.Text {
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Create a new game object for displaying Text.
*
* This uses a local hidden Canvas object and renders the type into it. It then makes a texture from this for rendering to the view.
* Because of this you can only display fonts that are currently loaded and available to the browser: fonts must be pre-loaded.
*
* See {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts across mobile browsers.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Current game instance.
* @param x X position of the new text object.
* @param y Y position of the new text object.
* @param text The actual text that will be written.
* @param style The style object containing style attributes like font, font size, etc.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, x: number, y: number, text: string, style: any);
/**
* Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.
*/
align: string;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angle property is the rotation of the Game Object in *degrees* from its original orientation.
*
* Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
*
* Values outside this range are added to or subtracted from 360 to obtain a value within the range.
* For example, the statement player.angle = 450 is the same as player.angle = 90.
*
* If you wish to work in radians instead of degrees you can use the property `rotation` instead.
* Working in radians is slightly faster as it doesn't have to perform any calculations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if `fixedToCamera` is true.
*
* The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraOffset: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* An array of the color values as specified by {@link Phaser.Text#addColor addColor}.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
colors: string[];
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Change the font used.
*
* This is equivalent of the `font` property specified to {@link Phaser.Text#setStyle setStyle}, except
* that unlike using `setStyle` this will not change any current font fill/color settings.
*
* The CSS font string can also be individually altered with the `font`, `fontSize`, `fontWeight`, `fontStyle`, and `fontVariant` properties.
*/
cssFont: string;
/**
* As a Game Object runs through its destroy method this flag is set to true,
* and can be checked in any sub-systems or plugins it is being destroyed from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroyPhase: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
* Game Object, or any of its components.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
events: Phaser.Events;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Controls if this Game Object is processed by the core game loop.
* If this Game Object has a physics body it also controls if its physics body is updated or not.
* When `exists` is set to `false` it will remove its physics body from the physics world if it has one.
* It also toggles the `visible` property to false as well.
*
* Setting `exists` to true will add its physics body back in to the physics world, if it has one.
* It will also set the `visible` property to `true`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
exists: boolean;
/**
* A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.
*/
fill: any;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object that is "fixed" to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.
*
* The values are adjusted at the rendering stage, overriding the Game Objects actual world position.
*
* The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
* the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
* regardless where in the world the camera is.
*
* The offsets are stored in the `cameraOffset` property.
*
* Note that the `cameraOffset` values are in addition to any parent of this Game Object on the display list.
*
* Be careful not to set `fixedToCamera` on Game Objects which are in Groups that already have `fixedToCamera` enabled on them.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fixedToCamera: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Change the font family that the text will be rendered in, such as 'Arial'.
*
* Multiple CSS font families and generic fallbacks can be specified as long as
* {@link http://www.w3.org/TR/CSS2/fonts.html#propdef-font-family CSS font-family rules} are followed.
*
* To change the entire font string use {@link Phaser.Text#cssFont cssFont} instead: eg. `text.cssFont = 'bold 20pt Arial'`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
font: string;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The size of the font.
*
* If the font size is specified in pixels (eg. `32` or `'32px`') then a number (ie. `32`) representing
* the font size in pixels is returned; otherwise the value with CSS unit is returned as a string (eg. `'12pt'`).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
fontSize: number|string;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The weight of the font: 'normal', 'bold', or {@link http://www.w3.org/TR/CSS2/fonts.html#propdef-font-weight a valid CSS font weight}.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fontWeight: string;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The style of the font: 'normal', 'italic', 'oblique'
*/
fontStyle: string;
/**
* The variant the font: 'normal', 'small-caps'
*/
fontVariant: string;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The Input Handler for this Game Object.
*
* By default it is disabled. If you wish this Game Object to process input events you should enable it with: `inputEnabled = true`.
*
* After you have done this, this property will be a reference to the Phaser InputHandler.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
input: Phaser.InputHandler;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* By default a Game Object won't process any input events. By setting `inputEnabled` to true a Phaser.InputHandler is created
* for this Game Object and it will then start to process click / touch events and more.
*
* You can then access the Input Handler via `this.input`.
*
* Note that Input related events are dispatched from `this.events`, i.e.: `events.onInputDown`.
*
* If you set this property to false it will stop the Input Handler from processing any more input events.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inputEnabled: boolean;
/**
* Additional spacing (in pixels) between each line of text if multi-line.
*/
lineSpacing: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A user defined name given to this Game Object.
* This value isn't ever used internally by Phaser, it is meant as a game level property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
name: string;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Specify a padding value which is added to the line width and height when calculating the Text size.
* ALlows you to add extra spacing if Phaser is unable to accurately determine the true font dimensions.
*/
padding: Phaser.Point;
/**
* The const physics body type of this object.
*/
physicsType: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The coordinate of the object relative to the local coordinates of the parent.
*/
position: Phaser.Point;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The position the Game Object was located in the previous frame.
*/
previousPosition: Phaser.Point;
/**
* The rotation the Game Object was in set to in the previous frame. Value is in radians.
*/
previousRotation: number;
/**
* The render order ID is used internally by the renderer and Input Manager and should not be modified.
* This property is mostly used internally by the renderers, but is exposed for the use of plugins.
*/
renderOrderID: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The shadowBlur value. Make the shadow softer by applying a Gaussian blur to it. A number from 0 (no blur) up to approx. 10 (depending on scene).
*/
shadowBlur: number;
/**
* The color of the shadow, as given in CSS rgba format. Set the alpha component to 0 to disable the shadow.
*/
shadowColor: string;
/**
* The shadowOffsetX value in pixels. This is how far offset horizontally the shadow effect will be.
*/
shadowOffsetX: number;
/**
* The shadowOffsetY value in pixels. This is how far offset vertically the shadow effect will be.
*/
shadowOffsetY: number;
/**
* A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'.
*/
stroke: string;
/**
* A number that represents the thickness of the stroke. Default is 0 (no stroke)
*/
strokeThickness: number;
/**
* The scale factor of the object.
*/
scale: Phaser.Point;
/**
* The text string to be displayed by this Text object, taking into account the style settings.
*/
text: string;
/**
* The const type of this object.
*/
type: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The world coordinates of this Game Object in pixels.
* Depending on where in the display list this Game Object is placed this value can differ from `position`,
* which contains the x/y coordinates relative to the Game Objects parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
world: Phaser.Point;
/**
* Indicates if word wrap should be used.
*/
wordWrap: boolean;
/**
* The width at which text will wrap.
*/
wordWrapWidth: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The z depth of this Game Object within its parent Group.
* No two objects in a Group can have the same z value.
* This value is adjusted automatically whenever the Group hierarchy changes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
z: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Set specific colors for certain characters within the Text.
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* It works by taking a color value, which is a typical HTML string such as `#ff0000` or `rgb(255,0,0)` and a position.
* The position value is the index of the character in the Text string to start applying this color to.
* Once set the color remains in use until either another color or the end of the string is encountered.
* For example if the Text was `Photon Storm` and you did `Text.addColor('#ffff00', 6)` it would color in the word `Storm` in yellow.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param color A canvas fillstyle that will be used on the text eg `red`, `#00FF00`, `rgba()`.
* @param position The index of the character in the string to start applying this color value from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addColor(color: string, position: number): void;
/**
* Clears any previously set color stops.
*/
clearColors(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Converts individual font components (see `fontToComponents`) to a short CSS font string.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param components Font components.
*/
componentsToFont(components: any): string;
/**
* Destroy this Text object, removing it from the group it belongs to.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param destroyChildren Should every child of this object have its destroy method called? - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroy(destroyChildren?: boolean): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Converting a short CSS-font string into the relevant components.
*
* @param font a CSS font string
*/
fontToComponents(font: string): any;
/**
* Internal method called by the World postUpdate cycle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
postUpdate(): void;
/**
* Automatically called by World.preUpdate.
*/
preUpdate(): void;
/**
* Sets a drop shadow effect on the Text. You can specify the horizontal and vertical distance of the drop shadow with the `x` and `y` parameters.
* The color controls the shade of the shadow (default is black) and can be either an `rgba` or `hex` value.
* The blur is the strength of the shadow. A value of zero means a hard shadow, a value of 10 means a very soft shadow.
* To remove a shadow already in place you can call this method with no parameters set.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The shadowOffsetX value in pixels. This is how far offset horizontally the shadow effect will be. - Default: 0
* @param y The shadowOffsetY value in pixels. This is how far offset vertically the shadow effect will be. - Default: 0
* @param color The color of the shadow, as given in CSS rgba or hex format. Set the alpha component to 0 to disable the shadow. - Default: 'rgba(0,0,0,1)'
* @param blur The shadowBlur value. Make the shadow softer by applying a Gaussian blur to it. A number from 0 (no blur) up to approx. 10 (depending on scene). - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setShadow(x?: number, y?: number, color?: any, blur?: number): void;
/**
* Set the style of the text by passing a single style object to it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param style The style properties to be set on the Text.
* @param style.font The style and size of the font. - Default: 'bold 20pt Arial'
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param style.fontStyle The style of the font (eg. 'italic'): overrides the value in `style.font`. - Default: (from font)
* @param style.fontVariant The variant of the font (eg. 'small-caps'): overrides the value in `style.font`. - Default: (from font)
* @param style.fontWeight The weight of the font (eg. 'bold'): overrides the value in `style.font`. - Default: (from font)
* @param style.fontSize The size of the font (eg. 32 or '32px'): overrides the value in `style.font`. - Default: (from font)
* @param style.backgroundColor A canvas fillstyle that will be used as the background for the whole Text object. Set to `null` to disable. - Default: null
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param style.fill A canvas fillstyle that will be used on the text eg 'red', '#00FF00'. - Default: 'black'
* @param style.align Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text. - Default: 'left'
* @param style.stroke A canvas stroke style that will be used on the text stroke eg 'blue', '#FCFF00'. - Default: 'black'
* @param style.strokeThickness A number that represents the thickness of the stroke. Default is 0 (no stroke). - Default: 0
* @param style.wordWrap Indicates if word wrap should be used. - Default: false
* @param style.wordWrapWidth The width in pixels at which text will wrap. - Default: 100
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Change the font family that the text will be rendered in, such as 'Arial'.
*
* Multiple CSS font families and generic fallbacks can be specified as long as
* {@link http://www.w3.org/TR/CSS2/fonts.html#propdef-font-family CSS font-family rules} are followed.
*
* To change the entire font string use {@link Phaser.Text#cssFont cssFont} instead: eg. `text.cssFont = 'bold 20pt Arial'`.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
*/
/**
* A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.
*/
/**
* Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.
*/
/**
* A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'.
*/
/**
* A number that represents the thickness of the stroke. Default is 0 (no stroke)
*/
/**
* Indicates if word wrap should be used.
*/
/**
* The width at which text will wrap.
*/
/**
* The shadowOffsetX value in pixels. This is how far offset horizontally the shadow effect will be.
*/
/**
* The shadowOffsetY value in pixels. This is how far offset vertically the shadow effect will be.
*/
/**
* The color of the shadow, as given in CSS rgba format. Set the alpha component to 0 to disable the shadow.
*/
/**
* The shadowBlur value. Make the shadow softer by applying a Gaussian blur to it. A number from 0 (no blur) up to approx. 10 (depending on scene).
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
setStyle(style?: { font?: string; fill?: any; align?: string; stroke?: string; strokeThickness?: number; wordWrap?: boolean; wordWrapWidth?: number; shadowOffsetX?: number; shadowOffsetY?: number; shadowColor?: string; shadowBlur?: number; }): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Override this function to handle any special update requirements.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(): void;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Updates the internal `style.font` if it now differs according to generation from components.
*
* @param components Font components.
*/
updateFont(components: any): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Updates texture size based on canvas size
*/
updateTexture(): void;
/**
* Updates a line of text.
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
updateLine(text: string, x?: number, y?: number): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
/**
* A Tile is a representation of a single tile within the Tilemap.
*/
class Tile {
/**
* A Tile is a representation of a single tile within the Tilemap.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param layer The layer in the Tilemap data that this tile belongs to.
* @param index The index of this tile type in the core map data.
* @param x The x coordinate of this tile.
* @param y The y coordinate of this tile.
* @param width Width of the tile.
* @param height Height of the tile.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(layer: any, index: number, x: number, y: Number, width: number, height: number);//
/**
* The alpha value at which this tile is drawn to the canvas.
*/
alpha: number;
/**
* The sum of the y and height properties.
*/
bottom: number;
callback: Function;
callbackContext: any;
/**
* The width of the tile in pixels.
*/
centerX: number;
/**
* The height of the tile in pixels.
*/
centerY: number;
/**
* True if this tile can collide on any of its faces or has a collision callback set.
*/
canCollide: boolean;
/**
* Indicating collide with any object on the bottom.
* Default: false
*/
collideDown: boolean;
/**
* Indicating collide with any object on the left.
* Default: false
*/
collideLeft: boolean;
collideNone: boolean;
/**
* Indicating collide with any object on the right.
* Default: false
*/
collideRight: boolean;
/**
* Tile collision callback.
* Default: null
*/
collisionCallback: Function;
/**
* The context in which the collision callback will be called.
*/
collisionCallbackContext: any;
/**
* True if this tile can collide on any of its faces.
*/
collides: boolean;
/**
* Indicating collide with any object on the top.
* Default: false
*/
collideUp: boolean;
/**
* Is the bottom of this tile an interesting edge?
*/
faceBottom: boolean;
/**
* Is the left of this tile an interesting edge?
*/
faceLeft: boolean;
/**
* Is the right of this tile an interesting edge?
*/
faceRight: boolean;
/**
* Is the top of this tile an interesting edge?
*/
faceTop: boolean;
game: Phaser.Game;
/**
* The height of the tile in pixels.
*/
height: number;
/**
* The index of this tile within the map data corresponding to the tileset, or -1 if this represents a blank/null tile.
*/
index: number;
/**
* The layer in the Tilemap data that this tile belongs to.
*/
layer: any;
/**
* The x value in pixels.
*/
left: number;
/**
* Tile specific properties.
*/
properties: any;
/**
* The sum of the x and width properties.
*/
right: number;
/**
* Has this tile been walked / turned into a poly?
*/
scanned: boolean;
/**
* The y value.
*/
top: number;
/**
* The width of the tile in pixels.
*/
width: number;
/**
* The x map coordinate of this tile.
*/
worldX: number;
/**
* The y map coordinate of this tile.
*/
worldY: number;
/**
* The x map coordinate of this tile.
*/
x: number;
/**
* The y map coordinate of this tile.
*/
y: number;
/**
* Copies the tile data and properties from the given tile to this tile.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tile The tile to copy from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copy(tile: Phaser.Tile): Phaser.Tile;
/**
* Check if the given x and y world coordinates are within this Tile.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate to test.
* @param y The y coordinate to test.
* @return True if the coordinates are within this Tile, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
containsPoint(x: number, y: number): boolean;
/**
* Clean up memory.
*/
destroy(): void;
/**
* Check for intersection with this tile.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x axis in pixels.
* @param y The y axis in pixels.
* @param right The right point.
* @param bottom The bottom point.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
intersects(x: number, y: number, right: number, bottom: number): boolean;
isInterested(collides: boolean, faces: boolean): boolean;
/**
* Reset collision status flags.
*/
resetCollision(): void;
/**
* Sets the collision flags for each side of this tile and updates the interesting faces list.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param left Indicating collide with any object on the left.
* @param right Indicating collide with any object on the right.
* @param up Indicating collide with any object on the top.
* @param down Indicating collide with any object on the bottom.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setCollision(left: boolean, right: boolean, up: boolean, down: boolean): void;
/**
* Set a callback to be called when this tile is hit by an object.
* The callback must true true for collision processing to take place.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback Callback function.
* @param context Callback will be called within this context.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setCollisionCallback(callback: Function, context: any): void;
}
/**
* Creates a new Phaser.Tilemap object. The map can either be populated with data from a Tiled JSON file or from a CSV file.
* To do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key.
* When using CSV data you must provide the key and the tileWidth and tileHeight parameters.
* If creating a blank tilemap to be populated later, you can either specify no parameters at all and then use `Tilemap.create` or pass the map and tile dimensions here.
* Note that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.
* A Tile map is rendered to the display using a TilemapLayer. It is not added to the display list directly itself.
* A map may have multiple layers. You can perform operations on the map data such as copying, pasting, filling and shuffling the tiles around.
*/
class Tilemap {
/**
* Creates a new Phaser.Tilemap object. The map can either be populated with data from a Tiled JSON file or from a CSV file.
* To do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key.
* When using CSV data you must provide the key and the tileWidth and tileHeight parameters.
* If creating a blank tilemap to be populated later, you can either specify no parameters at all and then use `Tilemap.create` or pass the map and tile dimensions here.
* Note that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.
* A Tile map is rendered to the display using a TilemapLayer. It is not added to the display list directly itself.
* A map may have multiple layers. You can perform operations on the map data such as copying, pasting, filling and shuffling the tiles around.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Game reference to the currently running game.
* @param key The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass `null`.
* @param tileWidth The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @param tileHeight The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @param width The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. - Default: 10
* @param height The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. - Default: 10
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, key?: string, tileWidth?: number, tileHeight?: number, width?: number, height?: number);
static CSV: number;
static TILED_JSON: number;
static NORTH: number;
static EAST: number;
static SOUTH: number;
static WEST: number;
/**
* An array of collision data (polylines, etc).
*/
collision: any[];
/**
* An array of tile indexes that collide.
*/
collideIndexes: any[];
/**
* The current layer.
*/
currentLayer: number;
/**
* Map data used for debug values only.
*/
debugMap: any[];
/**
* The format of the map data, either Phaser.Tilemap.CSV or Phaser.Tilemap.TILED_JSON.
*/
format: number;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* The height of the map (in tiles).
*/
height: number;
/**
* The height of the map in pixels based on height * tileHeight.
*/
heightInPixels: number;
/**
* An array of Tiled Image Layers.
*/
images: any[];
/**
* The key of this map data in the Phaser.Cache.
*/
key: string;
/**
* The current layer object.
*/
layer: Phaser.TilemapLayer[];
/**
* An array of Tilemap layer data.
*/
layers: any[];
/**
* An array of Tiled Object Layers.
*/
objects: any[];
/**
* The orientation of the map data (as specified in Tiled), usually 'orthogonal'.
*/
orientation: string;
/**
* Map specific properties as specified in Tiled.
*/
properties: any;
/**
* The base height of the tiles in the map (in pixels).
*/
tileHeight: number;
/**
* The super array of Tiles.
*/
tiles: Phaser.Tile[];
/**
* An array of Tilesets.
*/
tilesets: Phaser.Tileset[];
/**
* The base width of the tiles in the map (in pixels).
*/
tileWidth: number;
/**
* The version of the map data (as specified in Tiled, usually 1).
*/
version: number;
/**
* The width of the map (in tiles).
*/
width: number;
/**
* The width of the map in pixels based on width * tileWidth.
*/
widthInPixels: number;
/**
* Adds an image to the map to be used as a tileset. A single map may use multiple tilesets.
* Note that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled editor.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tileset The name of the tileset as specified in the map data.
* @param key The key of the Phaser.Cache image used for this tileset. If not specified it will look for an image with a key matching the tileset parameter.
* @param tileWidth The width of the tiles in the Tileset Image. If not given it will default to the map.tileWidth value, if that isn't set then 32. - Default: 32
* @param tileHeight The height of the tiles in the Tileset Image. If not given it will default to the map.tileHeight value, if that isn't set then 32. - Default: 32
* @param tileMargin The width of the tiles in the Tileset Image. If not given it will default to the map.tileWidth value. - Default: 0
* @param tileSpacing The height of the tiles in the Tileset Image. If not given it will default to the map.tileHeight value. - Default: 0
* @param gid If adding multiple tilesets to a blank/dynamic map, specify the starting GID the set will use here. - Default: 0
* @return Returns the Tileset object that was created or updated, or null if it failed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
addTilesetImage(tileset: string, key?: string, tileWidth?: number, tileHeight?: number, tileMargin?: number, tileSpacing?: number, gid?: number): Phaser.Tileset;
/**
* Internal function.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param layer The index of the TilemapLayer to operate on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
calculateFaces(layer: number): void;
/**
* Copies all of the tiles in the given rectangular block into the tilemap data buffer.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the top left of the area to copy (given in tiles, not pixels)
* @param y Y position of the top left of the area to copy (given in tiles, not pixels)
* @param width The width of the area to copy (given in tiles, not pixels)
* @param height The height of the area to copy (given in tiles, not pixels)
* @param layer The layer to copy the tiles from.
* @return An array of the tiles that were copied.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
copy(x: number, y: number, width: number, height: number, layer?: any): Phaser.Tile[];
/**
* Creates an empty map of the given dimensions and one blank layer. If layers already exist they are erased.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the default layer of the map.
* @param width The width of the map in tiles.
* @param height The height of the map in tiles.
* @param tileWidth The width of the tiles the map uses for calculations.
* @param tileHeight The height of the tiles the map uses for calculations.
* @param group Optional Group to add the layer to. If not specified it will be added to the World group.
* @return The TilemapLayer object. This is an extension of Phaser.Image and can be moved around the display list accordingly.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
create(name: string, width: number, height: number, tileWidth: number, tileHeight: number, group?: Phaser.Group): Phaser.TilemapLayer;
/**
* Creates a new and empty layer on this Tilemap. By default TilemapLayers are fixed to the camera.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of this layer. Must be unique within the map.
* @param width The width of the layer in tiles.
* @param height The height of the layer in tiles.
* @param tileWidth The width of the tiles the layer uses for calculations.
* @param tileHeight The height of the tiles the layer uses for calculations.
* @param group Optional Group to add the layer to. If not specified it will be added to the World group.
* @return The TilemapLayer object. This is an extension of Phaser.Image and can be moved around the display list accordingly.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createBlankLayer(name: string, width: number, height: number, tileWidth: number, tileHeight: number, group?: Phaser.Group): Phaser.TilemapLayer;
/**
* Creates a Sprite for every object matching the given gid in the map data. You can optionally specify the group that the Sprite will be created in. If none is
* given it will be created in the World. All properties from the map data objectgroup are copied across to the Sprite, so you can use this as an easy way to
* configure Sprite properties from within the map editor. For example giving an object a property of alpha: 0.5 in the map editor will duplicate that when the
* Sprite is created. You could also give it a value like: body.velocity.x: 100 to set it moving automatically.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the Object Group to create Sprites from.
* @param gid The layer array index value, or if a string is given the layer name within the map data.
* @param key The Game.cache key of the image that this Sprite will use.
* @param frame If the Sprite image contains multiple frames you can specify which one to use here.
* @param exists The default exists state of the Sprite. - Default: true
* @param autoCull The default autoCull state of the Sprite. Sprites that are autoCulled are culled from the camera if out of its range. - Default: false
* @param group Group to add the Sprite to. If not specified it will be added to the World group. - Default: Phaser.World
* @param CustomClass If you wish to create your own class, rather than Phaser.Sprite, pass the class here. Your class must extend Phaser.Sprite and have the same constructor parameters. - Default: Phaser.Sprite
* @param adjustY By default the Tiled map editor uses a bottom-left coordinate system. Phaser uses top-left. So most objects will appear too low down. This parameter moves them up by their height. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createFromObjects(name: string, gid: number, key: string, frame?: any, exists?: boolean, autoCull?: boolean, group?: Phaser.Group, CustomClass?: any, adjustY?: boolean): void;
/**
* Creates a Sprite for every object matching the given tile indexes in the map data.
* You can specify the group that the Sprite will be created in. If none is given it will be created in the World.
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* You can optional specify if the tile will be replaced with another after the Sprite is created. This is useful if you want to lay down special
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* tiles in a level that are converted to Sprites, but want to replace the tile itself with a floor tile or similar once converted.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tiles The tile index, or array of indexes, to create Sprites from.
* @param replacements The tile index, or array of indexes, to change a converted tile to. Set to `null` to not change.
* @param key The Game.cache key of the image that this Sprite will use.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param layer The layer to operate on.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param group Group to add the Sprite to. If not specified it will be added to the World group. - Default: Phaser.World
* @param properties An object that contains the default properties for your newly created Sprite. This object will be iterated and any matching Sprite property will be set.
* @return The number of Sprites that were created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createFromTiles(tiles: any, replacements: any, key: string, layer?: any, group?: Phaser.Group, properties?: any): number;
/**
* Creates a new TilemapLayer object. By default TilemapLayers are fixed to the camera.
* The `layer` parameter is important. If you've created your map in Tiled then you can get this by looking in Tiled and looking at the Layer name.
* Or you can open the JSON file it exports and look at the layers[].name value. Either way it must match.
* If you wish to create a blank layer to put your own tiles on then see Tilemap.createBlankLayer.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param layer The layer array index value, or if a string is given the layer name, within the map data that this TilemapLayer represents.
* @param width The rendered width of the layer, should never be wider than Game.width. If not given it will be set to Game.width.
* @param height The rendered height of the layer, should never be wider than Game.height. If not given it will be set to Game.height.
* @param group Optional Group to add the object to. If not specified it will be added to the World group.
* @return The TilemapLayer object. This is an extension of Phaser.Sprite and can be moved around the display list accordingly.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
createLayer(layer: any, width?: number, height?: number, group?: Phaser.Group): Phaser.TilemapLayer;
/**
* Removes all layer data from this tile map and nulls the game reference.
* Note: You are responsible for destroying any TilemapLayer objects you generated yourself, as Tilemap doesn't keep a reference to them.
*/
destroy(): void;
/**
* Dumps the tilemap data out to the console.
*/
dump(): void;
/**
* Fills the given area with the specified tile.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The index of the tile that the area will be filled with.
* @param x X position of the top left of the area to operate one, given in tiles, not pixels.
* @param y Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param width The width in tiles of the area to operate on.
* @param height The height in tiles of the area to operate on.
* @param layer The layer to operate on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fill(index: number, x: number, y: number, width: number, height: number, layer?: any): void;
/**
* For each tile in the given area defined by x/y and width/height run the given callback.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The callback. Each tile in the given area will be passed to this callback as the first and only parameter.
* @param context The context under which the callback should be run.
* @param x X position of the top left of the area to operate one, given in tiles, not pixels.
* @param y Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param width The width in tiles of the area to operate on.
* @param height The height in tiles of the area to operate on.
* @param layer The layer to operate on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
forEach(callback: Function, context: any, x: number, y: Number, width: number, height: number, layer?: any): void;
/**
* Gets the image index based on its name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the image to get.
* @return The index of the image in this tilemap, or null if not found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getImageIndex(name: string): number;
/**
* Gets the layer index based on the layers name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param location The local array to search.
* @param name The name of the array element to get.
* @return The index of the element in the array, or null if not found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getIndex(location: any[], name: string): number;
/**
* Gets the TilemapLayer index as used in the setCollision calls.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param layer The layer to operate on. If not given will default to this.currentLayer.
* @return The TilemapLayer index.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getLayer(layer: any): number;
/**
* Gets the layer index based on its name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the layer to get.
* @return The index of the layer in this tilemap, or null if not found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getLayerIndex(name: string): number;
/**
* Gets the object index based on its name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the object to get.
* @return The index of the object in this tilemap, or null if not found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getObjectIndex(name: string): number;
/**
* Gets a tile from the Tilemap Layer. The coordinates are given in tile values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position to get the tile from (given in tile units, not pixels)
* @param y Y position to get the tile from (given in tile units, not pixels)
* @param layer The layer to get the tile from.
* @param nonNull If true getTile won't return null for empty tiles, but a Tile object with an index of -1. - Default: false
* @return The tile at the given coordinates or null if no tile was found or the coordinates were invalid.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTile(x: number, y: number, layer?: any, nonNull?: boolean): Phaser.Tile;
/**
* Gets the tile above the tile coordinates given.
* Mostly used as an internal function by calculateFaces.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param layer The local layer index to get the tile from. Can be determined by Tilemap.getLayer().
* @param x The x coordinate to get the tile from. In tiles, not pixels.
* @param y The y coordinate to get the tile from. In tiles, not pixels.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTileAbove(layer: number, x: number, y: number): Phaser.Tile;
/**
* Gets the tile below the tile coordinates given.
* Mostly used as an internal function by calculateFaces.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param layer The local layer index to get the tile from. Can be determined by Tilemap.getLayer().
* @param x The x coordinate to get the tile from. In tiles, not pixels.
* @param y The y coordinate to get the tile from. In tiles, not pixels.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTileBelow(layer: number, x: number, y: number): Phaser.Tile;
/**
* Gets the tile to the left of the tile coordinates given.
* Mostly used as an internal function by calculateFaces.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param layer The local layer index to get the tile from. Can be determined by Tilemap.getLayer().
* @param x The x coordinate to get the tile from. In tiles, not pixels.
* @param y The y coordinate to get the tile from. In tiles, not pixels.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTileLeft(layer: number, x: number, y: number): Phaser.Tile;
/**
* Gets the tile to the right of the tile coordinates given.
* Mostly used as an internal function by calculateFaces.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param layer The local layer index to get the tile from. Can be determined by Tilemap.getLayer().
* @param x The x coordinate to get the tile from. In tiles, not pixels.
* @param y The y coordinate to get the tile from. In tiles, not pixels.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTileRight(layer: number, x: number, y: number): Phaser.Tile;
/**
* Gets the tileset index based on its name.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the tileset to get.
* @return The index of the tileset in this tilemap, or null if not found.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTilesetIndex(name: string): number;
/**
* Gets a tile from the Tilemap layer. The coordinates are given in pixel values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position to get the tile from (given in pixels)
* @param y Y position to get the tile from (given in pixels)
* @param tileWidth The width of the tiles. If not given the map default is used.
* @param tileHeight The height of the tiles. If not given the map default is used.
* @param layer The layer to get the tile from.
* @return The tile at the given coordinates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTileWorldXY(x: number, y: number, tileWidth?: number, tileHeight?: number, layer?: any): Phaser.Tile;
/**
* Checks if there is a tile at the given location.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position to check if a tile exists at (given in tile units, not pixels)
* @param y Y position to check if a tile exists at (given in tile units, not pixels)
* @param layer The layer to set as current.
* @return True if there is a tile at the given location, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
hasTile(x: number, y: number, layer: Phaser.TilemapLayer): boolean;
/**
* Pastes a previously copied block of tile data into the given x/y coordinates. Data should have been prepared with Tilemap.copy.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the top left of the area to paste to (given in tiles, not pixels)
* @param y Y position of the top left of the area to paste to (given in tiles, not pixels)
* @param tileblock The block of tiles to paste.
* @param layer The layer to paste the tiles into.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
paste(x: number, y: number, tileblock: Phaser.Tile[], layer?: any): void;
/**
* Puts a tile of the given index value at the coordinate specified.
* If you pass `null` as the tile it will pass your call over to Tilemap.removeTile instead.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tile The index of this tile to set or a Phaser.Tile object. If null the tile is removed from the map.
* @param x X position to place the tile (given in tile units, not pixels)
* @param y Y position to place the tile (given in tile units, not pixels)
* @param layer The layer to modify.
* @return The Tile object that was created or added to this map.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
putTile(tile: any, x: number, y: number, layer?: any): Phaser.Tile;
/**
* Puts a tile into the Tilemap layer. The coordinates are given in pixel values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tile The index of this tile to set or a Phaser.Tile object.
* @param x X position to insert the tile (given in pixels)
* @param y Y position to insert the tile (given in pixels)
* @param tileWidth The width of the tile in pixels.
* @param tileHeight The height of the tile in pixels.
* @param layer The layer to modify.
* @return The Tile object that was created or added to this map.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
putTileWorldXY(tile: any, x: number, y: number, tileWidth: number, tileHeight: number, layer?: any): void;
/**
* Randomises a set of tiles in a given area.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the top left of the area to operate one, given in tiles, not pixels.
* @param y Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param width The width in tiles of the area to operate on.
* @param height The height in tiles of the area to operate on.
* @param layer The layer to operate on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
random(x: number, y: number, width: number, height: number, layer?: any): void;
/**
* Removes all layers from this tile map.
*/
removeAllLayers(): void;
/**
* Removes the tile located at the given coordinates and updates the collision data.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position to place the tile (given in tile units, not pixels)
* @param y Y position to place the tile (given in tile units, not pixels)
* @param layer The layer to modify.
* @return The Tile object that was removed from this map.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeTile(x: number, y: number, layer?: any): Phaser.Tile;
/**
* Removes the tile located at the given coordinates and updates the collision data. The coordinates are given in pixel values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position to insert the tile (given in pixels)
* @param y Y position to insert the tile (given in pixels)
* @param tileWidth The width of the tile in pixels.
* @param tileHeight The height of the tile in pixels.
* @param layer The layer to modify.
* @return The Tile object that was removed from this map.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeTileWorldXY(x: number, y: number, tileWidth: number, tileHeight: number, layer?: any): Phaser.Tile;
/**
* Scans the given area for tiles with an index matching `source` and updates their index to match `dest`.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param source The tile index value to scan for.
* @param dest The tile index value to replace found tiles with.
* @param x X position of the top left of the area to operate one, given in tiles, not pixels.
* @param y Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param width The width in tiles of the area to operate on.
* @param height The height in tiles of the area to operate on.
* @param layer The layer to operate on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
replace(source: number, dest: number, x: number, y: number, width: number, height: number, layer?: any): void;
/**
* Searches the entire map layer for the first tile matching the given index, then returns that Phaser.Tile object.
* If no match is found it returns null.
* The search starts from the top-left tile and continues horizontally until it hits the end of the row, then it drops down to the next column.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If the reverse boolean is true, it scans starting from the bottom-right corner traveling up to the top-left.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The tile index value to search for.
* @param skip The number of times to skip a matching tile before returning. - Default: 0
* @param reverse If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left. - Default: false
* @param layer The layer to get the tile from.
* @return The first (or n skipped) tile with the matching index.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
searchTileIndex(index: number, skip?: number, reverse?: boolean, layer?: any): Phaser.Tile;
/**
* Sets collision the given tile or tiles. You can pass in either a single numeric index or an array of indexes: [ 2, 3, 15, 20].
* The `collides` parameter controls if collision will be enabled (true) or disabled (false).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param indexes Either a single tile index, or an array of tile IDs to be checked for collision.
* @param collides If true it will enable collision. If false it will clear collision. - Default: true
* @param layer The layer to operate on. If not given will default to this.currentLayer.
* @param recalculate Recalculates the tile faces after the update. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setCollision(indexes: any, collides?: boolean, layer?: any, recalculate?: boolean): void;
/**
* Sets collision on a range of tiles where the tile IDs increment sequentially.
* Calling this with a start value of 10 and a stop value of 14 would set collision for tiles 10, 11, 12, 13 and 14.
* The `collides` parameter controls if collision will be enabled (true) or disabled (false).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param start The first index of the tile to be set for collision.
* @param stop The last index of the tile to be set for collision.
* @param collides If true it will enable collision. If false it will clear collision. - Default: true
* @param layer The layer to operate on. If not given will default to this.currentLayer.
* @param recalculate Recalculates the tile faces after the update. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setCollisionBetween(start: number, stop: number, collides?: boolean, layer?: any, recalculate?: boolean): void;
/**
* Sets collision on all tiles in the given layer, except for the IDs of those in the given array.
* The `collides` parameter controls if collision will be enabled (true) or disabled (false).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param indexes An array of the tile IDs to not be counted for collision.
* @param collides If true it will enable collision. If false it will clear collision. - Default: true
* @param layer The layer to operate on. If not given will default to this.currentLayer.
* @param recalculate Recalculates the tile faces after the update. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setCollisionByExclusion(indexes: any[], collides?: boolean, layer?: any, recalculate?: boolean): void;
/**
* Sets collision values on a tile in the set.
* You shouldn't usually call this method directly, instead use setCollision, setCollisionBetween or setCollisionByExclusion.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index The index of the tile on the layer.
* @param collides If true it will enable collision on the tile. If false it will clear collision values from the tile. - Default: true
* @param layer The layer to operate on. If not given will default to this.currentLayer.
* @param recalculate Recalculates the tile faces after the update. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setCollisionByIndex(index: number, collides?: boolean, layer?: number, recalculate?: boolean): void;
/**
* Sets the current layer to the given index.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param layer The layer to set as current.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setLayer(layer: any): void;
/**
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* Turn off/on the recalculation of faces for tile or collision updates.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* `setPreventRecalculate(true)` puts recalculation on hold while `setPreventRecalculate(false)` recalculates all the changed layers.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value If true it will put the recalculation on hold.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setPreventRecalculate(value: boolean): void;
/**
* Sets a global collision callback for the given tile index within the layer. This will affect all tiles on this layer that have the same index.
* If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.
* If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param indexes Either a single tile index, or an array of tile indexes to have a collision callback set for.
* @param callback The callback that will be invoked when the tile is collided with.
* @param callbackContext The context under which the callback is called.
* @param layer The layer to operate on. If not given will default to this.currentLayer.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setTileIndexCallback(indexes: any, callback: Function, callbackContext: any, layer?: any): void;
/**
* Sets a global collision callback for the given map location within the layer. This will affect all tiles on this layer found in the given area.
* If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.
* If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the top left of the area to copy (given in tiles, not pixels)
* @param y Y position of the top left of the area to copy (given in tiles, not pixels)
* @param width The width of the area to copy (given in tiles, not pixels)
* @param height The height of the area to copy (given in tiles, not pixels)
* @param callback The callback that will be invoked when the tile is collided with.
* @param callbackContext The context under which the callback is called.
* @param layer The layer to operate on. If not given will default to this.currentLayer.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setTileLocationCallback(x: number, y: number, width: number, height: number, callback: Function, callbackContext: any, layer?: any): void;
/**
* Sets the base tile size for the map.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tileWidth The width of the tiles the map uses for calculations.
* @param tileHeight The height of the tiles the map uses for calculations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setTileSize(tileWidth: number, tileHeight: number): void;
/**
* Shuffles a set of tiles in a given area. It will only randomise the tiles in that area, so if they're all the same nothing will appear to have changed!
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the top left of the area to operate one, given in tiles, not pixels.
* @param y Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param width The width in tiles of the area to operate on.
* @param height The height in tiles of the area to operate on.
* @param layer The layer to operate on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
shuffle(x: number, y: number, width: number, height: number, layer: any): void;
/**
* Scans the given area for tiles with an index matching tileA and swaps them with tileB.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tileA First tile index.
* @param tileB Second tile index.
* @param x X position of the top left of the area to operate one, given in tiles, not pixels.
* @param y Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param width The width in tiles of the area to operate on.
* @param height The height in tiles of the area to operate on.
* @param layer The layer to operate on.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
swap(tileA: number, tileB: number, x: number, y: number, width: number, height: number, layer?: any): void;
}
/**
* A TilemapLayer is a Phaser.Image/Sprite that renders a specific TileLayer of a Tilemap.
*
* Since a TilemapLayer is a Sprite it can be moved around the display, added to other groups or display objects, etc.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* By default TilemapLayers have fixedToCamera set to `true`. Changing this will break Camera follow and scrolling behavior.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
class TilemapLayer extends Phaser.Image {
/**
* A TilemapLayer is a Phaser.Image/Sprite that renders a specific TileLayer of a Tilemap.
*
* Since a TilemapLayer is a Sprite it can be moved around the display, added to other groups or display objects, etc.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* By default TilemapLayers have fixedToCamera set to `true`. Changing this will break Camera follow and scrolling behavior.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Game reference to the currently running game.
* @param tilemap The tilemap to which this layer belongs.
* @param index The index of the TileLayer to render within the Tilemap.
* @param width Width of the renderable area of the layer (in pixels).
* @param height Height of the renderable area of the layer (in pixels).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, tilemap: Phaser.Tilemap, index: number, width?: number, height?: number);
/**
* Required Pixi var.
*/
baseTexture: PIXI.BaseTexture;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if `fixedToCamera` is true.
*
* The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraOffset: Phaser.Point;
/**
* The canvas to which this TilemapLayer draws.
*/
canvas: HTMLCanvasElement;
collisionHeight: number;
collisionWidth: number;
/**
* The 2d context of the canvas.
*/
context: CanvasRenderingContext2D;
/**
* Enable an additional "debug rendering" pass to display collision information.
* Default: false
*/
debug: boolean;
debugAlpha: number;
debugCallbackColor: string;
debugColor: string;
/**
* Settings used for debugging and diagnostics.
*/
debugSettings: { missingImageFill: string; debuggedTileOverfill: string; forceFullRedraw: boolean; debugAlpha: number; facingEdgeStroke: string; collidingTileOverfill: string; };
/**
* If true tiles will be force rendered, even if such is not believed to be required.
*/
dirty: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Controls if the core game loop and physics update this game object or not.
*/
exists: boolean;
/**
* A Game Object that is "fixed" to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.
*
* The values are adjusted at the rendering stage, overriding the Game Objects actual world position.
*
* The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
* the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
* regardless where in the world the camera is.
*
* The offsets are stored in the `cameraOffset` property.
*
* Note that the `cameraOffset` values are in addition to any parent of this Game Object on the display list.
*
* Be careful not to set `fixedToCamera` on Game Objects which are in Groups that already have `fixedToCamera` enabled on them.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fixedToCamera: boolean;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* The index of this layer within the Tilemap.
*/
index: number;
/**
* The layer object within the Tilemap that this layer represents.
*/
layer: Phaser.TilemapLayer;
/**
* The Tilemap to which this layer is bound.
*/
map: Phaser.Tilemap;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A user defined name given to this Game Object.
* This value isn't ever used internally by Phaser, it is meant as a game level property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
name: string;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The const physics body type of this object.
*/
physicsType: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* When ray-casting against tiles this is the number of steps it will jump. For larger tile sizes you can increase this to improve performance.
* Default: 4
*/
rayStepRate: number;
/**
* Settings that control standard (non-diagnostic) rendering.
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
* Default: {"enableScrollDelta":true,"overdrawRatio":0.2,"copyCanvas":null}
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
renderSettings: { enableScrollDelta: boolean; overdrawRatio: number; copyCanvas: any; };
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Speed at which this layer scrolls horizontally, relative to the camera (e.g. scrollFactorX of 0.5 scrolls half as quickly as the 'normal' camera-locked layers do).
* Default: 1
*/
scrollFactorX: number;
/**
* Speed at which this layer scrolls vertically, relative to the camera (e.g. scrollFactorY of 0.5 scrolls half as quickly as the 'normal' camera-locked layers do)
* Default: 1
*/
scrollFactorY: number;
scrollX: number;
scrollY: number;
/**
* Required Pixi var.
*/
texture: PIXI.Texture;
/**
* Dimensions of the renderable area.
*/
textureFrame: Phaser.Frame;
tileColor: string;
/**
* The const type of this object.
* Default: Phaser.TILEMAPLAYER
*/
type: number;
wrap: boolean;
/**
* Gets all tiles that intersect with the given line.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param line The line used to determine which tiles to return.
* @param stepRate How many steps through the ray will we check? Defaults to `rayStepRate`. - Default: (rayStepRate)
* @param collides If true, _only_ return tiles that collide on one or more faces. - Default: false
* @param interestingFace If true, _only_ return tiles that have interesting faces. - Default: false
* @return An array of Phaser.Tiles.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getRayCastTiles(line: Phaser.Line, stepRate?: number, collides?: boolean, interestingFace?: boolean): Phaser.Tile[];
/**
* Get all tiles that exist within the given area, defined by the top-left corner, width and height. Values given are in pixels, not tiles.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the top left corner (in pixels).
* @param y Y position of the top left corner (in pixels).
* @param width Width of the area to get (in pixels).
* @param height Height of the area to get (in pixels).
* @param collides If true, _only_ return tiles that collide on one or more faces. - Default: false
* @param interestingFace If true, _only_ return tiles that have interesting faces. - Default: false
* @return An array of Tiles.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTiles(x: number, y: number, width: number, height: number, collides?: boolean, interestingFace?: boolean): Phaser.Tile[];
/**
* Convert a pixel value to a tile coordinate.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the point in target tile (in pixels).
* @return The X map location of the tile.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTileX(x: number): number;
/**
* Convert a pixel coordinate to a tile coordinate.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the point in target tile (in pixels).
* @param y Y position of the point in target tile (in pixels).
* @param point The Point/object to update.
* @return A Point/object with its `x` and `y` properties set.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTileXY(x: number, y: number, point: Phaser.Point): Phaser.Point;
/**
* Convert a pixel value to a tile coordinate.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param y Y position of the point in target tile (in pixels).
* @return The Y map location of the tile.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getTileY(y: number): number;
/**
* Automatically called by World.postUpdate. Handles cache updates.
*/
postUpdate(): void;
/**
* Renders the tiles to the layer canvas and pushes to the display.
*/
render(): void;
/**
* Sets the world size to match the size of this layer.
*/
resizeWorld(): void;
/**
* The TilemapLayer caches tileset look-ups.
*
* Call this method of clear the cache if tilesets have been added or updated after the layer has been rendered.
*/
resetTilesetCache(): void;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* This method will set the scale of the tilemap as well as update the underlying block data of this layer
*
* @param xScale The scale factor along the X-plane - Default: 1
* @param yScale The scale factor along the Y-plane
*/
setScale(xScale?: number, yScale?: number): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
updateMax(): void;
}
/**
* Phaser.TilemapParser parses data objects from Phaser.Loader that need more preparation before they can be inserted into a Tilemap.
*/
class TilemapParser {
/**
* Returns an empty map data object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Generated map data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getEmptyData(tileWidth?: number, tileHeight?: number, width?: number, height?: number): any;
/**
* Parse tilemap data from the cache and creates a Tilemap object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Game reference to the currently running game.
* @param key The key of the tilemap in the Cache.
* @param tileWidth The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @param tileHeight The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @param width The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. - Default: 10
* @param height The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. - Default: 10
* @return The parsed map object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static parse(game: Phaser.Game, key: string, tileWidth?: number, tileHeight?: number, width?: number, height?: number): any;
/**
* Parses a CSV file into valid map data.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param data The CSV file data.
* @param tileWidth The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @param tileHeight The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. - Default: 32
* @return Generated map data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static parseCSV(key: string, data: string, tileWidth?: number, tileHeight?: number): any;
/**
* Parses a Tiled JSON file into valid map data.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param json The JSON map data.
* @return Generated and parsed map data.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static parseJSON(json: any): any;
}
/**
* A Tile set is a combination of an image containing the tiles and collision data per tile.
*
* Tilesets are normally created automatically when Tiled data is loaded.
*/
class Tileset {
/**
* A Tile set is a combination of an image containing the tiles and collision data per tile.
*
* Tilesets are normally created automatically when Tiled data is loaded.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param name The name of the tileset in the map data.
* @param firstgid The first tile index this tileset contains.
* @param width Width of each tile (in pixels). - Default: 32
* @param height Height of each tile (in pixels). - Default: 32
* @param margin The margin around all tiles in the sheet (in pixels). - Default: 0
* @param spacing The spacing between each tile in the sheet (in pixels). - Default: 0
* @param properties Custom Tileset properties. - Default: {}
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(name: string, firstgid: number, width?: number, height?: number, margin?: number, spacing?: number, properties?: any);
/**
* The number of tile columns in the tileset.
*/
columns: number;
/**
* The Tiled firstgid value.
* This is the starting index of the first tile index this Tileset contains.
*/
firstgid: number;
/**
* The cached image that contains the individual tiles. Use {@link Phaser.Tileset.setImage setImage} to set.
*/
image: any;
/**
* The name of the Tileset.
*/
name: string;
/**
* Tileset-specific properties that are typically defined in the Tiled editor.
*/
properties: any;
/**
* The number of tile rows in the the tileset.
*/
rows: number;
/**
* The height of each tile (in pixels).
*/
tileHeight: number;
/**
* The margin around the tiles in the sheet (in pixels).
* Use `setSpacing` to change.
*/
tileMargin: number;
/**
* The spacing between each tile in the sheet (in pixels).
* Use `setSpacing` to change.
*/
tileSpacing: number;
/**
* The width of each tile (in pixels).
*/
tileWidth: number;
/**
* The total number of tiles in the tileset.
*/
total: number;
/**
* Returns true if and only if this tileset contains the given tile index.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return True if this tileset contains the given index.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
containsTileIndex(tileIndex: number): boolean;
/**
* Draws a tile from this Tileset at the given coordinates on the context.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param context The context to draw the tile onto.
* @param x The x coordinate to draw to.
* @param y The y coordinate to draw to.
* @param index The index of the tile within the set to draw.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
draw(context: CanvasRenderingContext2D, x: number, y: number, index: number): void;
/**
* Set the image associated with this Tileset and update the tile data.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param image The image that contains the tiles.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setImage(image: any): void;
/**
* Sets tile spacing and margins.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tileMargin The margin around the tiles in the sheet (in pixels).
* @param tileSpacing The spacing between the tiles in the sheet (in pixels).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setSpacing(margin?: number, spacing?: number): void;
}
/**
* A TileSprite is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so.
* Please note that TileSprites, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling.
*/
class TileSprite extends PIXI.TilingSprite {
/**
* A TileSprite is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so.
* Please note that TileSprites, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param x The x coordinate (in world space) to position the TileSprite at.
* @param y The y coordinate (in world space) to position the TileSprite at.
* @param width The width of the TileSprite.
* @param height The height of the TileSprite.
* @param key This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param frame If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
constructor(game: Phaser.Game, x: number, y: number, width: number, height: number, key?: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture, frame?: string|number);
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
alive: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The angle property is the rotation of the Game Object in *degrees* from its original orientation.
*
* Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
*
* Values outside this range are added to or subtracted from 360 to obtain a value within the range.
* For example, the statement player.angle = 450 is the same as player.angle = 90.
*
* If you wish to work in radians instead of degrees you can use the property `rotation` instead.
* Working in radians is slightly faster as it doesn't have to perform any calculations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
angle: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance.
* Through it you can create, play, pause and stop animations.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
animations: Phaser.AnimationManager;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object with `autoCull` set to true will check its bounds against the World Camera every frame.
* If it is not intersecting the Camera bounds at any point then it has its `renderable` property set to `false`.
* This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.
*
* This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
* or you have tested performance and find it acceptable.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: false
*/
autoCull: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* `body` is the Game Objects physics body. Once a Game Object is enabled for physics you access all associated
* properties and methods via it.
*
* By default Game Objects won't add themselves to any physics system and their `body` property will be `null`.
*
* To enable this Game Object for physics you need to call `game.physics.enable(object, system)` where `object` is this object
* and `system` is the Physics system you are using. If none is given it defaults to `Phaser.Physics.Arcade`.
*
* You can alternatively call `game.physics.arcade.enable(object)`, or add this Game Object to a physics enabled Group.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Important: Enabling a Game Object for P2 or Ninja physics will automatically set its `anchor` property to 0.5,
* so the physics body is centered on the Game Object.
*
* If you need a different result then adjust or re-create the Body shape offsets manually or reset the anchor after enabling physics.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: null
*/
body: any;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if `fixedToCamera` is true.
*
* The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraOffset: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If this is set to `true` the Game Object checks if it is within the World bounds each frame.
*
* When it is no longer intersecting the world bounds it dispatches the `onOutOfBounds` event.
*
* If it was *previously* out of bounds but is now intersecting the world bounds again it dispatches the `onEnterBounds` event.
*
* It also optionally kills the Game Object if `outOfBoundsKill` is `true`.
*
* When `checkWorldBounds` is enabled it forces the Game Object to calculate its full bounds every frame.
*
* This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
* or you have tested performance and find it acceptable.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: false
*/
checkWorldBounds: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* As a Game Object runs through its destroy method this flag is set to true,
* and can be checked in any sub-systems or plugins it is being destroyed from.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
destroyPhase: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
* Game Object, or any of its components.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
events: Phaser.Events;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Controls if this Game Object is processed by the core game loop.
* If this Game Object has a physics body it also controls if its physics body is updated or not.
* When `exists` is set to `false` it will remove its physics body from the physics world if it has one.
* It also toggles the `visible` property to false as well.
*
* Setting `exists` to true will add its physics body back in to the physics world, if it has one.
* It will also set the `visible` property to `true`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
exists: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A Game Object that is "fixed" to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.
*
* The values are adjusted at the rendering stage, overriding the Game Objects actual world position.
*
* The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
* the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
* regardless where in the world the camera is.
*
* The offsets are stored in the `cameraOffset` property.
*
* Note that the `cameraOffset` values are in addition to any parent of this Game Object on the display list.
*
* Be careful not to set `fixedToCamera` on Game Objects which are in Groups that already have `fixedToCamera` enabled on them.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
fixedToCamera: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Gets or sets the current frame index of the texture being used to render this Game Object.
*
* To change the frame set `frame` to the index of the new frame in the sprite sheet you wish this Game Object to use,
* for example: `player.frame = 4`.
*
* If the frame index given doesn't exist it will revert to the first frame found in the texture.
*
* If you are using a texture atlas then you should use the `frameName` property instead.
*
* If you wish to fully replace the texture being used see `loadTexture`.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
frame: string|number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Gets or sets the current frame name of the texture being used to render this Game Object.
*
* To change the frame set `frameName` to the name of the new frame in the texture atlas you wish this Game Object to use,
* for example: `player.frameName = "idle"`.
*
* If the frame name given doesn't exist it will revert to the first frame found in the texture and throw a console warning.
*
* If you are using a sprite sheet then you should use the `frame` property instead.
*
* If you wish to fully replace the texture being used see `loadTexture`.
*/
frameName: string;
/**
* A Game Object is considered `fresh` if it has just been created or reset and is yet to receive a renderer transform update.
* This property is mostly used internally by the physics systems, but is exposed for the use of plugins.
*/
fresh: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The Input Handler for this Game Object.
*
* By default it is disabled. If you wish this Game Object to process input events you should enable it with: `inputEnabled = true`.
*
* After you have done this, this property will be a reference to the Phaser InputHandler.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
input: Phaser.InputHandler;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* By default a Game Object won't process any input events. By setting `inputEnabled` to true a Phaser.InputHandler is created
* for this Game Object and it will then start to process click / touch events and more.
*
* You can then access the Input Handler via `this.input`.
*
* Note that Input related events are dispatched from `this.events`, i.e.: `events.onInputDown`.
*
* If you set this property to false it will stop the Input Handler from processing any more input events.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inputEnabled: boolean;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The key of the image or texture used by this Game Object during rendering.
* If it is a string it's the string used to retrieve the texture from the Phaser.Cache.
* It can also be an instance of a RenderTexture, BitmapData or PIXI.Texture.
* If a Game Object is created without a key it is automatically assigned the key `__default` which is a 32x32 transparent PNG stored within the Cache.
* If a Game Object is given a key which doesn't exist in the Cache it is re-assigned the key `__missing` which is a 32x32 PNG of a green box with a line through it.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* A user defined name given to this Game Object.
* This value isn't ever used internally by Phaser, it is meant as a game level property.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
name: string;
/**
* The coordinate of the object relative to the local coordinates of the parent.
*/
position: Phaser.Point;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The position the Game Object was located in the previous frame.
*/
previousPosition: Phaser.Point;
previousRoation: number;
/**
* The render order ID is used internally by the renderer and Input Manager and should not be modified.
* This property is mostly used internally by the renderers, but is exposed for the use of plugins.
*/
renderOrderID: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The const type of this object.
*/
type: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The world coordinates of this Game Object in pixels.
* Depending on where in the display list this Game Object is placed this value can differ from `position`,
* which contains the x/y coordinates relative to the Game Objects parent.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
world: Phaser.Point;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The z depth of this Game Object within its parent Group.
* No two objects in a Group can have the same z value.
* This value is adjusted automatically whenever the Group hierarchy changes.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
z: number;
/**
* Sets this TileSprite to automatically scroll in the given direction until stopped via TileSprite.stopScroll().
* The scroll speed is specified in pixels per second.
* A negative x value will scroll to the left. A positive x value will scroll to the right.
* A negative y value will scroll up. A positive y value will scroll down.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x Horizontal scroll speed in pixels per second.
* @param y Vertical scroll speed in pixels per second.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
autoScroll(x: number, y: number): void;
/**
* Destroys the TileSprite. This removes it from its parent group, destroys the event and animation handlers if present
* and nulls its reference to game, freeing it up for garbage collection.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param destroyChildren Should every child of this object have its destroy method called? - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
destroy(destroyChildren?: boolean): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the `frame` or `frameName` properties instead.
*
* You should only use `loadTexture` if you want to replace the base texture entirely.
*
* Calling this method causes a WebGL texture update, so use sparingly or in low-intensity portions of your game, or if you know the new texture is already on the GPU.
*
* @param key This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
* @param frame If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
* @param stopAnimation If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
loadTexture(key: string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture, frame: string|number): void;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Plays an Animation.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The animation should have previously been created via `animations.add`.
*
* If the animation is already playing calling this again won't do anything.
* If you need to reset an already running animation do so directly on the Animation object itself or via `AnimationManager.stop`.
*
* @param name The name of the animation to be played, e.g. "fire", "walk", "jump". Must have been previously created via 'AnimationManager.add'.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frameRate The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used. - Default: null
* @param loop Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used. - Default: false
* @param killOnComplete If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed. - Default: false
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @return A reference to playing Animation.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
play(name: string, frameRate?: number, loop?: boolean, killOnComplete?: boolean): Phaser.Animation;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Internal method called by the World postUpdate cycle.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
postUpdate(): void;
/**
* Automatically called by World.preUpdate.
*/
preUpdate(): void;
/**
* Resets the TileSprite. This places the TileSprite at the given x/y world coordinates, resets the tilePosition and then
* sets alive, exists, visible and renderable all to true. Also resets the outOfBounds state.
* If the TileSprite has a physics body that too is reset.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The x coordinate (in world space) to position the Sprite at.
* @param y The y coordinate (in world space) to position the Sprite at.
* @return (Phaser.TileSprite) This instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
reset(x: number, y: number): Phaser.TileSprite;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Sets the texture frame the Game Object uses for rendering.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* This is primarily an internal method used by `loadTexture`, but is exposed for the use of plugins and custom classes.
*
* @param frame The Frame to be used by the texture.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setFrame(frame: Phaser.Frame): void;
/**
* Stops an automatically scrolling TileSprite.
*/
stopScroll(): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Override this method in your own custom objects to handle any update requirements.
* It is called immediately after `preUpdate` and before `postUpdate`.
* Remember if this Game Object has any children you should call update on those too.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(): void;
}
/**
* This is the core internal game clock.
*
* It manages the elapsed time and calculation of elapsed values, used for game object motion and tweens,
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* and also handles the standard Timer pool.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* To create a general timed event, use the master {@link Phaser.Timer} accessible through {@link Phaser.Time.events events}.
*/
class Time {
/**
* This is the core internal game clock.
*
* It manages the elapsed time and calculation of elapsed values, used for game object motion and tweens,
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* and also handles the standard Timer pool.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* To create a general timed event, use the master {@link Phaser.Timer} accessible through {@link Phaser.Time.events events}.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* If true then advanced profiling, including the fps rate, fps min/max and msMin/msMax are updated.
* Default: false
*/
advancedTiming: boolean;
/**
* The desired frame rate of the game.
*
* This is used is used to calculate the physic/logic multiplier and how to apply catch-up logic updates.
* Default: 60
*/
desiredFps: number;
/**
* Elapsed time since the last time update, in milliseconds, based on `now`.
*
* This value _may_ include time that the game is paused/inactive.
*
* _Note:_ This is updated only once per game loop - even if multiple logic update steps are done.
* Use {@link Phaser.Timer#physicsTime physicsTime} as a basis of game/logic calculations instead.
*/
elapsed: number;
/**
* A {@link Phaser.Timer} object bound to the master clock (this Time object) which events can be added to.
*/
events: Phaser.Timer;
/**
* The time in ms since the last time update, in milliseconds, based on `time`.
*
* This value is corrected for game pauses and will be "about zero" after a game is resumed.
*
* _Note:_ This is updated once per game loop - even if multiple logic update steps are done.
* Use {@link Phaser.Timer#physicsTime physicsTime} as a basis of game/logic calculations instead.
*/
elapsedMS: number;
/**
* Advanced timing result: Frames per second.
*
* Only calculated if {@link Phaser.Time#advancedTiming advancedTiming} is enabled.
*/
fps: number;
/**
* Advanced timing result: The highest rate the fps has reached (usually no higher than 60fps).
*
* Only calculated if {@link Phaser.Time#advancedTiming advancedTiming} is enabled.
* This value can be manually reset.
*/
fpsMax: number;
/**
* Advanced timing result: The lowest rate the fps has dropped to.
*
* Only calculated if {@link Phaser.Time#advancedTiming advancedTiming} is enabled.
* This value can be manually reset.
*/
fpsMin: number;
/**
* Advanced timing result: The number of render frames record in the last second.
*
* Only calculated if {@link Phaser.Time#advancedTiming advancedTiming} is enabled.
*/
frames: number;
/**
* Local reference to game.
*/
game: Phaser.Game;
lastTime: number;
/**
* Advanced timing result: The maximum amount of time the game has taken between consecutive frames.
*
* Only calculated if {@link Phaser.Time#advancedTiming advancedTiming} is enabled.
* This value can be manually reset.
*/
msMax: number;
/**
* Advanced timing result: The minimum amount of time the game has taken between consecutive frames.
*
* Only calculated if {@link Phaser.Time#advancedTiming advancedTiming} is enabled.
* This value can be manually reset.
* Default: 1000
*/
msMin: number;
/**
* An increasing value representing cumulative milliseconds since an undisclosed epoch.
*
* While this value is in milliseconds and can be used to compute time deltas,
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* it must must _not_ be used with `Date.now()` as it may not use the same epoch / starting reference.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
* The source may either be from a high-res source (eg. if RAF is available) or the standard Date.now;
* the value can only be relied upon within a particular game instance.
*/
now: number;
pausedTime: number;
/**
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
* Records how long the game was last paused, in milliseconds.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* (This is not updated until the game is resumed.)
*/
pauseDuration: number;
/**
* The physics update delta, in fractional seconds.
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
*
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* This should be used as an applicable multiplier by all logic update steps (eg. `preUpdate/postUpdate/update`)
* to ensure consistent game timing. Game/logic timing can drift from real-world time if the system
* is unable to consistently maintain the desired FPS.
*
* With fixed-step updates this is normally equivalent to `1.0 / desiredFps`.
*/
physicsElapsed: number;
/**
* The physics update delta, in milliseconds - equivalent to `physicsElapsed * 1000`.
*/
physicsElapsedMS: number;
/**
* The `now` when the previous update occurred.
*/
prevTime: number;
/**
* Scaling factor to make the game move smoothly in slow motion
* - 1.0 = normal speed
* - 2.0 = half speed
* Default: 1
*/
slowMotion: number;
/**
* The suggested frame rate for your game, based on an averaged real frame rate.
*
* _Note:_ This is not available until after a few frames have passed; use it after a few seconds (eg. after the menus)
* Default: null
*/
suggestedFps: number;
/**
* The `Date.now()` value when the time was last updated.
*/
time: number;
/**
* The time when the next call is expected when using setTimer to control the update loop
*/
timeExpected: number;
/**
* The value that setTimeout needs to work out when to next update
*/
timeToCall: number;
/**
* Adds an existing Phaser.Timer object to the Timer pool.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param timer An existing Phaser.Timer object.
* @return The given Phaser.Timer object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(timer: Phaser.Timer): Phaser.Timer;
/**
* Called automatically by Phaser.Game after boot. Should not be called directly.
*/
boot(): void;
/**
* Creates a new stand-alone Phaser.Timer object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param autoDestroy A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events). - Default: true
* @return The Timer object that was created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
create(autoDestroy?: boolean): Phaser.Timer;
/**
* How long has passed since the given time (in seconds).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param since The time you want to measure (in seconds).
* @return Duration between given time and now (in seconds).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
elapsedSecondsSince(since: number): number;
/**
* How long has passed since the given time.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param since The time you want to measure against.
* @return The difference between the given time and now.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
elapsedSince(since: number): number;
/**
* Remove all Timer objects, regardless of their state and clears all Timers from the {@link Phaser.Time#events events} timer.
*/
removeAll(): void;
/**
* Resets the private _started value to now and removes all currently running Timers.
*/
reset(): void;
/**
* The number of seconds that have elapsed since the game was started.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The number of seconds that have elapsed since the game was started.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
totalElapsedSeconds(): number;
/**
* Updates the game clock and if enabled the advanced timing data. This is called automatically by Phaser.Game.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param time The current relative timestamp; see {@link Phaser.Time#now now}.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(time: number): void;
}
/**
* A Timer is a way to create small re-usable (or disposable) objects that wait for a specific moment in time,
* and then run the specified callbacks.
*
* You can many events to a Timer, each with their own delays. A Timer uses milliseconds as its unit of time (there are 1000 ms in 1 second).
* So a delay to 250 would fire the event every quarter of a second.
*
* Timers are based on real-world (not physics) time, adjusted for game pause durations.
*/
class Timer {
/**
* A Timer is a way to create small re-usable (or disposable) objects that wait for a specific moment in time,
* and then run the specified callbacks.
*
* You can many events to a Timer, each with their own delays. A Timer uses milliseconds as its unit of time (there are 1000 ms in 1 second).
* So a delay to 250 would fire the event every quarter of a second.
*
* Timers are based on real-world (not physics) time, adjusted for game pause durations.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
* @param autoDestroy If true, the timer will automatically destroy itself after all the events have been dispatched (assuming no looping events). - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game, autoDestroy?: boolean);
/**
* Number of milliseconds in half a second.
*/
static HALF: number;
/**
* Number of milliseconds in a minute.
*/
static MINUTE: number;
/**
* Number of milliseconds in a quarter of a second.
*/
static QUARTER: number;
/**
* Number of milliseconds in a second.
*/
static SECOND: number;
/**
* If true, the timer will automatically destroy itself after all the events have been dispatched (assuming no looping events).
*/
autoDestroy: boolean;
/**
* The duration in ms remaining until the next event will occur.
*/
duration: number;
/**
* An array holding all of this timers Phaser.TimerEvent objects. Use the methods add, repeat and loop to populate it.
*/
events: Phaser.TimerEvent[];
/**
* An expired Timer is one in which all of its events have been dispatched and none are pending.
* Default: false
*/
expired: boolean;
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* The number of pending events in the queue.
*/
length: number;
/**
* The duration in milliseconds that this Timer has been running for.
*/
ms: number;
/**
* The time at which the next event will occur.
*/
next: number;
/**
* The time the next tick will occur.
*/
nextTick: number;
/**
* This signal will be dispatched when this Timer has completed which means that there are no more events in the queue.
*
* The signal is supplied with one argument, `timer`, which is this Timer object.
*/
onComplete: Phaser.Signal;
/**
* True if the Timer is actively running.
*
* Do not modify this boolean - use {@link Phaser.Timer#pause pause} (and {@link Phaser.Timer#resume resume}) to pause the timer.
* Default: false
*/
running: boolean;
/**
* The paused state of the Timer. You can pause the timer by calling Timer.pause() and Timer.resume() or by the game pausing.
* Default: false
*/
paused: boolean;
/**
* The duration in seconds that this Timer has been running for.
*/
seconds: number;
/**
* Adds a new Event to this Timer.
*
* The event will fire after the given amount of `delay` in milliseconds has passed, once the Timer has started running.
* The delay is in relation to when the Timer starts, not the time it was added. If the Timer is already running the delay will be calculated based on the timers current time.
*
* Make sure to call {@link Phaser.Timer#start start} after adding all of the Events you require for this Timer.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param delay The number of milliseconds that should elapse before the callback is invoked.
* @param callback The callback that will be called when the Timer event occurs.
* @param callbackContext The context in which the callback will be called.
* @param args Additional arguments that will be supplied to the callback.
* @return The Phaser.TimerEvent object that was created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(delay: number, callback: Function, callbackContext: any, ...args: any[]): Phaser.TimerEvent;
/**
* Clears any events from the Timer which have pendingDelete set to true and then resets the private _len and _i values.
*/
clearPendingEvents(): void;
/**
* Destroys this Timer. Any pending Events are not dispatched.
* The onComplete callbacks won't be called.
*/
destroy(): void;
/**
* Adds a new looped Event to this Timer that will repeat forever or until the Timer is stopped.
*
* The event will fire after the given amount of `delay` in milliseconds has passed, once the Timer has started running.
* The delay is in relation to when the Timer starts, not the time it was added. If the Timer is already running the delay will be calculated based on the timers current time.
*
* Make sure to call {@link Phaser.Timer#start start} after adding all of the Events you require for this Timer.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param delay The number of milliseconds that should elapse before the Timer will call the given callback.
* @param callback The callback that will be called when the Timer event occurs.
* @param callbackContext The context in which the callback will be called.
* @param args Additional arguments that will be supplied to the callback.
* @return The Phaser.TimerEvent object that was created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
loop(delay: number, callback: Function, callbackContext: any, ...args: any[]): Phaser.TimerEvent;
/**
* Orders the events on this Timer so they are in tick order.
* This is called automatically when new events are created.
*/
order(): void;
/**
* Pauses the Timer and all events in the queue.
*/
pause(): void;
/**
* Removes a pending TimerEvent from the queue.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The event to remove from the queue.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(event: Phaser.TimerEvent): boolean;
/**
Improve d.ts comments generation Add trimright in the comments, because there are a lot of comments with useless whitespaces.
2015-01-21 11:05:35 +00:00
* Removes all Events from this Timer and all callbacks linked to onComplete, but leaves the Timer running.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* The onComplete callbacks won't be called.
*/
removeAll(): void;
/**
* Adds a new TimerEvent that will always play through once and then repeat for the given number of iterations.
*
* The event will fire after the given amount of `delay` in milliseconds has passed, once the Timer has started running.
* The delay is in relation to when the Timer starts, not the time it was added. If the Timer is already running the delay will be calculated based on the timers current time.
*
* Make sure to call {@link Phaser.Timer#start start} after adding all of the Events you require for this Timer.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param delay The number of milliseconds that should elapse before the Timer will call the given callback.
* @param repeatCount The number of times the event will repeat once is has finished playback. A repeatCount of 1 means it will repeat itself once, playing the event twice in total.
* @param callback The callback that will be called when the Timer event occurs.
* @param callbackContext The context in which the callback will be called.
* @param args Additional arguments that will be supplied to the callback.
* @return The Phaser.TimerEvent object that was created.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
repeat(delay: number, repeatCount: number, callback: Function, callbackContext: any, ...args: any[]): Phaser.TimerEvent;
/**
* Resumes the Timer and updates all pending events.
*/
resume(): void;
/**
* Sort handler used by Phaser.Timer.order.
*/
sortHandler(a: any, b: any): number;
/**
* Starts this Timer running.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param delay The number of milliseconds that should elapse before the Timer will start. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
start(startDelay?: number): void;
/**
* Stops this Timer from running. Does not cause it to be destroyed if autoDestroy is set to true.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param clearEvents If true all the events in Timer will be cleared, otherwise they will remain. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
stop(clearEvents?: boolean): void;
/**
* The main Timer update event, called automatically by Phaser.Time.update.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param time The time from the core game clock.
* @return True if there are still events waiting to be dispatched, otherwise false if this Timer can be destroyed.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(time: number): boolean;
}
/**
* A TimerEvent is a single event that is processed by a Phaser.Timer.
*
* It consists of a delay, which is a value in milliseconds after which the event will fire.
* When the event fires it calls a specific callback with the specified arguments.
*
* Use {@link Phaser.Timer#add}, {@link Phaser.Timer#add}, or {@link Phaser.Timer#add} methods to create a new event.
*/
class TimerEvent {
/**
* A TimerEvent is a single event that is processed by a Phaser.Timer.
*
* It consists of a delay, which is a value in milliseconds after which the event will fire.
* When the event fires it calls a specific callback with the specified arguments.
*
* Use {@link Phaser.Timer#add}, {@link Phaser.Timer#add}, or {@link Phaser.Timer#add} methods to create a new event.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param timer The Timer object that this TimerEvent belongs to.
* @param delay The delay in ms at which this TimerEvent fires.
* @param tick The tick is the next game clock time that this event will fire at.
* @param repeatCount If this TimerEvent repeats it will do so this many times.
* @param loop True if this TimerEvent loops, otherwise false.
* @param callback The callback that will be called when the TimerEvent occurs.
* @param callbackContext The context in which the callback will be called.
* @param arguments Additional arguments to be passed to the callback.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(timer: Phaser.Timer, delay: number, tick: number, repeatCount: number, loop: boolean, callback: Function, callbackContext: any, ...args: any[]);
/**
* Additional arguments to be passed to the callback.
*/
args: any[];
/**
* The callback that will be called when the TimerEvent occurs.
*/
callback: Function;
/**
* The context in which the callback will be called.
*/
callbackContext: any;
/**
* The delay in ms at which this TimerEvent fires.
*/
delay: number;
/**
* True if this TimerEvent loops, otherwise false.
*/
loop: boolean;
/**
* A flag that controls if the TimerEvent is pending deletion.
*/
pendingDelete: boolean;
/**
* If this TimerEvent repeats it will do so this many times.
*/
repeatCount: number;
/**
* The tick is the next game clock time that this event will fire at.
*/
tick: number;
/**
* The Timer object that this TimerEvent belongs to.
*/
timer: Phaser.Timer;
}
/**
* Phaser.Touch handles touch events with your game. Note: Android 2.x only supports 1 touch event at once, no multi-touch.
*/
class Touch {
/**
* Phaser.Touch handles touch events with your game. Note: Android 2.x only supports 1 touch event at once, no multi-touch.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* The context under which callbacks are called.
*/
callbackContext: any;
disabled: boolean;
/**
* Touch events will only be processed if enabled.
* Default: true
*/
enabled: boolean;
/**
* The browser touch DOM event. Will be set to null if no touch event has ever been received.
* Default: null
*/
event: any;
/**
* A reference to the currently running game.
*/
game: Phaser.Game;
/**
* If true the TouchEvent will have prevent.default called on it.
* Default: true
*/
preventDefault: boolean;
/**
* A callback that can be fired on a touchCancel event.
*/
touchCancelCallback: Function;
/**
* A callback that can be fired on a touchEnd event.
*/
touchEndCallback: Function;
/**
* A callback that can be fired on a touchEnter event.
*/
touchEnterCallback: Function;
/**
* A callback that can be fired on a touchLeave event.
*/
touchLeaveCallback: Function;
/**
* A callback that can be fired on a touchMove event.
*/
touchMoveCallback: Function;
/**
* A callback that can be fired on a touchStart event.
*/
touchStartCallback: Function;
/**
* Consumes all touchmove events on the document (only enable this if you know you need it!).
*/
consumeTouchMove(): void;
/**
* Touch cancel - touches that were disrupted (perhaps by moving into a plugin or browser chrome).
* Occurs for example on iOS when you put down 4 fingers and the app selector UI appears.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Touch.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onTouchCancel(event: any): void;
/**
* The handler for the touchend events.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Touch.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onTouchEnd(event: any): void;
/**
* For touch enter and leave its a list of the touch points that have entered or left the target.
* Doesn't appear to be supported by most browsers on a canvas element yet.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Touch.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onTouchEnter(event: any): void;
/**
* For touch enter and leave its a list of the touch points that have entered or left the target.
* Doesn't appear to be supported by most browsers on a canvas element yet.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Touch.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onTouchLeave(event: any): void;
/**
* The handler for the touchmove events.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Touch.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onTouchMove(event: any): void;
/**
* The internal method that handles the touchstart event from the browser.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param event The native event from the browser. This gets stored in Touch.event.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onTouchStart(event: any): void;
/**
* Starts the event listeners running.
*/
start(): void;
/**
* Stop the event listeners.
*/
stop(): void;
}
/**
* A Tween allows you to alter one or more properties of a target object over a defined period of time.
* This can be used for things such as alpha fading Sprites, scaling them or motion.
* Use `Tween.to` or `Tween.from` to set-up the tween values. You can create multiple tweens on the same object
* by calling Tween.to multiple times on the same Tween. Additional tweens specified in this way become "child" tweens and
* are played through in sequence. You can use Tween.timeScale and Tween.reverse to control the playback of this Tween and all of its children.
*/
class Tween {
/**
* A Tween allows you to alter one or more properties of a target object over a defined period of time.
* This can be used for things such as alpha fading Sprites, scaling them or motion.
* Use `Tween.to` or `Tween.from` to set-up the tween values. You can create multiple tweens on the same object
* by calling Tween.to multiple times on the same Tween. Additional tweens specified in this way become "child" tweens and
* are played through in sequence. You can use Tween.timeScale and Tween.reverse to control the playback of this Tween and all of its children.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param target The target object, such as a Phaser.Sprite or Phaser.Sprite.scale.
* @param game Current game instance.
* @param manager The TweenManager responsible for looking after this Tween.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(target: any, game: Phaser.Game, manager: Phaser.TweenManager);
/**
* If this Tween is chained to another this holds a reference to it.
*/
chainedTween: Phaser.Tween;
/**
* The current Tween child being run.
* Default: 0
*/
current: number;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* If the tween is running this is set to true, otherwise false. Tweens that are in a delayed state or waiting to start are considered as being running.
* Default: false
*/
isRunning: boolean;
/**
* Is this Tween paused or not?
* Default: false
*/
isPaused: boolean;
/**
* Reference to the TweenManager responsible for updating this Tween.
*/
manager: Phaser.TweenManager;
/**
* The onChildComplete event is fired when the Tween or any of its children completes.
* Fires every time a child completes unless a child is set to repeat forever.
* It will be sent 2 parameters: the target object and this tween.
*/
onChildComplete: Phaser.Signal;
/**
* The onComplete event is fired when the Tween and all of its children completes. Does not fire if the Tween is set to loop or repeatAll(-1).
* It will be sent 2 parameters: the target object and this tween.
*/
onComplete: Phaser.Signal;
/**
* The onLoop event is fired if the Tween or any child tween loops.
* It will be sent 2 parameters: the target object and this tween.
*/
onLoop: Phaser.Signal;
/**
* The onRepeat event is fired if the Tween and all of its children repeats. If this tween has no children this will never be fired.
* It will be sent 2 parameters: the target object and this tween.
*/
onRepeat: Phaser.Signal;
/**
* The onStart event is fired when the Tween begins. If there is a delay before the tween starts then onStart fires after the delay is finished.
* It will be sent 2 parameters: the target object and this tween.
*/
onStart: Phaser.Signal;
/**
* True if this Tween is ready to be deleted by the TweenManager.
* Default: false
*/
pendingDelete: boolean;
/**
* Target property cache used when building the child data values.
*/
properties: any;
/**
* If the Tween and any child tweens are set to repeat this contains the current repeat count.
*/
repeatCounter: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
//repeatDelay: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* If set to `true` the current tween will play in reverse.
* If the tween hasn't yet started this has no effect.
* If there are child tweens then all child tweens will play in reverse from the current point.
* Default: false
*/
reverse: boolean;
/**
* The target object, such as a Phaser.Sprite or property like Phaser.Sprite.scale.
*/
target: any;
/**
* An Array of TweenData objects that comprise the different parts of this Tween.
*/
timeline: Phaser.TweenData[];
/**
* The speed at which the tweens will run. A value of 1 means it will match the game frame rate. 0.5 will run at half the frame rate. 2 at double the frame rate, etc.
* If a tweens duration is 1 second but timeScale is 0.5 then it will take 2 seconds to complete.
* Default: 1
*/
timeScale: number;
/**
* Gets the total duration of this Tween, including all child tweens, in milliseconds.
*/
totalDuration: number;
/**
* This method allows you to chain tweens together. Any tween chained to this tween will have its `Tween.start` method called
* as soon as this tween completes. If this tween never completes (i.e. repeatAll or loop is set) then the chain will never progress.
* Note that `Tween.onComplete` will fire when *this* tween completes, not when the whole chain completes.
* For that you should listen to `onComplete` on the final tween in your chain.
*
* If you pass multiple tweens to this method they will be joined into a single long chain.
* For example if this is Tween A and you pass in B, C and D then B will be chained to A, C will be chained to B and D will be chained to C.
* Any previously chained tweens that may have been set will be overwritten.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tweens One or more tweens that will be chained to this one.
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
chain(...args: any[]): Phaser.Tween;
/**
* Sets the delay in milliseconds before this tween will start. If there are child tweens it sets the delay before the first child starts.
* The delay is invoked as soon as you call `Tween.start`. If the tween is already running this method doesn't do anything for the current active tween.
* If you have not yet called `Tween.to` or `Tween.from` at least once then this method will do nothing, as there are no tweens to delay.
* If you have child tweens and pass -1 as the index value it sets the delay across all of them.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration The amount of time in ms that the Tween should wait until it begins once started is called. Set to zero to remove any active delay.
* @param index If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the delay on all the children. - Default: 0
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
delay(duration: number, index?: number): Phaser.Tween;
/**
* Set easing function this tween will use, i.e. Phaser.Easing.Linear.None.
* The ease function allows you define the rate of change. You can pass either a function such as Phaser.Easing.Circular.Out or a string such as "Circ".
* ".easeIn", ".easeOut" and "easeInOut" variants are all supported for all ease types.
* If you have child tweens and pass -1 as the index value it sets the easing function defined here across all of them.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param ease The easing function this tween will use, i.e. Phaser.Easing.Linear.None.
* @param index If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the easing function on all children. - Default: 0
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
easing(ease: Function, index?: number): Phaser.Tween;
/**
* Set easing function this tween will use, i.e. Phaser.Easing.Linear.None.
* The ease function allows you define the rate of change. You can pass either a function such as Phaser.Easing.Circular.Out or a string such as "Circ".
* ".easeIn", ".easeOut" and "easeInOut" variants are all supported for all ease types.
* If you have child tweens and pass -1 as the index value it sets the easing function defined here across all of them.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param ease The easing function this tween will use, i.e. Phaser.Easing.Linear.None.
* @param index If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the easing function on all children. - Default: 0
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
easing(ease: string, index?: number): Phaser.Tween;
/**
* Sets this tween to be a `from` tween on the properties given. A `from` tween sets the target to the destination value and tweens to its current value.
* For example a Sprite with an `x` coordinate of 100 tweened from `x` 500 would be set to `x` 500 and then tweened to `x` 100 by giving a properties object of `{ x: 500 }`.
* The ease function allows you define the rate of change. You can pass either a function such as Phaser.Easing.Circular.Out or a string such as "Circ".
* ".easeIn", ".easeOut" and "easeInOut" variants are all supported for all ease types.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param properties An object containing the properties you want to tween., such as `Sprite.x` or `Sound.volume`. Given as a JavaScript object.
* @param duration Duration of this tween in ms. - Default: 1000
* @param ease Easing function. If not set it will default to Phaser.Easing.Default, which is Phaser.Easing.Linear.None by default but can be over-ridden. - Default: null
* @param autoStart Set to `true` to allow this tween to start automatically. Otherwise call Tween.start(). - Default: false
* @param delay Delay before this tween will start in milliseconds. Defaults to 0, no delay. - Default: 0
* @param repeat Should the tween automatically restart once complete? If you want it to run forever set as -1. This only effects this induvidual tween, not any chained tweens. - Default: 0
* @param yoyo A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead. - Default: false
* @return This Tween object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
from(properties: any, duration?: number, ease?: Function, autoStart?: boolean, delay?: number, repeat?: number, yoyo?: boolean): Phaser.Tween;
/**
* Sets this tween to be a `from` tween on the properties given. A `from` tween sets the target to the destination value and tweens to its current value.
* For example a Sprite with an `x` coordinate of 100 tweened from `x` 500 would be set to `x` 500 and then tweened to `x` 100 by giving a properties object of `{ x: 500 }`.
* The ease function allows you define the rate of change. You can pass either a function such as Phaser.Easing.Circular.Out or a string such as "Circ".
* ".easeIn", ".easeOut" and "easeInOut" variants are all supported for all ease types.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param properties An object containing the properties you want to tween., such as `Sprite.x` or `Sound.volume`. Given as a JavaScript object.
* @param duration Duration of this tween in ms. - Default: 1000
* @param ease Easing function. If not set it will default to Phaser.Easing.Default, which is Phaser.Easing.Linear.None by default but can be over-ridden. - Default: null
* @param autoStart Set to `true` to allow this tween to start automatically. Otherwise call Tween.start(). - Default: false
* @param delay Delay before this tween will start in milliseconds. Defaults to 0, no delay. - Default: 0
* @param repeat Should the tween automatically restart once complete? If you want it to run forever set as -1. This only effects this induvidual tween, not any chained tweens. - Default: 0
* @param yoyo A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead. - Default: false
* @return This Tween object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
from(properties: any, duration?: number, ease?: string, autoStart?: boolean, delay?: number, repeat?: number, yoyo?: boolean): Phaser.Tween;
/**
* This will generate an array populated with the tweened object values from start to end.
* It works by running the tween simulation at the given frame rate based on the values set-up in Tween.to and Tween.from.
* It ignores delay and repeat counts and any chained tweens, but does include child tweens.
* Just one play through of the tween data is returned, including yoyo if set.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frameRate The speed in frames per second that the data should be generated at. The higher the value, the larger the array it creates. - Default: 60
* @param data If given the generated data will be appended to this array, otherwise a new array will be returned.
* @return An array of tweened values.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
generateData(frameRate?: number, data?: any): any[];
/**
* Sets the interpolation function the tween will use. By default it uses Phaser.Math.linearInterpolation.
* Also available: Phaser.Math.bezierInterpolation and Phaser.Math.catmullRomInterpolation.
* The interpolation function is only used if the target properties is an array.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* If you have child tweens and pass -1 as the index value and it will set the interpolation function across all of them.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param interpolation The interpolation function to use (Phaser.Math.linearInterpolation by default)
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param context The context under which the interpolation function will be run.
* @param index If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the interpolation function on all children. - Default: 0
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
interpolation(interpolation: Function, context?: any, index?: number): Phaser.Tween;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Enables the looping of this tween and all child tweens. If this tween has no children this setting has no effect.
* If `value` is `true` then this is the same as setting `Tween.repeatAll(-1)`.
* If `value` is `false` it is the same as setting `Tween.repeatAll(0)` and will reset the `repeatCounter` to zero.
*
* Usage:
* game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
* .to({ y: 300 }, 1000, Phaser.Easing.Linear.None)
* .to({ x: 0 }, 1000, Phaser.Easing.Linear.None)
* .to({ y: 0 }, 1000, Phaser.Easing.Linear.None)
* .loop();
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param value If `true` this tween and any child tweens will loop once they reach the end. Set to `false` to remove an active loop. - Default: true
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
loop(value?: boolean): Phaser.Tween;
/**
* Sets a callback to be fired each time this tween updates.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param callback The callback to invoke each time this tween is updated. Set to `null` to remove an already active callback.
* @param callbackContext The context in which to call the onUpdate callback.
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
onUpdateCallback(callback: Function, callbackContext: any): Phaser.Tween;
/**
* Pauses the tween. Resume playback with Tween.resume.
*/
pause(): void;
/**
* Sets the number of times this tween will repeat.
* If you have not yet called `Tween.to` or `Tween.from` at least once then this method will do nothing, as there are no tweens to repeat.
* If you have child tweens and pass -1 as the index value it sets the number of times they'll repeat across all of them.
* If you wish to define how many times this Tween and all children will repeat see Tween.repeatAll.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param total How many times a tween should repeat before completing. Set to zero to remove an active repeat. Set to -1 to repeat forever.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param repeat This is the amount of time to pause (in ms) before the repeat will start. - Default: 0
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the repeat value on all the children. - Default: 0
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
repeat(total: number, repeatDelay?: number, index?: number): Phaser.Tween;
/**
* Sets the delay in milliseconds before this tween will repeat itself.
* The repeatDelay is invoked as soon as you call `Tween.start`. If the tween is already running this method doesn't do anything for the current active tween.
* If you have not yet called `Tween.to` or `Tween.from` at least once then this method will do nothing, as there are no tweens to set repeatDelay on.
* If you have child tweens and pass -1 as the index value it sets the repeatDelay across all of them.
*
* @param duration The amount of time in ms that the Tween should wait until it repeats or yoyos once start is called. Set to zero to remove any active repeatDelay.
* @param index If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the repeatDelay on all the children. - Default: 0
* @return This tween. Useful for method chaining.
*/
repeatDelay(duration: number, index?: number): Phaser.Tween;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
repeatAll(total?: number): Phaser.Tween;
/**
* Resumes a paused tween.
*/
resume(): void;
/**
* Starts the tween running. Can also be called by the autoStart parameter of `Tween.to` or `Tween.from`.
* This sets the `Tween.isRunning` property to `true` and dispatches a `Tween.onStart` signal.
* If the Tween has a delay set then nothing will start tweening until the delay has expired.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index If this Tween contains child tweens you can specify which one to start from. The default is zero, i.e. the first tween created. - Default: 0
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
start(index?: number): Phaser.Tween;
/**
* Stops the tween if running and flags it for deletion from the TweenManager.
* If called directly the `Tween.onComplete` signal is not dispatched and no chained tweens are started unless the complete parameter is set to `true`.
* If you just wish to pause a tween then use Tween.pause instead.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param complete Set to `true` to dispatch the Tween.onComplete signal. - Default: false
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
stop(complete?: boolean): Phaser.Tween;
/**
* Sets this tween to be a `to` tween on the properties given. A `to` tween starts at the current value and tweens to the destination value given.
* For example a Sprite with an `x` coordinate of 100 could be tweened to `x` 200 by giving a properties object of `{ x: 200 }`.
* The ease function allows you define the rate of change. You can pass either a function such as Phaser.Easing.Circular.Out or a string such as "Circ".
* ".easeIn", ".easeOut" and "easeInOut" variants are all supported for all ease types.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param properties An object containing the properties you want to tween, such as `Sprite.x` or `Sound.volume`. Given as a JavaScript object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration Duration of this tween in ms. - Default: 1000
* @param ease Easing function. If not set it will default to Phaser.Easing.Default, which is Phaser.Easing.Linear.None by default but can be over-ridden. - Default: null
* @param autoStart Set to `true` to allow this tween to start automatically. Otherwise call Tween.start(). - Default: false
* @param delay Delay before this tween will start in milliseconds. Defaults to 0, no delay. - Default: 0
* @param repeat Should the tween automatically restart once complete? If you want it to run forever set as -1. This only effects this induvidual tween, not any chained tweens. - Default: 0
* @param yoyo A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead. - Default: false
* @return This Tween object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
to(properties: any, duration?: number, ease?: Function, autoStart?: boolean, delay?: number, repeat?: number, yoyo?: boolean): Phaser.Tween;
/**
* Sets this tween to be a `to` tween on the properties given. A `to` tween starts at the current value and tweens to the destination value given.
* For example a Sprite with an `x` coordinate of 100 could be tweened to `x` 200 by giving a properties object of `{ x: 200 }`.
* The ease function allows you define the rate of change. You can pass either a function such as Phaser.Easing.Circular.Out or a string such as "Circ".
* ".easeIn", ".easeOut" and "easeInOut" variants are all supported for all ease types.
*
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param properties An object containing the properties you want to tween, such as `Sprite.x` or `Sound.volume`. Given as a JavaScript object.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param duration Duration of this tween in ms. - Default: 1000
* @param ease Easing function. If not set it will default to Phaser.Easing.Default, which is Phaser.Easing.Linear.None by default but can be over-ridden. - Default: null
* @param autoStart Set to `true` to allow this tween to start automatically. Otherwise call Tween.start(). - Default: false
* @param delay Delay before this tween will start in milliseconds. Defaults to 0, no delay. - Default: 0
* @param repeat Should the tween automatically restart once complete? If you want it to run forever set as -1. This only effects this induvidual tween, not any chained tweens. - Default: 0
* @param yoyo A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead. - Default: false
* @return This Tween object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
to(properties: any, duration?: number, ease?: string, autoStart?: boolean, delay?: number, repeat?: number, yoyo?: boolean): Phaser.Tween;
/**
* Core tween update function called by the TweenManager. Does not need to be invoked directly.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param time A timestamp passed in by the TweenManager.
* @return false if the tween and all child tweens have completed and should be deleted from the manager, otherwise true (still active).
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(time: number): boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* Updates either a single TweenData or all TweenData objects properties to the given value.
* Used internally by methods like Tween.delay, Tween.yoyo, etc. but can also be called directly if you know which property you want to tweak.
* The property is not checked, so if you pass an invalid one you'll generate a run-time error.
*
* @param property The property to update.
* @param value The value to set the property to.
* @param index If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the delay on all the children. - Default: 0
* @return This tween. Useful for method chaining.
*/
updateTweenData(property: string, value: number | Function, index?: number): Phaser.Tween;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* A Tween that has yoyo set to true will run through from its starting values to its end values and then play back in reverse from end to start.
* Used in combination with repeat you can create endless loops.
* If you have not yet called `Tween.to` or `Tween.from` at least once then this method will do nothing, as there are no tweens to yoyo.
* If you have child tweens and pass -1 as the index value it sets the yoyo property across all of them.
* If you wish to yoyo this Tween and all of its children then see Tween.yoyoAll.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param enable Set to true to yoyo this tween, or false to disable an already active yoyo.
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* @param yoyoDelay This is the amount of time to pause (in ms) before the yoyo will start. - Default: 0
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param index If this tween has more than one child this allows you to target a specific child. If set to -1 it will set yoyo on all the children. - Default: 0
* @return This tween. Useful for method chaining.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
yoyo(enable: boolean, yoyoDelay?: number, index?: number): Phaser.Tween;
/**
* Sets the delay in milliseconds before this tween will run a yoyo (only applies if yoyo is enabled).
* The repeatDelay is invoked as soon as you call `Tween.start`. If the tween is already running this method doesn't do anything for the current active tween.
* If you have not yet called `Tween.to` or `Tween.from` at least once then this method will do nothing, as there are no tweens to set repeatDelay on.
* If you have child tweens and pass -1 as the index value it sets the repeatDelay across all of them.
*
* @param duration The amount of time in ms that the Tween should wait until it repeats or yoyos once start is called. Set to zero to remove any active yoyoDelay.
* @param index If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the yoyoDelay on all the children. - Default: 0
* @return This tween. Useful for method chaining.
*/
yoyoDelay(duration: number, index?: number): Phaser.Tween;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
}
/**
* A Phaser.Tween contains at least one TweenData object. It contains all of the tween data values, such as the
* starting and ending values, the ease function, interpolation and duration. The Tween acts as a timeline manager for
* TweenData objects and can contain multiple TweenData objects.
*/
class TweenData {
/**
* A Phaser.Tween contains at least one TweenData object. It contains all of the tween data values, such as the
* starting and ending values, the ease function, interpolation and duration. The Tween acts as a timeline manager for
* TweenData objects and can contain multiple TweenData objects.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param parent The Tween that owns this TweenData object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(parent: Phaser.Tween);
static COMPLETE: number;
static LOOPED: number;
static PENDING: number;
static RUNNING: number;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* The amount to delay by until the Tween starts (in ms). Only applies to the start, use repeatDelay to handle repeats.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* Default: 0
*/
delay: number;
/**
* Current time value.
*/
dt: number;
/**
* The duration of the tween in ms.
* Default: 1000
*/
duration: number;
/**
* The easing function used for the Tween.
* Default: Phaser.Easing.Default
*/
easingFunction: Function;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* When a Tween is yoyoing this value holds if it's currently playing forwards (false) or in reverse (true).
* Default: false
*/
inReverse: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* True if the Tween will use interpolation (i.e. is an Array to Array tween)
* Default: false
*/
interpolate: boolean;
interpolateFunctionContext: Phaser.Math;
/**
* The interpolation function context used for the Tween.
* Default: Phaser.Math
*/
interpolationContext: Phaser.Math;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* The interpolation function used for the Tween.
* Default: Phaser.Math.linearInterpolation
*/
interpolationFunction: Function;
/**
* If the tween is running this is set to `true`. Unless Phaser.Tween a TweenData that is waiting for a delay to expire is *not* considered as running.
* Default: false
*/
isRunning: boolean;
/**
* Is this a from tween or a to tween?
* Default: false
*/
isFrom: boolean;
/**
* The Tween which owns this TweenData.
*/
parent: Phaser.Tween;
/**
* A value between 0 and 1 that represents how far through the duration this tween is.
*/
percent: number;
/**
* If the Tween is set to repeat this contains the current repeat count.
*/
repeatCounter: number;
/**
* The time the Tween started or null if it hasn't yet started.
*/
startTime: number;
/**
* The current calculated value.
*/
value: number;
/**
* True if the Tween is set to yoyo, otherwise false.
* Default: false
*/
yoyo: boolean;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* The amount of time in ms between yoyos of this tween.
*/
yoyoDelay: number;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
from(properties: any, duration?: number, ease?: Function, delay?: number, repeat?: number, yoyo?: boolean): Phaser.TweenData;
/**
* This will generate an array populated with the tweened object values from start to end.
* It works by running the tween simulation at the given frame rate based on the values set-up in Tween.to and Tween.from.
* Just one play through of the tween data is returned, including yoyo if set.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param frameRate The speed in frames per second that the data should be generated at. The higher the value, the larger the array it creates. - Default: 60
* @return An array of tweened values.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
generateData(frameRate?: number): any[];
/**
* Checks if this Tween is meant to repeat or yoyo and handles doing so.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Either Phaser.TweenData.LOOPED or Phaser.TweenData.COMPLETE.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
repeat(): number;
/**
* Starts the Tween running.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return This Tween object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
start(): Phaser.TweenData;
to(properties: any, duration?: number, ease?: Function, delay?: number, repeat?: number, yoyo?: boolean): Phaser.TweenData;
/**
* Updates this Tween. This is called automatically by Phaser.Tween.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return The current status of this Tween. One of the Phaser.TweenData constants: PENDING, RUNNING, LOOPED or COMPLETE.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(): number;
}
/**
* Phaser.Game has a single instance of the TweenManager through which all Tween objects are created and updated.
* Tweens are hooked into the game clock and pause system, adjusting based on the game state.
*
* TweenManager is based heavily on tween.js by http://soledadpenades.com.
* The difference being that tweens belong to a games instance of TweenManager, rather than to a global TWEEN object.
* It also has callbacks swapped for Signals and a few issues patched with regard to properties and completion errors.
* Please see https://github.com/sole/tween.js for a full list of contributors.
*/
class TweenManager {
/**
* Phaser.Game has a single instance of the TweenManager through which all Tween objects are created and updated.
* Tweens are hooked into the game clock and pause system, adjusting based on the game state.
*
* TweenManager is based heavily on tween.js by http://soledadpenades.com.
* The difference being that tweens belong to a games instance of TweenManager, rather than to a global TWEEN object.
* It also has callbacks swapped for Signals and a few issues patched with regard to properties and completion errors.
* Please see https://github.com/sole/tween.js for a full list of contributors.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* Local reference to game.
*/
game: Phaser.Game;
/**
* Add a new tween into the TweenManager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tween The tween object you want to add.
* @return The tween object you added to the manager.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
add(tween: Phaser.Tween): Phaser.Tween;
/**
* Create a tween object for a specific object. The object can be any JavaScript object or Phaser object such as Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object Object the tween will be run on.
* @return The newly created tween object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
create(object: any): Phaser.Tween;
/**
* Get all the tween objects in an array.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Array with all tween objects.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
getAll(): Phaser.Tween[];
/**
* Checks to see if a particular Sprite is currently being tweened.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The object to check for tweens against.
* @return Returns true if the object is currently being tweened, false if not.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
isTweening(object: any): boolean;
/**
* Remove a tween from this manager.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param tween The tween object you want to remove.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
remove(tween: Phaser.Tween): Phaser.Tween;
/**
* Remove all tweens running and in the queue. Doesn't call any of the tween onComplete events.
*/
removeAll(): void;
/**
* Remove all tweens from a specific object, array of objects or Group.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param obj The object you want to remove the tweens from.
* @param children If passing a group, setting this to true will remove the tweens from all of its children instead of the group itself. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
removeFrom(obj: any, children?: boolean): void;
/**
* Resumes all currently paused tweens.
*/
resumeAll(): void;
/**
* Update all the tween objects you added to this manager.
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @return Return false if there's no tween to update, otherwise return true.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
update(): boolean;
/**
* Pauses all currently running tweens.
*/
pauseAll(): void;
}
class Utils {
/**
* This is a slightly modified version of http://api.jquery.com/jQuery.extend/
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param deep Perform a deep copy?
* @param target The target object to copy to.
* @return The extended object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static extend(deep: boolean, target: any): any;
/**
* Gets an objects property by string.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param obj The object to traverse.
* @param prop The property whose value will be returned.
* @return the value of the property or null if property isn't found .
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static getProperty(obj: any, prop: string): any;
/**
* This is a slightly modified version of jQuery.isPlainObject.
* A plain object is an object whose internal class property is [object Object].
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param obj The object to inspect.
* @return - true if the object is plain, otherwise false.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static isPlainObject(object: any): boolean;
/**
* Mixes the source object into the destination object, returning the newly modified destination object.
* Based on original code by @mudcube
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param from The object to copy (the source object).
* @param to The object to copy to (the destination object).
* @return The modified destination object.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static mixin(from: any, to: any): any;
/**
* Javascript string pad http://www.webtoolkit.info/.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param str The target string.
* @param len The number of characters to be added.
* @param pad The string to pad it out with (defaults to a space).
* @param dir The direction dir = 1 (left), 2 (right), 3 (both). - Default: 3
* @return The padded string
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static pad(str: string, len: number, pad: number, dir?: number): string;
/**
* Get a unit dimension from a string.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param size The size to parse.
* @param dimension The window dimension to check.
* @return The parsed dimension.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static parseDimension(size: any, dimension: number): number;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Choose between one of two values randomly.
*
* @param choice1
* @param choice2
* @return The randomly selected choice
*/
static randomChoice(choice1: any, choice2: any): any;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Rotates the given matrix (array of arrays).
*
* Based on the routine from {@link http://jsfiddle.net/MrPolywhirl/NH42z/}.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param matrix The array to rotate; this matrix _may_ be altered.
* @param direction The amount to rotate: the roation in degrees (90, -90, 270, -270, 180) or a string command ('rotateLeft', 'rotateRight' or 'rotate180').
* @return The rotated matrix. The source matrix should be discarded for the returned matrix.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static rotateArray<T>(array: T[], direction: any): T;
/**
* Sets an objects property by string.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param obj The object to traverse
* @param prop The property whose value will be changed
* @return The object on which the property was set.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static setProperty(obj: any, prop: string, value: any): any;
/**
* A standard Fisher-Yates Array shuffle implementation.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param array The array to shuffle.
* @return The shuffled array.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static shuffle<T>(array: T[]): T[];
/**
* Transposes the elements of the given matrix (array of arrays).
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param array The matrix to transpose.
* @return A new transposed matrix
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
static transposeArray<T>(array: T[]): T[];
}
module Utils {
/**
* A collection of methods for displaying debug information about game objects.
* If your game is running in WebGL then Debug will create a Sprite that is placed at the top of the Stage display list and bind a canvas texture
* to it, which must be uploaded every frame. Be advised: this is very expensive, especially in browsers like Firefox. So please only enable Debug
* in WebGL mode if you really need it (or your desktop can cope with it well) and disable it for production!
* If your game is using a Canvas renderer then the debug information is literally drawn on the top of the active game canvas and no Sprite is used.
*/
class Debug {
/**
* A collection of methods for displaying debug information about game objects.
* If your game is running in WebGL then Debug will create a Sprite that is placed at the top of the Stage display list and bind a canvas texture
* to it, which must be uploaded every frame. Be advised: this is very expensive, especially in browsers like Firefox. So please only enable Debug
* in WebGL mode if you really need it (or your desktop can cope with it well) and disable it for production!
* If your game is using a Canvas renderer then the debug information is literally drawn on the top of the active game canvas and no Sprite is used.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game A reference to the currently running game.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* In WebGL mode this BitmapData contains a copy of the debug canvas.
*/
bmd: Phaser.BitmapData;
/**
* The canvas to which Debug calls draws.
*/
canvas: HTMLCanvasElement;
/**
* The spacing between columns.
*/
columnWidth: number;
/**
* The 2d context of the canvas.
*/
context: CanvasRenderingContext2D;
/**
* The current alpha the debug information will be rendered at.
* Default: 1
*/
currentAlpha: number;
/**
* The current X position the debug information will be rendered at.
* Default: 0
*/
currentX: number;
/**
* The current Y position the debug information will be rendered at.
* Default: 0
*/
currentY: number;
/**
* Does the canvas need re-rendering?
*/
dirty: boolean;
/**
* The font that the debug information is rendered in.
* Default: '14px Courier'
*/
font: string;
/**
* A reference to the currently running Game.
*/
game: Phaser.Game;
/**
* The line height between the debug text.
*/
lineHeight: number;
/**
* Should the text be rendered with a slight shadow? Makes it easier to read on different types of background.
*/
renderShadow: boolean;
/**
* If debugging in WebGL mode we need this.
*/
sprite: Phaser.Image;
Refactoring of the script to generate comments.d.ts Refactoring of the script to generate comments.d.ts files. Using typescript package instead of typescript-services (not maintened anymore) Update of the phaser.comments.d.ts with the last dev version.
2015-02-05 20:30:20 +00:00
/**
* Debug method to draw the last calculated path by AStar
*
* @param astar- The AStar plugin that you want to debug.
* @param x X position on camera for debug display.
* @param y Y position on camera for debug display.
* @param color Color to stroke the path line.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
AStar(astar: Phaser.Plugin.AStar, x: number, y: number, showVisited: boolean): void;
/**
* Internal method that boots the debug displayer.
*/
boot(): void;
/**
* Render a Sprites Physics body if it has one set. Note this only works for Arcade and
* Ninja (AABB, circle only) Physics.
* To display a P2 body you should enable debug mode on the body when creating it.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The sprite whos body will be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgba(0,255,0,0.4)'
* @param filled Render the objected as a filled (default, true) or a stroked (false) - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
body(sprite: Phaser.Sprite, color?: string, filled?: boolean): void;
/**
* Render a Sprites Physic Body information.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The sprite to be rendered.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
bodyInfo(sprite: Phaser.Sprite, x: number, y: Number, color?: string): void;
/**
* Renders 'debug draw' data for the given Box2D body.
* This uses the standard debug drawing feature of Box2D, so colors will be decided by the Box2D engine.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The sprite whos body will be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(0,255,0)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
box2dBody(body: Phaser.Sprite, color?: string): void;
/**
* Renders 'debug draw' data for the Box2D world if it exists.
* This uses the standard debug drawing feature of Box2D, so colors will be decided by
* the Box2D engine.
*/
box2dWorld(): void;
/**
* Render camera information including dimensions and location.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param camera The Phaser.Camera to show the debug information for.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
cameraInfo(camera: Phaser.Camera, x: number, y: number, color?: string): void;
/**
* Renders a Phaser geometry object including Rectangle, Circle, Point or Line.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param object The geometry object to render.
* @param color Color of the debug info to be rendered (format is css color string).
* @param filled Render the objected as a filled (default, true) or a stroked (false) - Default: true
* @param forceType Force rendering of a specific type. If 0 no type will be forced, otherwise 1 = Rectangle, 2 = Circle, 3 = Point and 4 = Line. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
geom(object: any, color?: string, fiiled?: boolean, forceType?: number): void;
/**
* Render debug information about the Input object.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
inputInfo(x: number, y: number, color?: string): void;
/**
* Renders Line information in the given color.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param line The Line to display the data for.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
lineInfo(line: Phaser.Line, x: number, y: number, color?: string): void;
/**
* Renders Phaser.Key object information.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param key The Key to render the information for.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
key(key: Phaser.Key, x?: number, y?: number, color?: string): void;
/**
* Internal method that outputs a single line of text split over as many columns as needed, one per parameter.
*/
line(): void;
/**
* Internal method that clears the canvas (if a Sprite) ready for a new debug session.
*/
preUpdate(): void;
/**
* Renders a single pixel at the given size.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x X position of the pixel to be rendered.
* @param y Y position of the pixel to be rendered.
* @param color Color of the pixel (format is css color string).
* @param size The 'size' to render the pixel at. - Default: 2
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pixel(x: number, y: number, color?: string, size?: number): void;
/**
* Renders the Pointer.circle object onto the stage in green if down or red if up along with debug text.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param pointer The Pointer you wish to display.
* @param hideIfUp Doesn't render the circle if the pointer is up. - Default: false
* @param downColor The color the circle is rendered in if down. - Default: 'rgba(0,255,0,0.5)'
* @param upColor The color the circle is rendered in if up (and hideIfUp is false). - Default: 'rgba(255,0,0,0.5)'
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
pointer(pointer: Phaser.Pointer, hideIfUp?: boolean, downColor?: string, upColor?: string, color?: string): void;
/**
* Visually renders a QuadTree to the display.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param quadtree The quadtree to render.
* @param color The color of the lines in the quadtree.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
quadTree(quadtree: Phaser.QuadTree, color?: string): void;
rectangle(object: Phaser.Rectangle, color?: string, filled?: boolean): void;
/**
* Clears the Debug canvas.
*/
reset(): void;
/**
* Renders the Rope's segments. Note: This is really expensive as it has to calculate new segments everytime you call it
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param rope The rope to display the segments of.
* @param color Color of the debug info to be rendered (format is css color string).
* @param filled Render the rectangle as a fillRect (default, true) or a strokeRect (false) - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
ropeSegments(rope: Phaser.Rope, color?: number, filled?: boolean): void;
/**
* Render Sound information, including decoded state, duration, volume and more.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sound The sound object to debug.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
soundInfo(sound: Phaser.Sound, x: number, y: number, color?: string): void;
/**
* Renders the Sprites bounds. Note: This is really expensive as it has to calculate the bounds every time you call it!
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The sprite to display the bounds of.
* @param color Color of the debug info to be rendered (format is css color string).
* @param filled Render the rectangle as a fillRect (default, true) or a strokeRect (false) - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
spriteBounds(sprite: any, color?: string, filled?: boolean): void;
/**
* Renders the sprite coordinates in local, positional and world space.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The sprite to display the coordinates for.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
spriteCoords(sprite: any, x: number, y: number, color?: string): void;
/**
* Render debug infos (including name, bounds info, position and some other properties) about the Sprite.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The Sprite to display the information of.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
spriteInfo(sprite: Phaser.Sprite, x: number, y: number, color?: string): void;
/**
* Render Sprite Input Debug information.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The sprite to display the input data for.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
spriteInputInfo(sprite: Phaser.Sprite, x: number, y: number, color?: string): void;
/**
* Internal method that resets and starts the debug output values.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x The X value the debug info will start from. - Default: 0
* @param y The Y value the debug info will start from. - Default: 0
* @param color The color the debug text will drawn in. - Default: 'rgb(255,255,255)'
* @param columnWidth The spacing between columns. - Default: 0
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
start(x?: number, y?: number, color?: string, columnWidth?: number): void;
/**
* Internal method that stops the debug output.
*/
stop(): void;
/**
* Render a string of text.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param text The line of text to draw.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color Color of the debug info to be rendered (format is css color string).
* @param font The font of text to draw.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
text(text: string, x: number, y: number, color?: string, font?: string): void;
/**
* Render Timer information.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param timer The Phaser.Timer to show the debug information for.
* @param x X position of the debug info to be rendered.
* @param y Y position of the debug info to be rendered.
* @param color color of the debug info to be rendered. (format is css color string). - Default: 'rgb(255,255,255)'
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
timer(timer: Phaser.Timer, x: number, y: number, color?: string): void;
}
}
/**
* "This world is but a canvas to our imagination." - Henry David Thoreau
*
* A game has only one world. The world is an abstract place in which all game objects live. It is not bound
* by stage limits and can be any size. You look into the world via cameras. All game objects live within
* the world at world-based coordinates. By default a world is created the same size as your Stage.
*/
class World extends Phaser.Group {
/**
* "This world is but a canvas to our imagination." - Henry David Thoreau
*
* A game has only one world. The world is an abstract place in which all game objects live. It is not bound
* by stage limits and can be any size. You look into the world via cameras. All game objects live within
* the world at world-based coordinates. By default a world is created the same size as your Stage.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param game Reference to the current game instance.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
constructor(game: Phaser.Game);
/**
* The World has no fixed size, but it does have a bounds outside of which objects are no longer considered as being "in world" and you should use this to clean-up the display list and purge dead objects.
* By default we set the Bounds to be from 0,0 to Game.width,Game.height. I.e. it will match the size given to the game constructor with 0,0 representing the top-left of the display.
* However 0,0 is actually the center of the world, and if you rotate or scale the world all of that will happen from 0,0.
* So if you want to make a game in which the world itself will rotate you should adjust the bounds so that 0,0 is the center point, i.e. set them to -1000,-1000,2000,2000 for a 2000x2000 sized world centered around 0,0. Bound of this world that objects can not escape from.
*/
bounds: Phaser.Rectangle;
/**
* Camera instance.
*/
camera: Phaser.Camera;
/**
* Gets the X position corresponding to the center point of the world.
*/
centerX: number;
/**
* Gets the Y position corresponding to the center point of the world.
*/
centerY: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
/**
* A reference to the currently running Game.
*/
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
game: Phaser.Game;
/**
* Gets or sets the current height of the game world. The world can never be smaller than the game (canvas) dimensions.
*/
height: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
isPaused: boolean;
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Gets a random integer which is lesser than or equal to the current width of the game world.
*/
randomX: number;
/**
* Gets a random integer which is lesser than or equal to the current height of the game world.
*/
randomY: number;
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
stats: {
skipped: number;
ignored: number;
checked: number;
};
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
/**
* Gets or sets the current width of the game world. The world can never be smaller than the game (canvas) dimensions.
*/
width: number;
/**
* Initialises the game world.
*/
boot(): void;
getObjectsUnderPointer(pointer: Phaser.Pointer, group: Phaser.Group, callback?: Function, callbackContext?: any): Phaser.Sprite;
/**
* Updates the size of this world. Note that this doesn't modify the world x/y coordinates, just the width and height.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param width New width of the game world in pixels.
* @param height New height of the game world in pixels.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
resize(width: number, height: number): void;
/**
TypeScript defs with comments update.
2015-03-26 02:59:11 +00:00
* Updates the size of this world and sets World.x/y to the given values
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
* The Camera bounds and Physics bounds (if set) are also updated to match the new World bounds.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param x Top left most corner of the world.
* @param y Top left most corner of the world.
* @param width New width of the game world in pixels.
* @param height New height of the game world in pixels.
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
setBounds(x: number, y: number, width: number, height: number): void;
/**
* Destroyer of worlds.
*/
shutdown(): void;
/**
* This will take the given game object and check if its x/y coordinates fall outside of the world bounds.
* If they do it will reposition the object to the opposite side of the world, creating a wrap-around effect.
* If sprite has a P2 body then the body (sprite.body) should be passed as first parameter to the function.
*
Improve d.ts comments generation - Remove " - " after @param paramname, and @return because it is useless. - Improve alignement of multiline param comments.
2015-01-21 07:50:14 +00:00
* @param sprite The object you wish to wrap around the world bounds.
* @param padding Extra padding added equally to the sprite.x and y coordinates before checking if within the world bounds. Ignored if useBounds is true. - Default: 0
* @param useBounds If useBounds is false wrap checks the object.x/y coordinates. If true it does a more accurate bounds check, which is more expensive. - Default: false
* @param horizontal If horizontal is false, wrap will not wrap the object.x coordinates horizontally. - Default: true
* @param vertical If vertical is false, wrap will not wrap the object.y coordinates vertically. - Default: true
Add grunt task to generate d.ts with comments Add "tsdocs" grunt task to generate d.ts files with comments.
2015-01-20 16:18:56 +00:00
*/
wrap(sprite: any, padding?: number, useBounds?: boolean, horizontal?: boolean, vertical?: boolean): void;
}
}
Reference in a new issue Copy permalink