InputEventWithModifiers

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.InputEventWithModifiers
Namespace	Electron2D
Kind	class
Category	Input

Overview

Base class for input events that carry keyboard modifier state.

Syntax

public class Electron2D.InputEventWithModifiers : Electron2D.InputEventFromWindow

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: InputEventWithModifiers

Modifier state layer for keyboard and future mouse input events.

Remarks

The internal platform mapper fills these booleans from the platform key modifier mask for keyboard events. Mouse events currently keep the default values until modifier state is plumbed through the event pump.

Instances are mutable and are not synchronized; use them from the input dispatch thread that owns the event.

Thread Safety

Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.

Since

This class is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
AltPressed	Property	Gets or sets whether Alt or Option was pressed when the event was generated.
CtrlPressed	Property	Gets or sets whether Control was pressed when the event was generated.
MetaPressed	Property	Gets or sets whether Meta, Command, or Windows was pressed when the event was generated.
ShiftPressed	Property	Gets or sets whether Shift was pressed when the event was generated.
Electron2D.InputEventWithModifiers()	Constructor	Initializes a new instance of the InputEventWithModifiers type.

Member Details

AltPressed

Kind: Property

public System.Boolean AltPressed { get; set; }

Summary

Gets or sets whether Alt or Option was pressed when the event was generated.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current alt pressed value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventWithModifiers

CtrlPressed

Kind: Property

public System.Boolean CtrlPressed { get; set; }

Summary

Gets or sets whether Control was pressed when the event was generated.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current ctrl pressed value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventWithModifiers

MetaPressed

Kind: Property

public System.Boolean MetaPressed { get; set; }

Summary

Gets or sets whether Meta, Command, or Windows was pressed when the event was generated.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current meta pressed value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventWithModifiers

ShiftPressed

Kind: Property

public System.Boolean ShiftPressed { get; set; }

Summary

Gets or sets whether Shift was pressed when the event was generated.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current shift pressed value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventWithModifiers

Electron2D.InputEventWithModifiers()

Kind: Constructor

public Electron2D.InputEventWithModifiers()

Summary

Initializes a new instance of the InputEventWithModifiers type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventWithModifiers