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

{"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":"Internal release pointer lock handler.","line":509,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"requestPointerLock","static":false,"returns":null,"help":"If the browser supports it you can request that the pointer be locked to the browser window.\\nThis is classically known as 'FPS controls', where the pointer can't leave the browser until the user presses an exit key.\\nIf the browser successfully enters a locked state the event Phaser.Mouse.pointerLock will be dispatched and the first parameter will be 'true'.","line":457,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts the event listeners running.","line":184,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stop the event listeners.","line":525,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"button-","type":["number"],"help":"","inlineHelp":" The type of click, either: Phaser.Mouse.NO_BUTTON, Phaser.Mouse.LEFT_BUTTON, Phaser.Mouse.MIDDLE_BUTTON or Phaser.Mouse.RIGHT_BUTTON.","line":67,"default":"-1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context under which callbacks are called.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"capture","type":["boolean"],"help":"","inlineHelp":"If true the DOM mouse events will have event.preventDefault applied to them, if false they will propogate fully.","line":61,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"disabled","type":["boolean"],"help":"","inlineHelp":"You can disable all Input by setting disabled = true. While set all new input related events will be ignored.","line":78,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"event","type":["MouseEvent"],"help":"","inlineHelp":"The browser mouse DOM event. Will be set to null if no mouse event has ever been received.","line":102,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":21,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"locked","type":["boolean"],"help":"","inlineHelp":"If the mouse has been Pointer Locked successfully this will be set to true.","line":84,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseDownCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse is pressed down.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseMoveCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse is moved while pressed down.","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseOutCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse is no longer over the game canvas.","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseOverCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse enters the game canvas (usually after a mouseout).","line":51,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseUpCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mouse is released from a pressed down state.","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mouseWheelCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired when the mousewheel is used.","line":56,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"pointerLock","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when the browser enters or leaves pointer lock state.","line":96,"default":"new Phaser.Signal()","public":true,"protected":false,"private":false,"readOnly":false},{"name":"stopOnGameOut","type":["boolean"],"help":"","inlineHelp":"If true Pointer.stop will be called if the mouse leaves the game canvas.","line":90,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"wheelDelta","type":["number"],"help":"","inlineHelp":"The direction of the mousewheel usage 1 for up -1 for down","line":72,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_onMouseDown","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":108,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseMove","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":114,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseOut","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":126,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseOver","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":132,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseUp","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":120,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onMouseWheel","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":138,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}