mirror of
https://github.com/godotengine/godot.git
synced 2024-12-14 23:27:24 +00:00
b68dd2e189
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.
26 lines
1.7 KiB
XML
26 lines
1.7 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="InputEventMouse" inherits="InputEventWithModifiers" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<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)">
|
|
When received in [method Node._input] or [method Node._unhandled_input], returns the mouse's position in the root [Viewport] using the coordinate system of the root [Viewport].
|
|
When received in [method Control._gui_input], returns the mouse's position in the [CanvasLayer] that the [Control] is in using the coordinate system of the [CanvasLayer].
|
|
</member>
|
|
<member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)">
|
|
When received in [method Node._input] or [method Node._unhandled_input], returns the mouse's position in the [Viewport] this [Node] is in using the coordinate system of this [Viewport].
|
|
When received in [method Control._gui_input], returns the mouse's position in the [Control] using the local coordinate system of the [Control].
|
|
</member>
|
|
</members>
|
|
</class>
|