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

1 line
10 KiB
JSON
Raw Normal View History

{"class":{"name":"Phaser.Mouse","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"Phaser.Mouse is responsible for handling all aspects of mouse interaction with the browser.\\nIt captures and processes mouse events that happen on the game canvas object. It also adds a single `mouseup` listener to `window` which\\nis used to capture the mouse being released when not over the game."},"consts":[{"name":"LEFT_BUTTON","type":"number","help":"","line":152},{"name":"MIDDLE_BUTTON","type":"number","help":"","line":158},{"name":"NO_BUTTON","type":"number","help":"","line":146},{"name":"RIGHT_BUTTON","type":"number","help":"","line":164},{"name":"WHEEL_DOWN","type":"number","help":"","line":176},{"name":"WHEEL_UP","type":"number","help":"","line":170}],"methods":{"public":[{"name":"onMouseDown","static":false,"returns":null,"help":"The internal method that handles the mouse down event from the browser.","line":248,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseMove","static":false,"returns":null,"help":"The internal method that handles the mouse move event from the browser.","line":280,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseOut","static":false,"returns":null,"help":"The internal method that handles the mouse out event from the browser.","line":367,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseOver","static":false,"returns":null,"help":"The internal method that handles the mouse over event from the browser.","line":428,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseUp","static":false,"returns":null,"help":"The internal method that handles the mouse up event from the browser.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseUpGlobal","static":false,"returns":null,"help":"The internal method that handles the mouse up event from the window.","line":343,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onMouseWheel","static":false,"returns":null,"help":"The internal method that handles the mouse wheel event from the browser.","line":403,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["MouseEvent"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pointerLockChange","static":false,"returns":null,"help":"Internal pointerLockChange handler.","line":486,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["Event"],"help":"The native event from the browser. This gets stored in Mouse.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"releasePointerLock","static":false,"returns":null,"help":"Inter