phaser/resources/docgen/output/Phaser.InputHandler.json

1 line
29 KiB
JSON
Raw Normal View History

{"class":{"name":"Phaser.InputHandler","extends":"","static":false,"constructor":true,"parameters":[{"name":"sprite","type":["Phaser.Sprite"],"help":"The Sprite object to which this Input Handler belongs.","optional":false,"default":null}],"help":"The Input Handler is bound to a specific Sprite and is responsible for managing all Input events on that Sprite."},"consts":[],"methods":{"public":[{"name":"checkBoundsRect","static":false,"returns":null,"help":"Bounds Rect check for the sprite drag","line":1421,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"checkBoundsSprite","static":false,"returns":null,"help":"Parent Sprite Bounds check for the sprite drag.","line":1470,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"checkPixel","static":false,"returns":{"types":["boolean"],"help":"true if there is the alpha of the pixel is >= InputHandler.pixelPerfectAlpha"},"help":"Runs a pixel perfect check against the given x\/y coordinates of the Sprite this InputHandler is bound to.\\nIt compares the alpha value of the pixel and if >= InputHandler.pixelPerfectAlpha it returns true.","line":728,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The x coordinate to check.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate to check.","optional":false,"default":null},{"name":"pointer","type":["Phaser.Pointer"],"help":"The pointer to get the x\/y coordinate from if not passed as the first two parameters.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkPointerDown","static":false,"returns":{"types":["boolean"],"help":"True if the pointer is down, otherwise false."},"help":"Checks if the given pointer is both down and over the Sprite this InputHandler belongs to.\\nUse the `fastTest` flag is to quickly check just the bounding hit area even if `InputHandler.pixelPerfectOver` is `true`.","line":658,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null},{"name":"fastTest","type":["boolean"],"help":"Force a simple hit area check even if `pixelPerfectOver` is true for this object?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"checkPointerOver","static":false,"returns":{"types":["boolean"],"help":""},"help":"Checks if the given pointer is over the Sprite this InputHandler belongs to.\\nUse the `fastTest` flag is to quickly check just the bounding hit area even if `InputHandler.pixelPerfectOver` is `true`.","line":693,"public":true,"protected":false,"private":false,"parameters":[{"name":"pointer","type":["Phaser.Pointer"],"help":"","optional":false,"default":null},{"name":"fastTest","type":["boolean"],"help":"Force a simple hit area check even if `pixelPerfectOver` is true for this object?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Clean up memory.","line":386,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"disableDrag","static":false,"returns":null,"help":"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.","line":1230,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"disableSnap","static":false,"returns":null,"help":"Stops the sprite from snapping to a grid during drag or release.","line":1410,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"downDuration","static":false,"returns":{"types":["number"],"help":"The number of milliseconds the pointer has been pressed down on the Sprite, or -1 if not over."},"help":"If the pointer is currently over this Sprite this returns how long it has been the