godot/doc/classes/InputEventScreenDrag.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventScreenDrag" inherits="InputEventFromWindow" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Input event type for screen drag events. Only available on mobile devices.
	</brief_description>
	<description>
		Contains screen drag information. See [method Node._input].
	</description>
	<tutorials>
		<link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link>
	</tutorials>
	<members>
		<member name="index" type="int" setter="set_index" getter="get_index" default="0">
			The drag event index in the case of a multi-drag event.
		</member>
		<member name="pen_inverted" type="bool" setter="set_pen_inverted" getter="get_pen_inverted" default="false">
			Returns [code]true[/code] when using the eraser end of a stylus pen.
		</member>
		<member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)">
			The drag position.
		</member>
		<member name="pressure" type="float" setter="set_pressure" getter="get_pressure" default="0.0">
			Represents the pressure the user puts on the pen. Ranges from [code]0.0[/code] to [code]1.0[/code].
		</member>
		<member name="relative" type="Vector2" setter="set_relative" getter="get_relative" default="Vector2(0, 0)">
			The drag position relative to the previous position (position at the last frame).
		</member>
		<member name="tilt" type="Vector2" setter="set_tilt" getter="get_tilt" default="Vector2(0, 0)">
			Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from [code]-1.0[/code] to [code]1.0[/code] for both axes.
		</member>
		<member name="velocity" type="Vector2" setter="set_velocity" getter="get_velocity" default="Vector2(0, 0)">
			The drag velocity.
		</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" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 13:18:53 +00:00			`<class name="InputEventScreenDrag" inherits="InputEventFromWindow" version="4.0" 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>`
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			`Input event type for screen drag events. Only available on mobile devices.`
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>`
Fix typos in code and docs with codespell Using v1.11.0 from https://github.com/lucasdemarchi/codespell 2018-01-18 20:37:17 +00:00			`Contains screen drag information. See [method Node._input].`
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>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 09:43:07 +00:00			`<link title="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>`
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 drag event index in the case of a multi-drag 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			`</member>`
[iOS] Add Apple Pencil pressure and tilt support. 2022-12-23 15:37:45 +00:00			`<member name="pen_inverted" type="bool" setter="set_pen_inverted" getter="get_pen_inverted" default="false">`
			`Returns [code]true[/code] when using the eraser end of a stylus pen.`
			`</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)">`
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 drag position.`
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>`
[iOS] Add Apple Pencil pressure and tilt support. 2022-12-23 15:37:45 +00:00			`<member name="pressure" type="float" setter="set_pressure" getter="get_pressure" default="0.0">`
			`Represents the pressure the user puts on the pen. Ranges from [code]0.0[/code] to [code]1.0[/code].`
			`</member>`
Better format arguments in variant parser 2019-09-24 17:45:03 +00:00			`<member name="relative" type="Vector2" setter="set_relative" getter="get_relative" default="Vector2(0, 0)">`
Change description of relative field in input drag event. 2021-11-03 20:29:12 +00:00			`The drag position relative to the previous position (position at the last frame).`
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>`
[iOS] Add Apple Pencil pressure and tilt support. 2022-12-23 15:37:45 +00:00			`<member name="tilt" type="Vector2" setter="set_tilt" getter="get_tilt" default="Vector2(0, 0)">`
			`Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from [code]-1.0[/code] to [code]1.0[/code] for both axes.`
			`</member>`
Rename speed to velocity when it's a directional Vector 2021-12-29 13:22:22 +00:00			`<member name="velocity" type="Vector2" setter="set_velocity" getter="get_velocity" default="Vector2(0, 0)">`
			`The drag velocity.`
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>`