UKismetInputLibrary::Key_IsAxis2D
#include "Kismet/KismetInputLibrary.h"
Access: public
Specifiers: staticBlueprintPure
Description
Returns true if the key is a 2D (vector) axis, such as mouse movement or a touchpad's XY position.
Caveats & Gotchas
- • This is a distinct, smaller set of FKey values (e.g. Mouse2D) from the 1D axes returned by Key_IsAxis1D — gamepad thumbsticks are represented as separate 1D X/Y axes, not a single 2D key.
- • Mouse2D is rarely bound directly in practice, since most input setups consume mouse X and Y as separate 1D axes instead — this function exists mainly for completeness with the FKey axis classification.
Signature
static bool Key_IsAxis2D(const FKey& Key);Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| Key | const FKey& | The key to test. | — |
Return Type
bool Example
Detect a 2D pointer-style axis binding C++
if (UKismetInputLibrary::Key_IsAxis2D(BoundKey))
{
BindVectorAxisMapping("Look", BoundKey);
}Tags
Version History
Introduced in: unknown
| Version | Status | Notes |
|---|---|---|
| 5.6 | stable | — |
Feedback
Was this helpful?