Class InputEvent

Namespace

Godot

Assembly

GodotSharp.dll

Abstract base class of all types of input events. See _Input(InputEvent).

public class InputEvent : Resource, IDisposable

Inheritance

object

GodotObject

RefCounted

Resource

InputEvent

Implements

IDisposable

Derived

InputEventAction

InputEventFromWindow

InputEventJoypadButton

InputEventJoypadMotion

InputEventMidi

InputEventShortcut

Inherited Members

Resource._GetRid()

Resource._SetupLocalToScene()

Resource.TakeOverPath(string)

Resource.GetRid()

Resource.GetLocalScene()

Resource.SetupLocalToScene()

Resource.EmitChanged()

Resource.Duplicate(bool)

Resource.ResourceLocalToScene

Resource.ResourcePath

Resource.ResourceName

Resource.Changed

Resource.SetupLocalToSceneRequested

RefCounted.InitRef()

RefCounted.Reference()

RefCounted.Unreference()

RefCounted.GetReferenceCount()

GodotObject.NotificationPostinitialize

GodotObject.NotificationPredelete

GodotObject.NotificationExtensionReloaded

GodotObject.InstanceFromId(ulong)

GodotObject.IsInstanceIdValid(ulong)

GodotObject.IsInstanceValid(GodotObject)

GodotObject.WeakRef(GodotObject)

GodotObject.Dispose()

GodotObject.Dispose(bool)

GodotObject.ToString()

GodotObject.ToSignal(GodotObject, StringName)

GodotObject._Get(StringName)

GodotObject._GetPropertyList()

GodotObject._Notification(int)

GodotObject._PropertyCanRevert(StringName)

GodotObject._PropertyGetRevert(StringName)

GodotObject._Set(StringName, Variant)

GodotObject._ValidateProperty(Dictionary)

GodotObject.Free()

GodotObject.GetClass()

GodotObject.IsClass(string)

GodotObject.Set(StringName, Variant)

GodotObject.Get(StringName)

GodotObject.SetIndexed(NodePath, Variant)

GodotObject.GetIndexed(NodePath)

GodotObject.GetPropertyList()

GodotObject.GetMethodList()

GodotObject.PropertyCanRevert(StringName)

GodotObject.PropertyGetRevert(StringName)

GodotObject.Notification(int, bool)

GodotObject.GetInstanceId()

GodotObject.SetScript(Variant)

GodotObject.GetScript()

GodotObject.SetMeta(StringName, Variant)

GodotObject.RemoveMeta(StringName)

GodotObject.GetMeta(StringName, Variant)

GodotObject.HasMeta(StringName)

GodotObject.GetMetaList()

GodotObject.AddUserSignal(string, Array)

GodotObject.HasUserSignal(StringName)

GodotObject.EmitSignal(StringName, params Variant[])

GodotObject.Call(StringName, params Variant[])

GodotObject.CallDeferred(StringName, params Variant[])

GodotObject.SetDeferred(StringName, Variant)

GodotObject.Callv(StringName, Array)

GodotObject.HasMethod(StringName)

GodotObject.HasSignal(StringName)

GodotObject.GetSignalList()

GodotObject.GetSignalConnectionList(StringName)

GodotObject.GetIncomingConnections()

GodotObject.Connect(StringName, Callable, uint)

GodotObject.Disconnect(StringName, Callable)

GodotObject.IsConnected(StringName, Callable)

GodotObject.SetBlockSignals(bool)

GodotObject.IsBlockingSignals()

GodotObject.NotifyPropertyListChanged()

GodotObject.SetMessageTranslation(bool)

GodotObject.CanTranslateMessages()

GodotObject.Tr(StringName, StringName)

GodotObject.TrN(StringName, StringName, int, StringName)

GodotObject.IsQueuedForDeletion()

GodotObject.CancelFree()

GodotObject.NativeInstance

GodotObject.ScriptChanged

GodotObject.PropertyListChanged

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Device

The event's device ID.

Note: This device ID will always be -1 for emulated mouse input from a touchscreen. This can be used to distinguish emulated mouse input from physical mouse input.

public int Device { get; set; }

Property Value

int

Methods

Accumulate(InputEvent)

Returns true if the given input event and this input event can be added together (only for events of type InputEventMouseMotion).

The given input event's position, global position and speed will be copied. The resulting relative is a sum of both events. Both events' modifiers have to be identical.

public bool Accumulate(InputEvent withEvent)

Parameters

withEvent InputEvent

Returns

bool

AsText()

Returns a string representation of the event.

public string AsText()

Returns

string

GetActionStrength(StringName, bool)

Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type InputEventJoypadMotion.

If exactMatch is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.

public float GetActionStrength(StringName action, bool exactMatch = false)

Parameters

action StringName

exactMatch bool

Returns

float

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

IsAction(StringName, bool)

Returns true if this input event matches a pre-defined action of any type.

If exactMatch is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.

public bool IsAction(StringName action, bool exactMatch = false)

Parameters

action StringName

exactMatch bool

Returns

bool

IsActionPressed(StringName, bool, bool)

Returns true if the given action is being pressed (and is not an echo event for InputEventKey events, unless allowEcho is true). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.

If exactMatch is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.

Note: Due to keyboard ghosting, IsActionPressed(StringName, bool, bool) may return false even if one of the action's keys is pressed. See Input examples in the documentation for more information.

public bool IsActionPressed(StringName action, bool allowEcho = false, bool exactMatch = false)

Parameters

action StringName

allowEcho bool

exactMatch bool

Returns

bool

IsActionReleased(StringName, bool)

Returns true if the given action is released (i.e. not pressed). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.

If exactMatch is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.

public bool IsActionReleased(StringName action, bool exactMatch = false)

Parameters

action StringName

exactMatch bool

Returns

bool

IsActionType()

Returns true if this input event's type is one that can be assigned to an input action.

public bool IsActionType()

Returns

bool

IsCanceled()

Returns true if this input event has been canceled.

public bool IsCanceled()

Returns

bool

IsEcho()

Returns true if this input event is an echo event (only for events of type InputEventKey). Any other event type returns false.

public bool IsEcho()

Returns

bool

IsMatch(InputEvent, bool)

Returns true if the specified event matches this event. Only valid for action events i.e key (InputEventKey), button (InputEventMouseButton or InputEventJoypadButton), axis InputEventJoypadMotion or action (InputEventAction) events.

If exactMatch is false, it ignores additional input modifiers for InputEventKey and InputEventMouseButton events, and the direction for InputEventJoypadMotion events.

public bool IsMatch(InputEvent @event, bool exactMatch = true)

Parameters

event InputEvent

exactMatch bool

Returns

bool

IsPressed()

Returns true if this input event is pressed. Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.

Note: Due to keyboard ghosting, IsPressed() may return false even if one of the action's keys is pressed. See Input examples in the documentation for more information.

public bool IsPressed()

Returns

bool

IsReleased()

Returns true if this input event is released. Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.

public bool IsReleased()

Returns

bool

XformedBy(Transform2D, Vector2?)

Returns a copy of the given input event which has been offset by localOfs and transformed by xform. Relevant for events of type InputEventMouseButton, InputEventMouseMotion, InputEventScreenTouch, InputEventScreenDrag, InputEventMagnifyGesture and InputEventPanGesture.

public InputEvent XformedBy(Transform2D xform, Vector2? localOfs = null)

Parameters

xform Transform2D

localOfs Vector2?

If the parameter is null, then the default value is new Vector2(0, 0).

Returns

InputEvent