scala-native-gdextension
API
Generated with
scala-native-gdextension/gdext/gdext.classes/InputEventMouseButton

InputEventMouseButton

gdext.classes.InputEventMouseButton
See theInputEventMouseButton companion object
abstract class InputEventMouseButton extends InputEventMouse

Generated wrapper for Godot's InputEventMouseButton, extends InputEventMouse.

Attributes

Companion
object
Graph
Supertypes
class InputEvent
class Resource
class RefCounted
class Object
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

final def getButtonIndex(): Long

InputEventMouseButton.get_button_index

InputEventMouseButton.get_button_index

Attributes

final def getFactor(): Double

InputEventMouseButton.get_factor

InputEventMouseButton.get_factor

Attributes

override def godotClassName: String

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

Attributes

Definition Classes
final def isDoubleClick(): Boolean

InputEventMouseButton.is_double_click

InputEventMouseButton.is_double_click

Attributes

final def setButtonIndex(button_index: Long): Unit

InputEventMouseButton.set_button_index

InputEventMouseButton.set_button_index

Attributes

final def setCanceled(canceled: Boolean): Unit

InputEventMouseButton.set_canceled

InputEventMouseButton.set_canceled

Attributes

final def setDoubleClick(double_click: Boolean): Unit

InputEventMouseButton.set_double_click

InputEventMouseButton.set_double_click

Attributes

final def setFactor(factor: Double): Unit

InputEventMouseButton.set_factor

InputEventMouseButton.set_factor

Attributes

final def setPressed(pressed: Boolean): Unit

InputEventMouseButton.set_pressed

InputEventMouseButton.set_pressed

Attributes

Inherited methods

def _can_handle(obj: GodotObject): Boolean

EditorInspectorPlugin: can this plugin handle obj's inspector?

EditorInspectorPlugin: can this plugin handle obj's inspector?

Attributes

Inherited from:
GodotScriptClass
def _enter_tree(): Unit

EditorPlugin/Node: entered the (editor) tree.

EditorPlugin/Node: entered the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _exit_tree(): Unit

EditorPlugin/Node: leaving the (editor) tree.

EditorPlugin/Node: leaving the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _input(event: InputEvent): Unit

Called for every unhandled-or-not input event (Node._input).

Called for every unhandled-or-not input event (Node._input).

Attributes

Inherited from:
GodotScriptClass
def _parse_property(obj: GodotObject, varType: Long, name: String, hintType: Long, hintString: String, usage: Long, wide: Boolean): Boolean

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

Attributes

Inherited from:
GodotScriptClass
def _physics_process(delta: Double): Unit

Called every physics frame; delta is the fixed physics step.

Called every physics frame; delta is the fixed physics step.

Attributes

Inherited from:
GodotScriptClass
def _process(delta: Double): Unit

Called every rendered frame; delta is seconds since the last frame.

Called every rendered frame; delta is seconds since the last frame.

Attributes

Inherited from:
GodotScriptClass
def _ready(): Unit

Called when the node enters the scene tree and is ready.

Called when the node enters the scene tree and is ready.

Attributes

Inherited from:
GodotScriptClass
def _shortcut_input(event: InputEvent): Unit

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_input(event: InputEvent): Unit

Called for input not consumed by the UI (Node._unhandled_input).

