diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 1fb398f..b86350e 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -38,7 +38,7 @@ * The width of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ width: { get: function () @@ -68,7 +68,7 @@ * The height of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ height: { get: function () diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 1fb398f..b86350e 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -38,7 +38,7 @@ * The width of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ width: { get: function () @@ -68,7 +68,7 @@ * The height of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ height: { get: function () diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 0ca5118..ef1feee 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -9,6 +9,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class + * @extends EventEmitter * @memberof PIXI */ function DisplayObject() @@ -195,7 +196,7 @@ * Indicates if the sprite is globally visible. * * @member {boolean} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# * @readonly */ worldVisible: { @@ -223,7 +224,7 @@ * * @member {Graphics} * @property {Graphics} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ mask: { get: function () @@ -252,7 +253,7 @@ * To remove filters simply set this property to 'null' * * @member {Filter[]} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ filters: { get: function () diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 1fb398f..b86350e 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -38,7 +38,7 @@ * The width of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ width: { get: function () @@ -68,7 +68,7 @@ * The height of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ height: { get: function () diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 0ca5118..ef1feee 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -9,6 +9,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class + * @extends EventEmitter * @memberof PIXI */ function DisplayObject() @@ -195,7 +196,7 @@ * Indicates if the sprite is globally visible. * * @member {boolean} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# * @readonly */ worldVisible: { @@ -223,7 +224,7 @@ * * @member {Graphics} * @property {Graphics} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ mask: { get: function () @@ -252,7 +253,7 @@ * To remove filters simply set this property to 'null' * * @member {Filter[]} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ filters: { get: function () diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index f5f8425..8b887b1 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -103,7 +103,7 @@ * The width of the sprite, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Sprite.prototype + * @memberof PIXI.Sprite# */ width: { get: function () @@ -121,7 +121,7 @@ * The height of the sprite, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Sprite.prototype + * @memberof PIXI.Sprite# */ height: { get: function () @@ -138,8 +138,8 @@ /** * The texture that the sprite is using * - * @member {Texture} - * @memberof PIXI.Sprite.prototype + * @member {PIXI.Texture} + * @memberof PIXI.Sprite# */ texture: { get: function () diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 1fb398f..b86350e 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -38,7 +38,7 @@ * The width of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ width: { get: function () @@ -68,7 +68,7 @@ * The height of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ height: { get: function () diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 0ca5118..ef1feee 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -9,6 +9,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class + * @extends EventEmitter * @memberof PIXI */ function DisplayObject() @@ -195,7 +196,7 @@ * Indicates if the sprite is globally visible. * * @member {boolean} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# * @readonly */ worldVisible: { @@ -223,7 +224,7 @@ * * @member {Graphics} * @property {Graphics} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ mask: { get: function () @@ -252,7 +253,7 @@ * To remove filters simply set this property to 'null' * * @member {Filter[]} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ filters: { get: function () diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index f5f8425..8b887b1 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -103,7 +103,7 @@ * The width of the sprite, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Sprite.prototype + * @memberof PIXI.Sprite# */ width: { get: function () @@ -121,7 +121,7 @@ * The height of the sprite, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Sprite.prototype + * @memberof PIXI.Sprite# */ height: { get: function () @@ -138,8 +138,8 @@ /** * The texture that the sprite is using * - * @member {Texture} - * @memberof PIXI.Sprite.prototype + * @member {PIXI.Texture} + * @memberof PIXI.Sprite# */ texture: { get: function () diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 328badc..30388c6 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -146,7 +146,7 @@ * Fired when a not-immediately-available source finishes loading. * * @event loaded - * @memberof BaseTexture# + * @memberof PIXI.BaseTexture# * @protected */ @@ -154,7 +154,7 @@ * Fired when a not-immediately-available source fails to load. * * @event error - * @memberof BaseTexture# + * @memberof PIXI.BaseTexture# * @protected */ } diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 1fb398f..b86350e 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -38,7 +38,7 @@ * The width of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ width: { get: function () @@ -68,7 +68,7 @@ * The height of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ height: { get: function () diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 0ca5118..ef1feee 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -9,6 +9,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class + * @extends EventEmitter * @memberof PIXI */ function DisplayObject() @@ -195,7 +196,7 @@ * Indicates if the sprite is globally visible. * * @member {boolean} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# * @readonly */ worldVisible: { @@ -223,7 +224,7 @@ * * @member {Graphics} * @property {Graphics} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ mask: { get: function () @@ -252,7 +253,7 @@ * To remove filters simply set this property to 'null' * * @member {Filter[]} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ filters: { get: function () diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index f5f8425..8b887b1 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -103,7 +103,7 @@ * The width of the sprite, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Sprite.prototype + * @memberof PIXI.Sprite# */ width: { get: function () @@ -121,7 +121,7 @@ * The height of the sprite, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Sprite.prototype + * @memberof PIXI.Sprite# */ height: { get: function () @@ -138,8 +138,8 @@ /** * The texture that the sprite is using * - * @member {Texture} - * @memberof PIXI.Sprite.prototype + * @member {PIXI.Texture} + * @memberof PIXI.Sprite# */ texture: { get: function () diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 328badc..30388c6 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -146,7 +146,7 @@ * Fired when a not-immediately-available source finishes loading. * * @event loaded - * @memberof BaseTexture# + * @memberof PIXI.BaseTexture# * @protected */ @@ -154,7 +154,7 @@ * Fired when a not-immediately-available source fails to load. * * @event error - * @memberof BaseTexture# + * @memberof PIXI.BaseTexture# * @protected */ } diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 664bd26..de34745 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -138,6 +138,14 @@ { baseTexture.once('loaded', this.onBaseTextureLoaded, this); } + + /** + * Fired when the texture is updated. This happens if the frame or the baseTexture is updated. + * + * @event update + * @memberof PIXI.Texture# + * @protected + */ } Texture.prototype = Object.create(EventEmitter.prototype); diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 1fb398f..b86350e 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -38,7 +38,7 @@ * The width of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ width: { get: function () @@ -68,7 +68,7 @@ * The height of the Container, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Container.prototype + * @memberof PIXI.Container# */ height: { get: function () diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 0ca5118..ef1feee 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -9,6 +9,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class + * @extends EventEmitter * @memberof PIXI */ function DisplayObject() @@ -195,7 +196,7 @@ * Indicates if the sprite is globally visible. * * @member {boolean} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# * @readonly */ worldVisible: { @@ -223,7 +224,7 @@ * * @member {Graphics} * @property {Graphics} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ mask: { get: function () @@ -252,7 +253,7 @@ * To remove filters simply set this property to 'null' * * @member {Filter[]} - * @memberof PIXI.DisplayObject.prototype + * @memberof PIXI.DisplayObject# */ filters: { get: function () diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index f5f8425..8b887b1 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -103,7 +103,7 @@ * The width of the sprite, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Sprite.prototype + * @memberof PIXI.Sprite# */ width: { get: function () @@ -121,7 +121,7 @@ * The height of the sprite, setting this will actually modify the scale to achieve the value set * * @member {number} - * @memberof PIXI.Sprite.prototype + * @memberof PIXI.Sprite# */ height: { get: function () @@ -138,8 +138,8 @@ /** * The texture that the sprite is using * - * @member {Texture} - * @memberof PIXI.Sprite.prototype + * @member {PIXI.Texture} + * @memberof PIXI.Sprite# */ texture: { get: function () diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 328badc..30388c6 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -146,7 +146,7 @@ * Fired when a not-immediately-available source finishes loading. * * @event loaded - * @memberof BaseTexture# + * @memberof PIXI.BaseTexture# * @protected */ @@ -154,7 +154,7 @@ * Fired when a not-immediately-available source fails to load. * * @event error - * @memberof BaseTexture# + * @memberof PIXI.BaseTexture# * @protected */ } diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 664bd26..de34745 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -138,6 +138,14 @@ { baseTexture.once('loaded', this.onBaseTextureLoaded, this); } + + /** + * Fired when the texture is updated. This happens if the frame or the baseTexture is updated. + * + * @event update + * @memberof PIXI.Texture# + * @protected + */ } Texture.prototype = Object.create(EventEmitter.prototype); diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 3ef6e21..ce6d53f 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -82,8 +82,8 @@ * totalFrames is the total number of frames in the MovieClip. This is the same as number of textures * assigned to the MovieClip. * - * @member - * @memberof MovieClip# + * @member {number} + * @memberof PIXI.MovieClip# * @default 0 * @readonly */ @@ -97,8 +97,8 @@ /** * The array of textures used for this MovieClip * - * @member {Texture[]} - * @memberof MovieClip# + * @member {PIXI.Texture[]} + * @memberof PIXI.MovieClip# * */ textures: { @@ -118,7 +118,8 @@ * The MovieClips current frame index * * @member {number} - * @readonly + * @memberof PIXI.MovieClip# + * @readonly */ currentFrame: { get: function ()