Index · Object → RefCounted → Resource → InputEvent → InputEventFromWindow → InputEventWithModifiers → InputEventMouse → InputEventMouseButton

InputEventMouseButton

Represents a mouse button being pressed or released.

Class Description

Stores information about mouse click events. See Node._input().

Note: On Wear OS devices, rotary input is mapped to MOUSE_BUTTON_WHEEL_UP and MOUSE_BUTTON_WHEEL_DOWN. This can be changed to MOUSE_BUTTON_WHEEL_LEFT and MOUSE_BUTTON_WHEEL_RIGHT with the ProjectSettings.input_devices/pointing/android/rotary_input_scroll_axis setting.

Properties

var button_index: MouseButton = 0

The mouse button identifier, one of the MouseButton button or button wheel constants.

var canceled: bool = false

If true, the mouse button event has been canceled.

var double_click: bool = false

If true, the mouse button's state is a double-click.

var factor: float = 1.0

The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be 0 if not supported.

var pressed: bool = false

If true, the mouse button's state is pressed. If false, the mouse button's state is released.

Inherited from InputEventMouse (4)
var button_mask: MouseButtonMask = 0
var device: int = 32
var global_position: Vector2 = Vector2(0, 0)
var position: Vector2 = Vector2(0, 0)
Inherited from InputEventWithModifiers (6)
var alt_pressed: bool = false
var ctrl_pressed: bool = false
var device: int = 16
var meta_pressed: bool = false
var shift_pressed: bool = false
Inherited from InputEventFromWindow (1)
var window_id: int = 0
Inherited from InputEvent (1)
var device: int = 0
Inherited from Resource (4)

Methods

Inherited from InputEventWithModifiers (2)
func get_modifiers_mask() -> KeyModifierMask
Inherited from InputEvent (13)
func accumulate(with_event: InputEvent) -> bool
func as_text() -> String
func get_action_strength(action: StringName, exact_match: bool = false) -> float
func is_action(action: StringName, exact_match: bool = false) -> bool
func is_action_pressed(action: StringName, allow_echo: bool = false, exact_match: bool = false) -> bool
func is_action_released(action: StringName, exact_match: bool = false) -> bool
func is_canceled() -> bool
func is_echo() -> bool
func is_match(event: InputEvent, exact_match: bool = true) -> bool
func is_pressed() -> bool
func is_released() -> bool
func xformed_by(xform: Transform2D, local_ofs: Vector2 = Vector2(0, 0)) -> InputEvent
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)