Limen Framework 0.1 Help

ULimenMouseSensitivityComponent

Overview

ULimenMouseSensitivityComponent is an actor component that allows for setting and getting mouse sensitivity parameters. It provides functionality to invert axes and broadcast updates through a delegate.

Properties

Type

Name

Access

Description

FMouseParameters

MouseParameters

Protected

Stores the current mouse sensitivity parameters.

Functions

Return Type

Signature

Description

void

SetMouseParameters(const FMouseParameters& InNewParams)

Sets new mouse parameters and broadcasts an update.

void

SetSensitivity(const float Sensitivity)

Sets the sensitivity for both axes and broadcasts an update.

void

SetInvertAxis(const bool bInvertX, const bool bInvertY)

Inverts the specified axes and broadcasts an update.

float

GetMouseX() const

Returns the current mouse sensitivity on the X-axis.

bool

GetInvertMouseX() const

Returns whether the X-axis is inverted.

float

GetMouseY() const

Returns the current mouse sensitivity on the Y-axis.

bool

GetInvertMouseY() const

Returns whether the Y-axis is inverted.

float

GetMouseXY() const

Returns the average mouse sensitivity if both axes are equal, otherwise returns NaN.

const FMouseParameters&

GetMouseParameters() const

Returns a reference to the current mouse parameters.

Usage & Implementation Notes

  • The component uses a delegate (FMouseSensitivityUpdate) to notify when the sensitivity is updated.

  • The SetMouseParameters, SetSensitivity, and SetInvertAxis functions update the internal state and broadcast an event.

  • The GetMouseXY function ensures that both axes have the same sensitivity before returning it; otherwise, it returns NaN.

22 May 2026