virtualx-engine/doc/classes/InputEventMouse.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMouse" inherits="InputEventWithModifiers" version="4.0">
	<brief_description>
		Base input event type for mouse events.
	</brief_description>
	<description>
		Stores general mouse events information.
	</description>
	<tutorials>
		<link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link>
	</tutorials>
	<members>
		<member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" enum="MouseButton" default="0">
			The mouse button mask identifier, one of or a bitwise combination of the [enum MouseButton] button masks.
		</member>
		<member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position" default="Vector2(0, 0)">
			The global mouse position relative to the current [Viewport]. If used in [method Control._gui_input] and if the current [Control] is not under the mouse, moving it will not update this value.
		</member>
		<member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)">
			The local mouse position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] which is under the mouse. If the current  [Control] is not under the mouse, moving it will not update this value.
		</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 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update docs to version 4.0 2020-02-01 02:03:48 +01:00			`<class name="InputEventMouse" inherits="InputEventWithModifiers" version="4.0">`
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 22:42:36 +02:00			`<brief_description>`
			`Base input event type for mouse events.`
			`</brief_description>`
			`<description>`
Fix typos in code and docs with codespell Using v1.11.0 from https://github.com/lucasdemarchi/codespell 2018-01-18 21:37:17 +01:00			`Stores general mouse events information.`
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 22:42:36 +02:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 10:43:07 +01: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 22:42:36 +02:00			`</tutorials>`
			`<members>`
Use "enum class" for input enums 2021-08-13 23:31:57 +02:00			`<member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" enum="MouseButton" default="0">`
Rename some more global enums (Key, Joy, MIDI) 2020-05-14 00:27:34 +02:00			`The mouse button mask identifier, one of or a bitwise combination of the [enum MouseButton] button masks.`
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 22:42:36 +02:00			`</member>`
Better format arguments in variant parser 2019-09-24 19:45:03 +02:00			`<member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position" default="Vector2(0, 0)">`
Improve mouse input event class reference 2021-12-24 02:10:41 +01:00			`The global mouse position relative to the current [Viewport]. If used in [method Control._gui_input] and if the current [Control] is not under the mouse, moving it will not update this value.`
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 22:42:36 +02:00			`</member>`
Better format arguments in variant parser 2019-09-24 19:45:03 +02:00			`<member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)">`
Improve mouse input event class reference 2021-12-24 02:10:41 +01:00			`The local mouse position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] which is under the mouse. If the current [Control] is not under the mouse, moving it will not update this value.`
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 22:42:36 +02:00			`</member>`
			`</members>`
			`</class>`