InputEventKey

Input event type for keyboard events.

Stores key presses on the keyboard. Supports key presses, key releases and echo events.

Members

Aliases

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

Functions

getScancode
long getScancode()
getScancodeWithModifiers
long getScancodeWithModifiers()

Returns the scancode combined with modifier keys such as Shift or Alt. See also InputEventWithModifiers.

getUnicode
long getUnicode()
opAssign
InputEventKey opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(InputEventKey other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setEcho
void setEcho(bool echo)
setPressed
void setPressed(bool pressed)
setScancode
void setScancode(long scancode)
setUnicode
void setUnicode(long unicode)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

echo
bool echo [@property setter]

If true the key was already pressed before this event. It means the user is holding the key down.

echo
bool echo [@property getter]

If true the key was already pressed before this event. It means the user is holding the key down.

pressed
bool pressed [@property getter]
bool pressed [@property setter]

If true the key's state is pressed. If false the key's state is released.

scancode
long scancode [@property getter]
long scancode [@property setter]

Key scancode, one of the KEY_* constants in @GlobalScope.

unicode
long unicode [@property getter]
long unicode [@property setter]

Key unicode identifier when relevant.

Static functions

_new
InputEventKey _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
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
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
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