godot/doc/classes/InputEventMouse.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Base input event type for mouse events.
	</brief_description>
	<description>
		Stores general mouse events informations.
	</description>
	<tutorials>
		http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_button_mask" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="get_global_position" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
			</description>
		</method>
		<method name="get_position" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
			</description>
		</method>
		<method name="set_button_mask">
			<return type="void">
			</return>
			<argument index="0" name="button_mask" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_global_position">
			<return type="void">
			</return>
			<argument index="0" name="global_position" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_position">
			<return type="void">
			</return>
			<argument index="0" name="position" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask">
			Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
		</member>
		<member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position">
			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">
			Mouse local position relative to the [Viewport]. If used in [method Control._gui_input] the position is relative to the current [Control] wich is under the mouse.
		</member>
	</members>
	<constants>
	</constants>
</class>