diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js index dbebeb0..a0cd48e 100644 --- a/bundles/pixi.js/src/deprecated.js +++ b/bundles/pixi.js/src/deprecated.js @@ -1,51 +1,6 @@ -// A map of warning messages alread fired -const warnings = {}; +import { deprecation } from '@pixi/utils'; -// provide method to give a stack track for warnings -// useful for tracking-down where deprecated methods/properties/classes -// are being used within the code -function warn(msg) -{ - // Ignore duplicat - if (warnings[msg]) - { - return; - } - - /* eslint-disable no-console */ - let stack = new Error().stack; - - // Handle IE < 10 and Safari < 6 - if (typeof stack === 'undefined') - { - console.warn('Deprecation Warning: ', msg); - } - else - { - // chop off the stack trace which includes pixi.js internal calls - stack = stack.split('\n').splice(3).join('\n'); - - if (console.groupCollapsed) - { - console.groupCollapsed( - '%cDeprecation Warning: %c%s', - 'color:#614108;background:#fffbe6', - 'font-weight:normal;color:#614108;background:#fffbe6', - msg - ); - console.warn(stack); - console.groupEnd(); - } - else - { - console.warn('Deprecation Warning: ', msg); - console.warn(stack); - } - } - /* eslint-enable no-console */ - - warnings[msg] = true; -} +const v5 = '5.0.0'; export default function deprecated(PIXI) { @@ -60,7 +15,7 @@ SVG_SIZE: { get() { - warn('PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -74,7 +29,7 @@ TransformStatic: { get() { - warn('PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -88,7 +43,7 @@ TransformBase: { get() { - warn('PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -109,7 +64,7 @@ TRANSFORM_MODE: { get() { - warn('PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -123,7 +78,7 @@ WebGLRenderer: { get() { - warn('PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -137,7 +92,7 @@ CanvasRenderTarget: { get() { - warn('PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -153,7 +108,7 @@ loader: { get() { - warn('PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -167,7 +122,7 @@ FilterManager: { get() { - warn('PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterManager; }, @@ -191,7 +146,7 @@ TilingSprite: { get() { - warn('PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -204,7 +159,7 @@ TilingSpriteRenderer: { get() { - warn('PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -217,7 +172,7 @@ AnimatedSprite: { get() { - warn('PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -230,7 +185,7 @@ BitmapText: { get() { - warn('PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -246,7 +201,7 @@ getSvgSize: { get() { - warn('PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -269,7 +224,7 @@ Mesh: { get() { - warn('PIXI.mesh.Mesh has moved to PIXI.Mesh2d'); + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.Mesh2d'); return PIXI.Mesh2d; }, @@ -282,7 +237,7 @@ NineSlicePlane: { get() { - warn('PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -295,7 +250,7 @@ Plane: { get() { - warn('PIXI.mesh.Plane has moved to PIXI.Plane'); + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.Plane'); return PIXI.Plane; }, @@ -308,7 +263,7 @@ Rope: { get() { - warn('PIXI.mesh.Rope has moved to PIXI.Rope'); + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.Rope'); return PIXI.Rope; }, @@ -321,7 +276,7 @@ RawMesh: { get() { - warn('PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -334,7 +289,7 @@ CanvasMeshRenderer: { get() { - warn('PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -347,7 +302,7 @@ MeshRenderer: { get() { - warn('PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -371,7 +326,7 @@ ParticleContainer: { get() { - warn('PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -384,7 +339,7 @@ ParticleRenderer: { get() { - warn('PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -408,7 +363,7 @@ Ticker: { get() { - warn('PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -422,7 +377,7 @@ shared: { get() { - warn('PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -445,7 +400,7 @@ Loader: { get() { - warn('PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -458,7 +413,7 @@ Resource: { get() { - warn('PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -471,7 +426,7 @@ bitmapFontParser: { get() { - warn('PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -484,7 +439,7 @@ parseBitmapFontData: { get() { - warn('PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -497,7 +452,7 @@ spritesheetParser: { get() { - warn('PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -510,7 +465,7 @@ getResourcePath: { get() { - warn('PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -525,7 +480,7 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - warn('PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -538,7 +493,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - warn('PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -552,7 +507,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - warn('PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -567,7 +522,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - warn('PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); this._render(renderer); }; @@ -580,7 +535,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - warn('PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); this.render(renderer); }; @@ -593,7 +548,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - warn('PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); this.render(renderer); }; @@ -606,7 +561,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - warn('PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); this.renderAdvanced(renderer); }; @@ -624,13 +579,13 @@ TRANSFORM_MODE: { get() { - warn('PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); return 0; }, set() { - warn('PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); }, }, }); @@ -646,7 +601,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - warn('PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -662,7 +617,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - warn('PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -676,7 +631,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - warn('PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -690,7 +645,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - warn('PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); return this.copyFrom(p); }; @@ -702,7 +657,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - warn('PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); return this.copyFrom(p); }; @@ -714,7 +669,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - warn('PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); return this.copyFrom(p); }; @@ -726,7 +681,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - warn('PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); return this.copyTo(p); }; @@ -739,7 +694,7 @@ */ getRenderTarget(clear, resolution) { - warn('FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); return this.getFilterTexture(resolution); }, @@ -751,7 +706,7 @@ */ returnRenderTarget(renderTexture) { - warn('FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); this.returnFilterTexture(renderTexture); }, @@ -767,7 +722,7 @@ sourceFrame: { get() { - warn('PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); return this.filterFrame; }, @@ -781,7 +736,7 @@ size: { get() { - warn('PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); return this._frame; }, @@ -798,7 +753,7 @@ { constructor(strength, quality, resolution, kernelSize) { - warn('PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -814,7 +769,7 @@ { constructor(strength, quality, resolution, kernelSize) { - warn('PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -830,7 +785,7 @@ // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - warn(`PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -883,7 +838,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - warn(`PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -941,13 +896,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - warn('PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - warn('PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); this.autoDensity = value; }, diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js index dbebeb0..a0cd48e 100644 --- a/bundles/pixi.js/src/deprecated.js +++ b/bundles/pixi.js/src/deprecated.js @@ -1,51 +1,6 @@ -// A map of warning messages alread fired -const warnings = {}; +import { deprecation } from '@pixi/utils'; -// provide method to give a stack track for warnings -// useful for tracking-down where deprecated methods/properties/classes -// are being used within the code -function warn(msg) -{ - // Ignore duplicat - if (warnings[msg]) - { - return; - } - - /* eslint-disable no-console */ - let stack = new Error().stack; - - // Handle IE < 10 and Safari < 6 - if (typeof stack === 'undefined') - { - console.warn('Deprecation Warning: ', msg); - } - else - { - // chop off the stack trace which includes pixi.js internal calls - stack = stack.split('\n').splice(3).join('\n'); - - if (console.groupCollapsed) - { - console.groupCollapsed( - '%cDeprecation Warning: %c%s', - 'color:#614108;background:#fffbe6', - 'font-weight:normal;color:#614108;background:#fffbe6', - msg - ); - console.warn(stack); - console.groupEnd(); - } - else - { - console.warn('Deprecation Warning: ', msg); - console.warn(stack); - } - } - /* eslint-enable no-console */ - - warnings[msg] = true; -} +const v5 = '5.0.0'; export default function deprecated(PIXI) { @@ -60,7 +15,7 @@ SVG_SIZE: { get() { - warn('PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -74,7 +29,7 @@ TransformStatic: { get() { - warn('PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -88,7 +43,7 @@ TransformBase: { get() { - warn('PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -109,7 +64,7 @@ TRANSFORM_MODE: { get() { - warn('PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -123,7 +78,7 @@ WebGLRenderer: { get() { - warn('PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -137,7 +92,7 @@ CanvasRenderTarget: { get() { - warn('PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -153,7 +108,7 @@ loader: { get() { - warn('PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -167,7 +122,7 @@ FilterManager: { get() { - warn('PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterManager; }, @@ -191,7 +146,7 @@ TilingSprite: { get() { - warn('PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -204,7 +159,7 @@ TilingSpriteRenderer: { get() { - warn('PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -217,7 +172,7 @@ AnimatedSprite: { get() { - warn('PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -230,7 +185,7 @@ BitmapText: { get() { - warn('PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -246,7 +201,7 @@ getSvgSize: { get() { - warn('PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -269,7 +224,7 @@ Mesh: { get() { - warn('PIXI.mesh.Mesh has moved to PIXI.Mesh2d'); + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.Mesh2d'); return PIXI.Mesh2d; }, @@ -282,7 +237,7 @@ NineSlicePlane: { get() { - warn('PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -295,7 +250,7 @@ Plane: { get() { - warn('PIXI.mesh.Plane has moved to PIXI.Plane'); + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.Plane'); return PIXI.Plane; }, @@ -308,7 +263,7 @@ Rope: { get() { - warn('PIXI.mesh.Rope has moved to PIXI.Rope'); + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.Rope'); return PIXI.Rope; }, @@ -321,7 +276,7 @@ RawMesh: { get() { - warn('PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -334,7 +289,7 @@ CanvasMeshRenderer: { get() { - warn('PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -347,7 +302,7 @@ MeshRenderer: { get() { - warn('PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -371,7 +326,7 @@ ParticleContainer: { get() { - warn('PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -384,7 +339,7 @@ ParticleRenderer: { get() { - warn('PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -408,7 +363,7 @@ Ticker: { get() { - warn('PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -422,7 +377,7 @@ shared: { get() { - warn('PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -445,7 +400,7 @@ Loader: { get() { - warn('PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -458,7 +413,7 @@ Resource: { get() { - warn('PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -471,7 +426,7 @@ bitmapFontParser: { get() { - warn('PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -484,7 +439,7 @@ parseBitmapFontData: { get() { - warn('PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -497,7 +452,7 @@ spritesheetParser: { get() { - warn('PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -510,7 +465,7 @@ getResourcePath: { get() { - warn('PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -525,7 +480,7 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - warn('PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -538,7 +493,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - warn('PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -552,7 +507,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - warn('PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -567,7 +522,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - warn('PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); this._render(renderer); }; @@ -580,7 +535,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - warn('PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); this.render(renderer); }; @@ -593,7 +548,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - warn('PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); this.render(renderer); }; @@ -606,7 +561,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - warn('PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); this.renderAdvanced(renderer); }; @@ -624,13 +579,13 @@ TRANSFORM_MODE: { get() { - warn('PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); return 0; }, set() { - warn('PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); }, }, }); @@ -646,7 +601,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - warn('PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -662,7 +617,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - warn('PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -676,7 +631,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - warn('PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -690,7 +645,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - warn('PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); return this.copyFrom(p); }; @@ -702,7 +657,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - warn('PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); return this.copyFrom(p); }; @@ -714,7 +669,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - warn('PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); return this.copyFrom(p); }; @@ -726,7 +681,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - warn('PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); return this.copyTo(p); }; @@ -739,7 +694,7 @@ */ getRenderTarget(clear, resolution) { - warn('FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); return this.getFilterTexture(resolution); }, @@ -751,7 +706,7 @@ */ returnRenderTarget(renderTexture) { - warn('FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); this.returnFilterTexture(renderTexture); }, @@ -767,7 +722,7 @@ sourceFrame: { get() { - warn('PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); return this.filterFrame; }, @@ -781,7 +736,7 @@ size: { get() { - warn('PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); return this._frame; }, @@ -798,7 +753,7 @@ { constructor(strength, quality, resolution, kernelSize) { - warn('PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -814,7 +769,7 @@ { constructor(strength, quality, resolution, kernelSize) { - warn('PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -830,7 +785,7 @@ // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - warn(`PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -883,7 +838,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - warn(`PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -941,13 +896,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - warn('PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - warn('PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); this.autoDensity = value; }, diff --git a/packages/utils/src/index.js b/packages/utils/src/index.js index d9bce7f..a46acc5 100644 --- a/packages/utils/src/index.js +++ b/packages/utils/src/index.js @@ -72,5 +72,6 @@ export * from './media'; export * from './network'; export * from './const'; +export * from './logging'; import './settings'; diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js index dbebeb0..a0cd48e 100644 --- a/bundles/pixi.js/src/deprecated.js +++ b/bundles/pixi.js/src/deprecated.js @@ -1,51 +1,6 @@ -// A map of warning messages alread fired -const warnings = {}; +import { deprecation } from '@pixi/utils'; -// provide method to give a stack track for warnings -// useful for tracking-down where deprecated methods/properties/classes -// are being used within the code -function warn(msg) -{ - // Ignore duplicat - if (warnings[msg]) - { - return; - } - - /* eslint-disable no-console */ - let stack = new Error().stack; - - // Handle IE < 10 and Safari < 6 - if (typeof stack === 'undefined') - { - console.warn('Deprecation Warning: ', msg); - } - else - { - // chop off the stack trace which includes pixi.js internal calls - stack = stack.split('\n').splice(3).join('\n'); - - if (console.groupCollapsed) - { - console.groupCollapsed( - '%cDeprecation Warning: %c%s', - 'color:#614108;background:#fffbe6', - 'font-weight:normal;color:#614108;background:#fffbe6', - msg - ); - console.warn(stack); - console.groupEnd(); - } - else - { - console.warn('Deprecation Warning: ', msg); - console.warn(stack); - } - } - /* eslint-enable no-console */ - - warnings[msg] = true; -} +const v5 = '5.0.0'; export default function deprecated(PIXI) { @@ -60,7 +15,7 @@ SVG_SIZE: { get() { - warn('PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -74,7 +29,7 @@ TransformStatic: { get() { - warn('PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -88,7 +43,7 @@ TransformBase: { get() { - warn('PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -109,7 +64,7 @@ TRANSFORM_MODE: { get() { - warn('PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -123,7 +78,7 @@ WebGLRenderer: { get() { - warn('PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -137,7 +92,7 @@ CanvasRenderTarget: { get() { - warn('PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -153,7 +108,7 @@ loader: { get() { - warn('PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -167,7 +122,7 @@ FilterManager: { get() { - warn('PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterManager; }, @@ -191,7 +146,7 @@ TilingSprite: { get() { - warn('PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -204,7 +159,7 @@ TilingSpriteRenderer: { get() { - warn('PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -217,7 +172,7 @@ AnimatedSprite: { get() { - warn('PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -230,7 +185,7 @@ BitmapText: { get() { - warn('PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -246,7 +201,7 @@ getSvgSize: { get() { - warn('PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -269,7 +224,7 @@ Mesh: { get() { - warn('PIXI.mesh.Mesh has moved to PIXI.Mesh2d'); + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.Mesh2d'); return PIXI.Mesh2d; }, @@ -282,7 +237,7 @@ NineSlicePlane: { get() { - warn('PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -295,7 +250,7 @@ Plane: { get() { - warn('PIXI.mesh.Plane has moved to PIXI.Plane'); + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.Plane'); return PIXI.Plane; }, @@ -308,7 +263,7 @@ Rope: { get() { - warn('PIXI.mesh.Rope has moved to PIXI.Rope'); + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.Rope'); return PIXI.Rope; }, @@ -321,7 +276,7 @@ RawMesh: { get() { - warn('PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -334,7 +289,7 @@ CanvasMeshRenderer: { get() { - warn('PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -347,7 +302,7 @@ MeshRenderer: { get() { - warn('PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -371,7 +326,7 @@ ParticleContainer: { get() { - warn('PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -384,7 +339,7 @@ ParticleRenderer: { get() { - warn('PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -408,7 +363,7 @@ Ticker: { get() { - warn('PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -422,7 +377,7 @@ shared: { get() { - warn('PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -445,7 +400,7 @@ Loader: { get() { - warn('PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -458,7 +413,7 @@ Resource: { get() { - warn('PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -471,7 +426,7 @@ bitmapFontParser: { get() { - warn('PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -484,7 +439,7 @@ parseBitmapFontData: { get() { - warn('PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -497,7 +452,7 @@ spritesheetParser: { get() { - warn('PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -510,7 +465,7 @@ getResourcePath: { get() { - warn('PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -525,7 +480,7 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - warn('PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -538,7 +493,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - warn('PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -552,7 +507,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - warn('PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -567,7 +522,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - warn('PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); this._render(renderer); }; @@ -580,7 +535,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - warn('PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); this.render(renderer); }; @@ -593,7 +548,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - warn('PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); this.render(renderer); }; @@ -606,7 +561,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - warn('PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); this.renderAdvanced(renderer); }; @@ -624,13 +579,13 @@ TRANSFORM_MODE: { get() { - warn('PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); return 0; }, set() { - warn('PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); }, }, }); @@ -646,7 +601,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - warn('PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -662,7 +617,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - warn('PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -676,7 +631,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - warn('PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -690,7 +645,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - warn('PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); return this.copyFrom(p); }; @@ -702,7 +657,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - warn('PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); return this.copyFrom(p); }; @@ -714,7 +669,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - warn('PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); return this.copyFrom(p); }; @@ -726,7 +681,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - warn('PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); return this.copyTo(p); }; @@ -739,7 +694,7 @@ */ getRenderTarget(clear, resolution) { - warn('FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); return this.getFilterTexture(resolution); }, @@ -751,7 +706,7 @@ */ returnRenderTarget(renderTexture) { - warn('FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); this.returnFilterTexture(renderTexture); }, @@ -767,7 +722,7 @@ sourceFrame: { get() { - warn('PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); return this.filterFrame; }, @@ -781,7 +736,7 @@ size: { get() { - warn('PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); return this._frame; }, @@ -798,7 +753,7 @@ { constructor(strength, quality, resolution, kernelSize) { - warn('PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -814,7 +769,7 @@ { constructor(strength, quality, resolution, kernelSize) { - warn('PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -830,7 +785,7 @@ // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - warn(`PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -883,7 +838,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - warn(`PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -941,13 +896,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - warn('PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - warn('PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); this.autoDensity = value; }, diff --git a/packages/utils/src/index.js b/packages/utils/src/index.js index d9bce7f..a46acc5 100644 --- a/packages/utils/src/index.js +++ b/packages/utils/src/index.js @@ -72,5 +72,6 @@ export * from './media'; export * from './network'; export * from './const'; +export * from './logging'; import './settings'; diff --git a/packages/utils/src/logging/deprecation.js b/packages/utils/src/logging/deprecation.js new file mode 100644 index 0000000..321cd44 --- /dev/null +++ b/packages/utils/src/logging/deprecation.js @@ -0,0 +1,55 @@ +// A map of warning messages already fired +const warnings = {}; + +/** + * Helper for warning developers about deprecated features & settings. + * A stack track for warnings is given; useful for tracking-down where + * deprecated methods/properties/classes are being used within the code. + * + * @memberof PIXI.utils + * @function deprecation + * @param {string} version - The version where the feature became deprecated + * @param {string} message - Message should include what is deprecated, where, and the new solution + */ +export function deprecation(version, message) +{ + // Ignore duplicat + if (warnings[message]) + { + return; + } + + /* eslint-disable no-console */ + let stack = new Error().stack; + + // Handle IE < 10 and Safari < 6 + if (typeof stack === 'undefined') + { + console.warn('PixiJS Deprecation Warning: ', `${message}\nDeprecated since v${version}`); + } + else + { + // chop off the stack trace which includes PixiJS internal calls + stack = stack.split('\n').splice(3).join('\n'); + + if (console.groupCollapsed) + { + console.groupCollapsed( + '%cPixiJS Deprecation Warning: %c%s', + 'color:#614108;background:#fffbe6', + 'font-weight:normal;color:#614108;background:#fffbe6', + `${message}\nDeprecated since v${version}` + ); + console.warn(stack); + console.groupEnd(); + } + else + { + console.warn('PixiJS Deprecation Warning: ', `${message}\nDeprecated since v${version}`); + console.warn(stack); + } + } + /* eslint-enable no-console */ + + warnings[message] = true; +} diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js index dbebeb0..a0cd48e 100644 --- a/bundles/pixi.js/src/deprecated.js +++ b/bundles/pixi.js/src/deprecated.js @@ -1,51 +1,6 @@ -// A map of warning messages alread fired -const warnings = {}; +import { deprecation } from '@pixi/utils'; -// provide method to give a stack track for warnings -// useful for tracking-down where deprecated methods/properties/classes -// are being used within the code -function warn(msg) -{ - // Ignore duplicat - if (warnings[msg]) - { - return; - } - - /* eslint-disable no-console */ - let stack = new Error().stack; - - // Handle IE < 10 and Safari < 6 - if (typeof stack === 'undefined') - { - console.warn('Deprecation Warning: ', msg); - } - else - { - // chop off the stack trace which includes pixi.js internal calls - stack = stack.split('\n').splice(3).join('\n'); - - if (console.groupCollapsed) - { - console.groupCollapsed( - '%cDeprecation Warning: %c%s', - 'color:#614108;background:#fffbe6', - 'font-weight:normal;color:#614108;background:#fffbe6', - msg - ); - console.warn(stack); - console.groupEnd(); - } - else - { - console.warn('Deprecation Warning: ', msg); - console.warn(stack); - } - } - /* eslint-enable no-console */ - - warnings[msg] = true; -} +const v5 = '5.0.0'; export default function deprecated(PIXI) { @@ -60,7 +15,7 @@ SVG_SIZE: { get() { - warn('PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -74,7 +29,7 @@ TransformStatic: { get() { - warn('PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -88,7 +43,7 @@ TransformBase: { get() { - warn('PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -109,7 +64,7 @@ TRANSFORM_MODE: { get() { - warn('PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -123,7 +78,7 @@ WebGLRenderer: { get() { - warn('PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -137,7 +92,7 @@ CanvasRenderTarget: { get() { - warn('PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -153,7 +108,7 @@ loader: { get() { - warn('PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -167,7 +122,7 @@ FilterManager: { get() { - warn('PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterManager; }, @@ -191,7 +146,7 @@ TilingSprite: { get() { - warn('PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -204,7 +159,7 @@ TilingSpriteRenderer: { get() { - warn('PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -217,7 +172,7 @@ AnimatedSprite: { get() { - warn('PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -230,7 +185,7 @@ BitmapText: { get() { - warn('PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -246,7 +201,7 @@ getSvgSize: { get() { - warn('PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -269,7 +224,7 @@ Mesh: { get() { - warn('PIXI.mesh.Mesh has moved to PIXI.Mesh2d'); + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.Mesh2d'); return PIXI.Mesh2d; }, @@ -282,7 +237,7 @@ NineSlicePlane: { get() { - warn('PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -295,7 +250,7 @@ Plane: { get() { - warn('PIXI.mesh.Plane has moved to PIXI.Plane'); + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.Plane'); return PIXI.Plane; }, @@ -308,7 +263,7 @@ Rope: { get() { - warn('PIXI.mesh.Rope has moved to PIXI.Rope'); + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.Rope'); return PIXI.Rope; }, @@ -321,7 +276,7 @@ RawMesh: { get() { - warn('PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -334,7 +289,7 @@ CanvasMeshRenderer: { get() { - warn('PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -347,7 +302,7 @@ MeshRenderer: { get() { - warn('PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -371,7 +326,7 @@ ParticleContainer: { get() { - warn('PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -384,7 +339,7 @@ ParticleRenderer: { get() { - warn('PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -408,7 +363,7 @@ Ticker: { get() { - warn('PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -422,7 +377,7 @@ shared: { get() { - warn('PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -445,7 +400,7 @@ Loader: { get() { - warn('PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -458,7 +413,7 @@ Resource: { get() { - warn('PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -471,7 +426,7 @@ bitmapFontParser: { get() { - warn('PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -484,7 +439,7 @@ parseBitmapFontData: { get() { - warn('PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -497,7 +452,7 @@ spritesheetParser: { get() { - warn('PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -510,7 +465,7 @@ getResourcePath: { get() { - warn('PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -525,7 +480,7 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - warn('PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -538,7 +493,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - warn('PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -552,7 +507,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - warn('PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -567,7 +522,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - warn('PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); this._render(renderer); }; @@ -580,7 +535,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - warn('PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); this.render(renderer); }; @@ -593,7 +548,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - warn('PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); this.render(renderer); }; @@ -606,7 +561,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - warn('PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); this.renderAdvanced(renderer); }; @@ -624,13 +579,13 @@ TRANSFORM_MODE: { get() { - warn('PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); return 0; }, set() { - warn('PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); }, }, }); @@ -646,7 +601,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - warn('PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -662,7 +617,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - warn('PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -676,7 +631,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - warn('PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -690,7 +645,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - warn('PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); return this.copyFrom(p); }; @@ -702,7 +657,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - warn('PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); return this.copyFrom(p); }; @@ -714,7 +669,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - warn('PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); return this.copyFrom(p); }; @@ -726,7 +681,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - warn('PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); return this.copyTo(p); }; @@ -739,7 +694,7 @@ */ getRenderTarget(clear, resolution) { - warn('FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); return this.getFilterTexture(resolution); }, @@ -751,7 +706,7 @@ */ returnRenderTarget(renderTexture) { - warn('FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); this.returnFilterTexture(renderTexture); }, @@ -767,7 +722,7 @@ sourceFrame: { get() { - warn('PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); return this.filterFrame; }, @@ -781,7 +736,7 @@ size: { get() { - warn('PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); return this._frame; }, @@ -798,7 +753,7 @@ { constructor(strength, quality, resolution, kernelSize) { - warn('PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -814,7 +769,7 @@ { constructor(strength, quality, resolution, kernelSize) { - warn('PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -830,7 +785,7 @@ // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - warn(`PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -883,7 +838,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - warn(`PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -941,13 +896,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - warn('PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - warn('PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); this.autoDensity = value; }, diff --git a/packages/utils/src/index.js b/packages/utils/src/index.js index d9bce7f..a46acc5 100644 --- a/packages/utils/src/index.js +++ b/packages/utils/src/index.js @@ -72,5 +72,6 @@ export * from './media'; export * from './network'; export * from './const'; +export * from './logging'; import './settings'; diff --git a/packages/utils/src/logging/deprecation.js b/packages/utils/src/logging/deprecation.js new file mode 100644 index 0000000..321cd44 --- /dev/null +++ b/packages/utils/src/logging/deprecation.js @@ -0,0 +1,55 @@ +// A map of warning messages already fired +const warnings = {}; + +/** + * Helper for warning developers about deprecated features & settings. + * A stack track for warnings is given; useful for tracking-down where + * deprecated methods/properties/classes are being used within the code. + * + * @memberof PIXI.utils + * @function deprecation + * @param {string} version - The version where the feature became deprecated + * @param {string} message - Message should include what is deprecated, where, and the new solution + */ +export function deprecation(version, message) +{ + // Ignore duplicat + if (warnings[message]) + { + return; + } + + /* eslint-disable no-console */ + let stack = new Error().stack; + + // Handle IE < 10 and Safari < 6 + if (typeof stack === 'undefined') + { + console.warn('PixiJS Deprecation Warning: ', `${message}\nDeprecated since v${version}`); + } + else + { + // chop off the stack trace which includes PixiJS internal calls + stack = stack.split('\n').splice(3).join('\n'); + + if (console.groupCollapsed) + { + console.groupCollapsed( + '%cPixiJS Deprecation Warning: %c%s', + 'color:#614108;background:#fffbe6', + 'font-weight:normal;color:#614108;background:#fffbe6', + `${message}\nDeprecated since v${version}` + ); + console.warn(stack); + console.groupEnd(); + } + else + { + console.warn('PixiJS Deprecation Warning: ', `${message}\nDeprecated since v${version}`); + console.warn(stack); + } + } + /* eslint-enable no-console */ + + warnings[message] = true; +} diff --git a/packages/utils/src/logging/index.js b/packages/utils/src/logging/index.js new file mode 100644 index 0000000..cc8b1c6 --- /dev/null +++ b/packages/utils/src/logging/index.js @@ -0,0 +1 @@ +export * from './deprecation';