godot/doc/classes/InputEventMouseButton.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMouseButton" inherits="InputEventMouse" keywords="click, press" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Represents a mouse button being pressed or released.
	</brief_description>
	<description>
		Stores information about mouse click events. See [method Node._input].
		[b]Note:[/b] On Wear OS devices, rotary input is mapped to [constant MOUSE_BUTTON_WHEEL_UP] and [constant MOUSE_BUTTON_WHEEL_DOWN]. This can be changed to [constant MOUSE_BUTTON_WHEEL_LEFT] and [constant MOUSE_BUTTON_WHEEL_RIGHT] with the [member ProjectSettings.input_devices/pointing/android/rotary_input_scroll_axis] setting.
	</description>
	<tutorials>
		<link title="Using InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link>
		<link title="Mouse and input coordinates">$DOCS_URL/tutorials/inputs/mouse_and_input_coordinates.html</link>
	</tutorials>
	<members>
		<member name="button_index" type="int" setter="set_button_index" getter="get_button_index" enum="MouseButton" default="0">
			The mouse button identifier, one of the [enum MouseButton] button or button wheel constants.
		</member>
		<member name="canceled" type="bool" setter="set_canceled" getter="is_canceled" default="false">
			If [code]true[/code], the mouse button event has been canceled.
		</member>
		<member name="double_click" type="bool" setter="set_double_click" getter="is_double_click" default="false">
			If [code]true[/code], the mouse button's state is a double-click.
		</member>
		<member name="factor" type="float" setter="set_factor" getter="get_factor" default="1.0">
			The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be [code]0[/code] if not supported.
		</member>
		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">
			If [code]true[/code], the mouse button's state is pressed. If [code]false[/code], the mouse button's state is released.
		</member>
	</members>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update class reference to include some keywords More should be added in future PRs, wherever there is demand. 2023-07-04 00:19:12 +08:00			`<class name="InputEventMouseButton" inherits="InputEventMouse" keywords="click, press" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<brief_description>`
Overhaul the top sections of the class reference (Core classes) 2023-04-28 07:35:33 +08:00			`Represents a mouse button being pressed or released.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (Core classes) 2023-04-28 07:35:33 +08:00			`Stores information about mouse click events. See [method Node._input].`
Add rotary input support. Fix documentation 2024-02-09 18:33:06 +08:00			`[b]Note:[/b] On Wear OS devices, rotary input is mapped to [constant MOUSE_BUTTON_WHEEL_UP] and [constant MOUSE_BUTTON_WHEEL_DOWN]. This can be changed to [constant MOUSE_BUTTON_WHEEL_LEFT] and [constant MOUSE_BUTTON_WHEEL_RIGHT] with the [member ProjectSettings.input_devices/pointing/android/rotary_input_scroll_axis] setting.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
Overhaul the top sections of the class reference (Core classes) 2023-04-28 07:35:33 +08:00			`<link title="Using InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 17:43:07 +08:00			`<link title="Mouse and input coordinates">$DOCS_URL/tutorials/inputs/mouse_and_input_coordinates.html</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</tutorials>`
			`<members>`
Use mouse and joypad enums instead of plain integers Also MIDIMessage 2021-03-26 04:56:12 +08:00			`<member name="button_index" type="int" setter="set_button_index" getter="get_button_index" enum="MouseButton" default="0">`
Rename some more global enums (Key, Joy, MIDI) 2020-05-14 06:27:34 +08:00			`The mouse button identifier, one of the [enum MouseButton] button or button wheel constants.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
Augment the `InputEvent` class with a `CANCELED` state The `InputEvent` class currently supports the `pressed` and `released` states, which given the binary nature, is represented by a `bool` field. This commit introduced the `CANCELED` state, which signals that an ongoing input event has been canceled. To represent all the states, the `InputEventState` enum is added and the `InputEvent` logic is refactored accordingly. 2023-05-04 08:57:13 +08:00			`<member name="canceled" type="bool" setter="set_canceled" getter="is_canceled" default="false">`
			`If [code]true[/code], the mouse button event has been canceled.`
			`</member>`
Rename `doubleclick` to `double_click` 2021-04-13 16:25:44 +08:00			`<member name="double_click" type="bool" setter="set_double_click" getter="is_double_click" default="false">`
doc: Add missing commas after "If true/false" 2018-12-20 20:46:54 +08:00			`If [code]true[/code], the mouse button's state is a double-click.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="factor" type="float" setter="set_factor" getter="get_factor" default="1.0">`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 07:04:47 +08:00			`The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be [code]0[/code] if not supported.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">`
doc: Add missing commas after "If true/false" 2018-12-20 20:46:54 +08:00			`If [code]true[/code], the mouse button's state is pressed. If [code]false[/code], the mouse button's state is released.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
			`</members>`
			`</class>`