From 140e743a8df7599b6cf7e8c1aa035a53ceec5db3 Mon Sep 17 00:00:00 2001 From: Richard Davey Date: Fri, 8 Jun 2018 18:24:08 +0100 Subject: [PATCH] Added docs and fixed lint issue --- src/input/CreatePixelPerfectHandler.js | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/src/input/CreatePixelPerfectHandler.js b/src/input/CreatePixelPerfectHandler.js index f7f08811a..c91b63182 100644 --- a/src/input/CreatePixelPerfectHandler.js +++ b/src/input/CreatePixelPerfectHandler.js @@ -5,20 +5,17 @@ */ /** - * Creates a new Interactive Object. - * - * This is called automatically by the Input Manager when you enable a Game Object for input. + * Creates a new Pixel Perfect Handler function. * - * The resulting Interactive Object is mapped to the Game Object's `input` property. + * Access via `InputPlugin.makePixelPerfect` rather than calling it directly. * * @function Phaser.Input.CreatePixelPerfectHandler * @since 3.10.0 * - * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to which this Interactive Object is bound. - * @param {any} hitArea - The hit area for this Interactive Object. Typically a geometry shape, like a Rectangle or Circle. - * @param {HitAreaCallback} hitAreaCallback - The 'contains' check callback that the hit area shape will use for all hit tests. + * @param {Phaser.Textures.TextureManager} textureManager - A reference to the Texture Manager. + * @param {integer} alphaTolerance - The alpha level that the pixel should be above to be included as a successful interaction. * - * @return {Phaser.Input.InteractiveObject} The new Interactive Object. + * @return {function} The new Pixel Perfect Handler function. */ var CreatePixelPerfectHandler = function (textureManager, alphaTolerance) { @@ -26,7 +23,7 @@ var CreatePixelPerfectHandler = function (textureManager, alphaTolerance) { var alpha = textureManager.getPixelAlpha(x, y, gameObject.texture.key, gameObject.frame.key); - return (alpha && alpha >= alphaTolerance) + return (alpha && alpha >= alphaTolerance); }; };