Represents the configuration for mouse event monitoring, including movement tracking settings and timing controls for event throttling. This configuration is used to control how frequently mouse events are raised, whether mouse movement should be tracked, and whether event processing is currently paused.
More...
|
| bool | TrackMouseMovement [get, set] |
| | Gets or sets a value indicating whether mouse cursor movement should be tracked and reported in mouse events. When enabled, mouse events will include position updates even when no buttons are pressed, allowing detection of mouse hover, cursor tracking, and movement-based interactions. When disabled, events may only be raised for button presses, releases, or other explicit actions, potentially reducing event frequency and processing overhead.
|
| double | TimeBetweenEvents [get, set] |
| | Gets or sets the minimum time interval in seconds that must elapse between consecutive events. This property controls the throttling rate for input events, preventing excessive event generation from high-frequency input sources. The value is stored internally as high-resolution ticks for precise timing calculations.
|
| bool | IsPaused = false [get, set] |
| | Gets or sets a value indicating whether event processing is currently paused. When set to true, events will not be raised even if input occurs and timing conditions are met. This property provides a convenient way to temporarily disable input event generation without removing or reconfiguring the event monitoring setup, useful for modal dialogs, cutscenes, or transitioning between game states.
|
Represents the configuration for mouse event monitoring, including movement tracking settings and timing controls for event throttling. This configuration is used to control how frequently mouse events are raised, whether mouse movement should be tracked, and whether event processing is currently paused.
◆ MouseEventConfiguration()
| Gondwana.Input.Mouse.MouseEventConfiguration.MouseEventConfiguration |
( |
bool | trackMouseMovement, |
|
|
double | secondsBetweenEvents = 0, |
|
|
bool | isPaused = false ) |
Initializes a new instance of the MouseEventConfiguration class with the specified movement tracking and event timing settings.
- Parameters
-
| trackMouseMovement | A value indicating whether mouse cursor movement should be tracked and reported in events. Set to true to track all mouse movements including hover, or false to only track explicit actions like button presses and scrolling. |
| secondsBetweenEvents | The minimum time interval in seconds that must elapse between consecutive mouse events. Use this to throttle high-frequency mouse input. A value of 0 means no throttling is applied, and events will be generated as frequently as the mouse state changes. Default is 0. |
| isPaused | A value indicating whether event processing for the mouse is initially paused. When paused, the mouse will not generate events even if moved, clicked, or scrolled. This is useful for temporarily disabling mouse input, such as when a modal dialog is displayed or during cutscenes. Default is false. |
◆ TrackMouseMovement
| bool Gondwana.Input.Mouse.MouseEventConfiguration.TrackMouseMovement |
|
getset |
Gets or sets a value indicating whether mouse cursor movement should be tracked and reported in mouse events. When enabled, mouse events will include position updates even when no buttons are pressed, allowing detection of mouse hover, cursor tracking, and movement-based interactions. When disabled, events may only be raised for button presses, releases, or other explicit actions, potentially reducing event frequency and processing overhead.
1.14.0