InputEvent

Generic input event.

Base class of all sort of input event. See Node._input.

@GodotBaseClass

struct InputEvent {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(InputEvent other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static InputEvent _new();

bool accumulate(InputEvent with_event);

String asText();

double getActionStrength(String action);

long getDevice();

bool isAction(String action);

bool isActionPressed(String action, bool allow_echo);

bool isActionReleased(String action);

bool isActionType();

bool isEcho();

bool isPressed();

void setDevice(long device);

bool shortcutMatch(InputEvent event);

Ref!InputEvent xformedBy(Transform2D xform, Vector2 local_ofs);

long device [@property getter];

long device [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

accumulate bool accumulate(InputEvent with_event): 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.
asText String asText(): Returns a String representation of the event.
getActionStrength double getActionStrength(String action): 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.
getDevice long getDevice()
isAction bool isAction(String action): Returns true if this input event matches a pre-defined action of any type.
isActionPressed bool isActionPressed(String action, bool allow_echo): Returns true if the given action is being pressed (and is not an echo event for InputEventKey events, unless allow_echo is true). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.
isActionReleased bool isActionReleased(String action): Returns true if the given action is released (i.e. not pressed). Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.
isActionType bool isActionType(): Returns true if this input event's type is one that can be assigned to an input action.
isEcho bool isEcho(): Returns true if this input event is an echo event (only for events of type InputEventKey).
isPressed bool isPressed(): Returns true if this input event is pressed. Not relevant for events of type InputEventMouseMotion or InputEventScreenDrag.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(InputEvent other)
opEquals bool opEquals(typeof(null) n)
setDevice void setDevice(long device)
shortcutMatch bool shortcutMatch(InputEvent event): Returns true if the given input event is checking for the same key (InputEventKey), button (InputEventJoypadButton) or action (InputEventAction).
toHash size_t toHash()
xformedBy Ref!InputEvent xformedBy(Transform2D xform, Vector2 local_ofs): Returns a copy of the given input event which has been offset by local_ofs and transformed by xform. Relevant for events of type InputEventMouseButton, InputEventMouseMotion, InputEventScreenTouch, InputEventScreenDrag, InputEventMagnifyGesture and InputEventPanGesture.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

device long device [@property getter]
long device [@property setter]: 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.

Static functions

_new InputEvent _new(): Construct a new instance of InputEvent. Note: use memnew!InputEvent instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot inputevent modules

all

structs

InputEvent