Class InputEventWithModifiers
- Namespace
- Godot
- Assembly
- GodotSharp.dll
Stores information about mouse, keyboard, and touch gesture input events. This includes information about which modifier keys are pressed, such as Shift or Alt. See _Input(InputEvent).
public class InputEventWithModifiers : InputEventFromWindow, IDisposable
- Inheritance
-
InputEventWithModifiers
- Implements
- Derived
- Inherited Members
Properties
AltPressed
State of the Alt modifier.
public bool AltPressed { get; set; }
Property Value
CommandOrControlAutoremap
Automatically use Meta (Cmd) on macOS and Ctrl on other platforms. If true
, CtrlPressed and MetaPressed cannot be set.
public bool CommandOrControlAutoremap { get; set; }
Property Value
CtrlPressed
State of the Ctrl modifier.
public bool CtrlPressed { get; set; }
Property Value
MetaPressed
State of the Meta modifier. On Windows and Linux, this represents the Windows key (sometimes called "meta" or "super" on Linux). On macOS, this represents the Command key.
public bool MetaPressed { get; set; }
Property Value
ShiftPressed
State of the Shift modifier.
public bool ShiftPressed { get; set; }
Property Value
Methods
GetModifiersMask()
Returns the keycode combination of modifier keys.
public KeyModifierMask GetModifiersMask()
Returns
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_nameName of the method to check for.
Returns
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_nameName of the signal to check for.
Returns
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_nameName of the method to invoke.
args
NativeVariantPtrArgsArguments to use with the invoked method.
ret
godot_variantValue returned by the invoked method.
Returns
IsCommandOrControlPressed()
On macOS, returns true
if Meta (Cmd) is pressed.
On other platforms, returns true
if Ctrl is pressed.
public bool IsCommandOrControlPressed()