godot/doc/classes/InputEventScreenTouch.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventScreenTouch" inherits="InputEventFromWindow" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Represents a screen touch event.
	</brief_description>
	<description>
		Stores information about multi-touch press/release input events. Supports touch press, touch release and [member index] for multi-touch count and order.
	</description>
	<tutorials>
		<link title="Using InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link>
	</tutorials>
	<members>
		<member name="canceled" type="bool" setter="set_canceled" getter="is_canceled" default="false">
			If [code]true[/code], the touch event has been canceled.
		</member>
		<member name="double_tap" type="bool" setter="set_double_tap" getter="is_double_tap" default="false">
			If [code]true[/code], the touch's state is a double tap.
		</member>
		<member name="index" type="int" setter="set_index" getter="get_index" default="0">
			The touch index in the case of a multi-touch event. One index = one finger.
		</member>
		<member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)">
			The touch position, in screen (global) coordinates.
		</member>
		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">
			If [code]true[/code], the touch's state is pressed. If [code]false[/code], the touch'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-12 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 08:08:05 +00:00			`<class name="InputEventScreenTouch" inherits="InputEventFromWindow" 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-12 20:42:36 +00:00			`<brief_description>`
Overhaul the top sections of the class reference (Core classes) 2023-04-27 23:35:33 +00:00			`Represents a screen touch event.`
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-12 20:42:36 +00:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (Core classes) 2023-04-27 23:35:33 +00:00			`Stores information about multi-touch press/release input events. Supports touch press, touch release and [member index] for multi-touch count and order.`
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-12 20:42:36 +00:00			`</description>`
			`<tutorials>`
Overhaul the top sections of the class reference (Core classes) 2023-04-27 23:35:33 +00:00			`<link title="Using InputEvent">$DOCS_URL/tutorials/inputs/inputevent.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-12 20:42:36 +00:00			`</tutorials>`
			`<members>`
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 00:57:13 +00:00			`<member name="canceled" type="bool" setter="set_canceled" getter="is_canceled" default="false">`
			`If [code]true[/code], the touch event has been canceled.`
			`</member>`
Add double_tap attribute to InputEventScreenTouch This provides parity with the `InputEventMouseButton` allowing for proper conversion between the two events. 2022-10-22 14:30:46 +00:00			`<member name="double_tap" type="bool" setter="set_double_tap" getter="is_double_tap" default="false">`
			`If [code]true[/code], the touch's state is a double tap.`
			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="index" type="int" setter="set_index" getter="get_index" default="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-21 23:04:47 +00:00			`The touch index in the case of a multi-touch event. One index = one finger.`
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-12 20:42:36 +00:00			`</member>`
Better format arguments in variant parser 2019-09-24 17:45:03 +00:00			`<member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)">`
Misc improvements to various docs 2021-11-30 21:32:23 +00:00			`The touch position, in screen (global) coordinates.`
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-12 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00: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 12:46:54 +00:00			`If [code]true[/code], the touch's state is pressed. If [code]false[/code], the touch'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-12 20:42:36 +00:00			`</member>`
			`</members>`
			`</class>`