Called for input not consumed by the UI (Node._unhandled_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_key_input(event: InputEvent): Unit

Called for unhandled key input (Node._unhandled_key_input).

Called for unhandled key input (Node._unhandled_key_input).

Attributes

Inherited from:
GodotScriptClass
def _update_property(): Unit

EditorProperty: refresh the widget from the edited property's value.

EditorProperty: refresh the widget from the edited property's value.

Attributes

Inherited from:
GodotScriptClass
final def accumulate(with_event: InputEvent): Boolean

InputEvent.accumulate

InputEvent.accumulate

Attributes

Inherited from:
InputEvent
final def asText(): String

InputEvent.as_text

InputEvent.as_text

Attributes

Inherited from:
InputEvent
final def canTranslateMessages(): Boolean

Object.can_translate_messages

Object.can_translate_messages

Attributes

Inherited from:
Object
final def cancelFree(): Unit

Object.cancel_free

Object.cancel_free

Attributes

Inherited from:
Object
def cast[U <: GodotScriptClass](using meta: ClassMeta[U]): U

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Attributes

Inherited from:
GodotScriptClass
final def duplicate(deep: Boolean): Resource

Resource.duplicate. Returns an owned reference: release it with unref() or inside Gd.scoped.

Resource.duplicate. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

Inherited from:
Resource
final def duplicateDeep(deep_subresources_mode: Long): Resource

Resource.duplicate_deep. Returns an owned reference: release it with unref() or inside Gd.scoped.

Resource.duplicate_deep. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

Inherited from:
Resource
final def emitChanged(): Unit

Resource.emit_changed

Resource.emit_changed

Attributes

Inherited from:
Resource
def free(): Unit

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Attributes

Inherited from:
GodotScriptClass
final def getActionStrength(action: StringName, exact_match: Boolean): Double

InputEvent.get_action_strength

InputEvent.get_action_strength

Attributes

Inherited from:
InputEvent
final def getButtonMask(): Long

InputEventMouse.get_button_mask

InputEventMouse.get_button_mask

Attributes

Inherited from:
InputEventMouse
final def getDevice(): Long

InputEvent.get_device

InputEvent.get_device

Attributes

Inherited from:
InputEvent
final def getGlobalPosition(): Vector2

InputEventMouse.get_global_position

InputEventMouse.get_global_position

Attributes

Inherited from:
InputEventMouse
final def getIdForPath(path: String): String

Resource.get_id_for_path

Resource.get_id_for_path

Attributes

Inherited from:
Resource
final def getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

Inherited from:
Object
final def getLocalScene(): Node

Resource.get_local_scene

Resource.get_local_scene

Attributes

Inherited from:
Resource
final def getMethodArgumentCount(method: StringName): Long

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

Inherited from:
Object
final def getModifiersMask(): Long

InputEventWithModifiers.get_modifiers_mask

InputEventWithModifiers.get_modifiers_mask

Attributes

Inherited from:
InputEventWithModifiers
final def getName(): String

Resource.get_name

Resource.get_name

Attributes

Inherited from:
Resource
final def getPath(): String

Resource.get_path

Resource.get_path

Attributes

Inherited from:
Resource
final def getPosition(): Vector2

InputEventMouse.get_position

InputEventMouse.get_position

Attributes

Inherited from:
InputEventMouse
final def getReferenceCount(): Long

RefCounted.get_reference_count

RefCounted.get_reference_count

Attributes

Inherited from:
RefCounted
final def getSceneUniqueId(): String

Resource.get_scene_unique_id

Resource.get_scene_unique_id

Attributes

Inherited from:
Resource
final def getTranslationDomain(): StringName

Object.get_translation_domain

Object.get_translation_domain

Attributes

Inherited from:
Object
final def getWindowId(): Long

InputEventFromWindow.get_window_id

InputEventFromWindow.get_window_id

Attributes

Inherited from:
InputEventFromWindow
final def hasConnections(signal: StringName): Boolean

Object.has_connections

Object.has_connections

Attributes

Inherited from:
Object
final def hasMeta(name: StringName): Boolean

Object.has_meta

Object.has_meta

Attributes

Inherited from:
Object
final def hasMethod(method: StringName): Boolean

Object.has_method

Object.has_method

Attributes

Inherited from:
Object
final def hasSignal(signal: StringName): Boolean

Object.has_signal

Object.has_signal

Attributes

Inherited from:
Object
final def hasUserSignal(signal: StringName): Boolean

Object.has_user_signal

Object.has_user_signal

Attributes

Inherited from:
Object
final def hostObject: GodotObject

The engine-side object handle for this instance.

The engine-side object handle for this instance.

Attributes

Inherited from:
GodotScriptClass
final def initRef(): Boolean

RefCounted.init_ref

RefCounted.init_ref

Attributes

Inherited from:
RefCounted
final def instanceId: InstanceId

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

Attributes

Inherited from:
GodotScriptClass
final def isAction(action: StringName, exact_match: Boolean): Boolean

InputEvent.is_action

InputEvent.is_action

Attributes

Inherited from:
InputEvent
final def isActionPressed(action: StringName, allow_echo: Boolean, exact_match: Boolean): Boolean

InputEvent.is_action_pressed

InputEvent.is_action_pressed

Attributes

Inherited from:
InputEvent
final def isActionReleased(action: StringName, exact_match: Boolean): Boolean

InputEvent.is_action_released

InputEvent.is_action_released

Attributes

Inherited from:
InputEvent
final def isActionType(): Boolean

InputEvent.is_action_type

InputEvent.is_action_type

Attributes

Inherited from:
InputEvent
final def isAltPressed(): Boolean

InputEventWithModifiers.is_alt_pressed

InputEventWithModifiers.is_alt_pressed

Attributes

Inherited from:
InputEventWithModifiers
final def isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

Inherited from:
Object
final def isBuiltIn(): Boolean

Resource.is_built_in

Resource.is_built_in

Attributes

Inherited from:
Resource
final def isCanceled(): Boolean

InputEvent.is_canceled

InputEvent.is_canceled

Attributes

Inherited from:
InputEvent
final def isClass(`class`: String): Boolean

Object.is_class

Object.is_class

Attributes

Inherited from:
Object
final def isCommandOrControlAutoremap(): Boolean

InputEventWithModifiers.is_command_or_control_autoremap

InputEventWithModifiers.is_command_or_control_autoremap

Attributes

Inherited from:
InputEventWithModifiers
final def isCommandOrControlPressed(): Boolean

InputEventWithModifiers.is_command_or_control_pressed

InputEventWithModifiers.is_command_or_control_pressed

Attributes

Inherited from:
InputEventWithModifiers
final def isCtrlPressed(): Boolean

InputEventWithModifiers.is_ctrl_pressed

InputEventWithModifiers.is_ctrl_pressed

Attributes

Inherited from:
InputEventWithModifiers
final def isEcho(): Boolean

InputEvent.is_echo

InputEvent.is_echo

Attributes

Inherited from:
InputEvent
final def isLocalToScene(): Boolean

Resource.is_local_to_scene

Resource.is_local_to_scene

Attributes

Inherited from:
Resource
final def isMatch(event: InputEvent, exact_match: Boolean): Boolean

InputEvent.is_match

InputEvent.is_match

Attributes

Inherited from:
InputEvent
final def isMetaPressed(): Boolean

InputEventWithModifiers.is_meta_pressed

InputEventWithModifiers.is_meta_pressed

Attributes

Inherited from:
InputEventWithModifiers
final def isPressed(): Boolean

InputEvent.is_pressed

InputEvent.is_pressed

Attributes

Inherited from:
InputEvent
final def isQueuedForDeletion(): Boolean

Object.is_queued_for_deletion

Object.is_queued_for_deletion

Attributes

Inherited from:
Object
final def isRefCounted: Boolean

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

Attributes

Inherited from:
GodotScriptClass
final def isReleased(): Boolean

InputEvent.is_released

InputEvent.is_released

Attributes

Inherited from:
InputEvent
final def isShiftPressed(): Boolean

InputEventWithModifiers.is_shift_pressed

InputEventWithModifiers.is_shift_pressed

Attributes

Inherited from:
InputEventWithModifiers
def keep(): this.type

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Attributes

Inherited from:
GodotScriptClass
final def notification(what: Long, reversed: Boolean): Unit

Object.notification

Object.notification

Attributes

Inherited from:
Object
final def notifyPropertyListChanged(): Unit

Object.notify_property_list_changed

Object.notify_property_list_changed

Attributes

Inherited from:
Object
final def propertyCanRevert(property: StringName): Boolean

Object.property_can_revert

Object.property_can_revert

Attributes

Inherited from:
Object
def refInc(): this.type

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Attributes

Inherited from:
GodotScriptClass
final def reference(): Boolean

RefCounted.reference

RefCounted.reference

Attributes

Inherited from:
RefCounted
final def removeMeta(name: StringName): Unit

Object.remove_meta

Object.remove_meta

Attributes

Inherited from:
Object
final def removeUserSignal(signal: StringName): Unit

Object.remove_user_signal

Object.remove_user_signal

Attributes

Inherited from:
Object
final def resetState(): Unit

Resource.reset_state

Resource.reset_state

Attributes

Inherited from:
Resource
final def setAltPressed(pressed: Boolean): Unit

InputEventWithModifiers.set_alt_pressed

InputEventWithModifiers.set_alt_pressed

Attributes

Inherited from:
InputEventWithModifiers
final def setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

Inherited from:
Object
final def setButtonMask(button_mask: Long): Unit

InputEventMouse.set_button_mask

InputEventMouse.set_button_mask

Attributes

Inherited from:
InputEventMouse
final def setCommandOrControlAutoremap(enable: Boolean): Unit

InputEventWithModifiers.set_command_or_control_autoremap

InputEventWithModifiers.set_command_or_control_autoremap

Attributes

Inherited from:
InputEventWithModifiers
final def setCtrlPressed(pressed: Boolean): Unit

InputEventWithModifiers.set_ctrl_pressed

InputEventWithModifiers.set_ctrl_pressed

Attributes

Inherited from:
InputEventWithModifiers
final def setDevice(device: Long): Unit

InputEvent.set_device

InputEvent.set_device

Attributes

Inherited from:
InputEvent
final def setGlobalPosition(global_position: Vector2): Unit

InputEventMouse.set_global_position

InputEventMouse.set_global_position

Attributes

Inherited from:
InputEventMouse
final def setIdForPath(path: String, id: String): Unit

Resource.set_id_for_path

Resource.set_id_for_path

Attributes

Inherited from:
Resource
final def setLocalToScene(enable: Boolean): Unit

Resource.set_local_to_scene

Resource.set_local_to_scene

Attributes

Inherited from:
Resource
final def setMessageTranslation(enable: Boolean): Unit

Object.set_message_translation

Object.set_message_translation

Attributes

Inherited from:
Object
final def setMetaPressed(pressed: Boolean): Unit

InputEventWithModifiers.set_meta_pressed

InputEventWithModifiers.set_meta_pressed

Attributes

Inherited from:
InputEventWithModifiers
final def setName(name: String): Unit

Resource.set_name

Resource.set_name

Attributes

Inherited from:
Resource
final def setPath(path: String): Unit

Resource.set_path

Resource.set_path

Attributes

Inherited from:
Resource
final def setPathCache(path: String): Unit

Resource.set_path_cache

Resource.set_path_cache

Attributes

Inherited from:
Resource
final def setPosition(position: Vector2): Unit

InputEventMouse.set_position

InputEventMouse.set_position

Attributes

Inherited from:
InputEventMouse
final def setSceneUniqueId(id: String): Unit

Resource.set_scene_unique_id

Resource.set_scene_unique_id

Attributes

Inherited from:
Resource
final def setShiftPressed(pressed: Boolean): Unit

InputEventWithModifiers.set_shift_pressed

InputEventWithModifiers.set_shift_pressed

Attributes

Inherited from:
InputEventWithModifiers
final def setTranslationDomain(domain: StringName): Unit

Object.set_translation_domain

Object.set_translation_domain

Attributes

Inherited from:
Object
final def setWindowId(id: Long): Unit

InputEventFromWindow.set_window_id

InputEventFromWindow.set_window_id

Attributes

Inherited from:
InputEventFromWindow
final def setupLocalToScene(): Unit

Resource.setup_local_to_scene

Resource.setup_local_to_scene

Attributes

Inherited from:
Resource
final def takeOverPath(path: String): Unit

Resource.take_over_path

Resource.take_over_path

Attributes

Inherited from:
Resource
final def tr(message: StringName, context: StringName): String

Object.tr

Object.tr

Attributes

Inherited from:
Object
final def trN(message: StringName, plural_message: StringName, n: Long, context: StringName): String

Object.tr_n

Object.tr_n

Attributes

Inherited from:
Object
def unref(): Unit

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Attributes

Inherited from:
GodotScriptClass
final def unreference(): Boolean

RefCounted.unreference

RefCounted.unreference

Attributes

Inherited from:
RefCounted
final def withHost(o: GDExtensionObjectPtr): this.type

Set the handle and return this (fluent, for wrapping fetched objects).

Set the handle and return this (fluent, for wrapping fetched objects).

Attributes

Inherited from:
GodotScriptClass
final def xformedBy(xform: Transform2D, local_ofs: Vector2): InputEvent

InputEvent.xformed_by. Returns an owned reference: release it with unref() or inside Gd.scoped.

InputEvent.xformed_by. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

Inherited from:
InputEvent
Generated with