virtualx-engine/doc/classes/InputEventMouse.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMouse" inherits="InputEventWithModifiers" version="3.5">
	<brief_description>
		Base input event type for mouse events.
	</brief_description>
	<description>
		Stores general mouse events information.
	</description>
	<tutorials>
		<link>$DOCS_URL/tutorials/inputs/inputevent.html</link>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" default="0">
			The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] 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] when used in [method Control._gui_input], otherwise is at 0,0.
		</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.
		</member>
	</members>
	<constants>
	</constants>
</class>