Input

gdext.classes.Input
See theInput companion object
abstract class Input extends Object

Generated wrapper for Godot's Input, extends Object.

Attributes

Companion
object
Graph
Supertypes
class Object
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

final def actionPress(action: StringName, strength: Double): Unit

Input.action_press

Input.action_press

Attributes

final def actionRelease(action: StringName): Unit

Input.action_release

Input.action_release

Attributes

final def addJoyMapping(mapping: String, update_existing: Boolean): Unit

Input.add_joy_mapping

Input.add_joy_mapping

Attributes

final def flushBufferedEvents(): Unit

Input.flush_buffered_events

Input.flush_buffered_events

Attributes

final def getAccelerometer(): Vector3

Input.get_accelerometer

Input.get_accelerometer

Attributes

final def getActionRawStrength(action: StringName, exact_match: Boolean): Double

Input.get_action_raw_strength

Input.get_action_raw_strength

Attributes

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

Input.get_action_strength

Input.get_action_strength

Attributes

final def getAxis(negative_action: StringName, positive_action: StringName): Double

Input.get_axis

Input.get_axis

Attributes

final def getCurrentCursorShape(): Long

Input.get_current_cursor_shape

Input.get_current_cursor_shape

Attributes

final def getGravity(): Vector3

Input.get_gravity

Input.get_gravity

Attributes

final def getGyroscope(): Vector3

Input.get_gyroscope

Input.get_gyroscope

Attributes

final def getJoyAxis(device: Long, axis: Long): Double

Input.get_joy_axis

Input.get_joy_axis

Attributes

final def getJoyGuid(device: Long): String

Input.get_joy_guid

Input.get_joy_guid

Attributes

final def getJoyName(device: Long): String

Input.get_joy_name

Input.get_joy_name

Attributes

final def getJoyVibrationDuration(device: Long): Double

Input.get_joy_vibration_duration

Input.get_joy_vibration_duration

Attributes

final def getJoyVibrationStrength(device: Long): Vector2

Input.get_joy_vibration_strength

Input.get_joy_vibration_strength

Attributes

Input.get_last_mouse_screen_velocity

Input.get_last_mouse_screen_velocity

Attributes

Input.get_last_mouse_velocity

Input.get_last_mouse_velocity

Attributes

final def getMagnetometer(): Vector3

Input.get_magnetometer

Input.get_magnetometer

Attributes

final def getMouseButtonMask(): Long

Input.get_mouse_button_mask

Input.get_mouse_button_mask

Attributes

final def getMouseMode(): Long

Input.get_mouse_mode

Input.get_mouse_mode

Attributes

final def getVector(negative_x: StringName, positive_x: StringName, negative_y: StringName, positive_y: StringName, deadzone: Double): Vector2

Input.get_vector

Input.get_vector

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 hasJoyLight(device: Long): Boolean

Input.has_joy_light

Input.has_joy_light

Attributes

final def isActionJustPressed(action: StringName, exact_match: Boolean): Boolean

Input.is_action_just_pressed

Input.is_action_just_pressed

Attributes

final def isActionJustPressedByEvent(action: StringName, event: InputEvent, exact_match: Boolean): Boolean

Input.is_action_just_pressed_by_event

Input.is_action_just_pressed_by_event

Attributes

final def isActionJustReleased(action: StringName, exact_match: Boolean): Boolean

Input.is_action_just_released

Input.is_action_just_released

Attributes

final def isActionJustReleasedByEvent(action: StringName, event: InputEvent, exact_match: Boolean): Boolean

Input.is_action_just_released_by_event

Input.is_action_just_released_by_event

Attributes

final def isActionPressed(action: StringName, exact_match: Boolean): Boolean

Input.is_action_pressed

Input.is_action_pressed

Attributes

final def isAnythingPressed(): Boolean

Input.is_anything_pressed

Input.is_anything_pressed

Attributes

final def isEmulatingMouseFromTouch(): Boolean

Input.is_emulating_mouse_from_touch

Input.is_emulating_mouse_from_touch

Attributes

