godot/doc/classes/InputEventMouseButton.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.1">
	<brief_description>
		Input event type for mouse button events.
	</brief_description>
	<description>
		Contains mouse click information. See [method Node._input].
	</description>
	<tutorials>
		<link>https://docs.godotengine.org/en/latest/tutorials/inputs/mouse_and_input_coordinates.html</link>
	</tutorials>
	<demos>
	</demos>
	<methods>
	</methods>
	<members>
		<member name="button_index" type="int" setter="set_button_index" getter="get_button_index">
			Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@GlobalScope].
		</member>
		<member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick">
			If [code]true[/code] the mouse button's state is a double-click.
		</member>
		<member name="factor" type="float" setter="set_factor" getter="get_factor">
			Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scroll amount (vertically or horizontally). Only supported on some platforms, sensitivity varies by platform. May be 0 if not supported.
		</member>
		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
			If [code]true[/code] the mouse button's state is pressed. If [code]false[/code] the mouse button's state is released.
		</member>
	</members>
	<constants>
	</constants>
</class>