mirror of
https://github.com/photonstorm/phaser
synced 2024-12-20 01:55:45 +00:00
1 line
15 KiB
JSON
1 line
15 KiB
JSON
|
{"class":{"name":"Phaser.Pointer","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"id","type":["number"],"help":"The ID of the Pointer object within the game. Each game can have up to 10 active pointers.","optional":false,"default":null}],"help":"A Pointer object is used by the Mouse, Touch and MSPoint managers and represents a single finger on the touch screen."},"consts":[],"methods":{"public":[{"name":"justPressed","static":false,"returns":{"types":["boolean"],"help":"true if the Pointer was pressed down within the duration given."},"help":"The Pointer is considered justPressed if the time it was pressed onto the touchscreen or clicked is less than justPressedRate.\\nNote that calling justPressed doesn't reset the pressed status of the Pointer, it will return `true` for as long as the duration is valid.\\nIf you wish to check if the Pointer was pressed down just once then see the Sprite.events.onInputDown event.","line":648,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The time to check against. If none given it will use InputManager.justPressedRate.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"justReleased","static":false,"returns":{"types":["boolean"],"help":"true if the Pointer was released within the duration given."},"help":"The Pointer is considered justReleased if the time it left the touchscreen is less than justReleasedRate.\\nNote that calling justReleased doesn't reset the pressed status of the Pointer, it will return `true` for as long as the duration is valid.\\nIf you wish to check if the Pointer was released just once then see the Sprite.events.onInputUp event.","line":664,"public":true,"protected":false,"private":false,"parameters":[{"name":"duration","type":["number"],"help":"The time to check against. If none given it will use InputManager.justReleasedRate.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"leave","static":false,"returns":null,"help":"Called when the Pointer leaves the target area.","line":567,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent","PointerEvent","TouchEvent"],"help":"The event passed up from the input handler.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"move","static":false,"returns":null,"help":"Called when the Pointer is moved.","line":375,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent","PointerEvent","TouchEvent"],"help":"The event passed up from the input handler.","optional":false,"default":null},{"name":"fromClick","type":["boolean"],"help":"Was this called from the click event?","optional":true,"default":"false"}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the Pointer properties. Called by InputManager.reset when you perform a State change.","line":676,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"resetMovement","static":false,"returns":null,"help":"Resets the movementX and movementY properties. Use in your update handler after retrieving the values.","line":706,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Called when the Pointer is pressed onto the touchscreen.","line":261,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["any"],"help":"The DOM event from the browser.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Called when the Pointer leaves the touchscreen.","line":580,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent","PointerEvent","TouchEvent"],"help":"The event passe
|