final def isEmulatingTouchFromMouse(): Boolean

Input.is_emulating_touch_from_mouse

Input.is_emulating_touch_from_mouse

Attributes

final def isJoyButtonPressed(device: Long, button: Long): Boolean

Input.is_joy_button_pressed

Input.is_joy_button_pressed

Attributes

final def isJoyKnown(device: Long): Boolean

Input.is_joy_known

Input.is_joy_known

Attributes

final def isKeyLabelPressed(keycode: Long): Boolean

Input.is_key_label_pressed

Input.is_key_label_pressed

Attributes

final def isKeyPressed(keycode: Long): Boolean

Input.is_key_pressed

Input.is_key_pressed

Attributes

final def isMouseButtonPressed(button: Long): Boolean

Input.is_mouse_button_pressed

Input.is_mouse_button_pressed

Attributes

final def isPhysicalKeyPressed(keycode: Long): Boolean

Input.is_physical_key_pressed

Input.is_physical_key_pressed

Attributes

final def isUsingAccumulatedInput(): Boolean

Input.is_using_accumulated_input

Input.is_using_accumulated_input

Attributes

final def parseInputEvent(event: InputEvent): Unit

Input.parse_input_event

Input.parse_input_event

Attributes

final def removeJoyMapping(guid: String): Unit

Input.remove_joy_mapping

Input.remove_joy_mapping

Attributes

final def setAccelerometer(value: Vector3): Unit

Input.set_accelerometer

Input.set_accelerometer

Attributes

final def setCustomMouseCursor(image: Resource, shape: Long, hotspot: Vector2): Unit

Input.set_custom_mouse_cursor

Input.set_custom_mouse_cursor

Attributes

final def setDefaultCursorShape(shape: Long): Unit

Input.set_default_cursor_shape

Input.set_default_cursor_shape

Attributes

final def setEmulateMouseFromTouch(enable: Boolean): Unit

Input.set_emulate_mouse_from_touch

Input.set_emulate_mouse_from_touch

Attributes

final def setEmulateTouchFromMouse(enable: Boolean): Unit

Input.set_emulate_touch_from_mouse

Input.set_emulate_touch_from_mouse

Attributes

final def setGravity(value: Vector3): Unit

Input.set_gravity

Input.set_gravity

Attributes

final def setGyroscope(value: Vector3): Unit

Input.set_gyroscope

Input.set_gyroscope

Attributes

final def setJoyLight(device: Long, color: Color): Unit

Input.set_joy_light

Input.set_joy_light

Attributes

final def setMagnetometer(value: Vector3): Unit

Input.set_magnetometer

Input.set_magnetometer

Attributes

final def setMouseMode(mode: Long): Unit

Input.set_mouse_mode

Input.set_mouse_mode

Attributes

final def setUseAccumulatedInput(enable: Boolean): Unit

Input.set_use_accumulated_input

Input.set_use_accumulated_input

Attributes

final def shouldIgnoreDevice(vendor_id: Long, product_id: Long): Boolean

Input.should_ignore_device

Input.should_ignore_device

Attributes

final def startJoyVibration(device: Long, weak_magnitude: Double, strong_magnitude: Double, duration: Double): Unit

Input.start_joy_vibration

Input.start_joy_vibration

Attributes

final def stopJoyVibration(device: Long): Unit

Input.stop_joy_vibration

Input.stop_joy_vibration

Attributes

final def vibrateHandheld(duration_ms: Long, amplitude: Double): Unit

Input.vibrate_handheld

Input.vibrate_handheld

Attributes

final def warpMouse(position: Vector2): Unit

Input.warp_mouse

Input.warp_mouse

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 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
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 getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

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

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

Inherited from:
Object

Object.get_translation_domain

Object.get_translation_domain

Attributes

Inherited from:
Object
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 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 isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

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

Object.is_class

Object.is_class

Attributes

Inherited from:
Object
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
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 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 setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

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

Object.set_message_translation

Object.set_message_translation

Attributes

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

Object.set_translation_domain

Object.set_translation_domain

Attributes

Inherited from:
Object
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 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