UGameplayStatics::GetViewportMouseCaptureMode
#include "Kismet/GameplayStatics.h"
Access: public
Specifiers: staticUFUNCTIONBlueprintPure
Description
Returns the current mouse capture mode of the game viewport, indicating how the cursor is constrained during gameplay.
Caveats & Gotchas
- • The capture mode is set at the viewport level and overrides any per-player-controller InputMode settings when they conflict.
- • On platforms without a mouse (mobile, console) this will always return NoCapture; do not use it as a platform detection mechanism.
Signature
static ENGINE_API EMouseCaptureMode GetViewportMouseCaptureMode(const UObject* WorldContextObject);Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| WorldContextObject | const UObject* | Object used to retrieve the world context. | — |
Return Type
EMouseCaptureMode Example
Log current mouse capture mode C++
EMouseCaptureMode Mode = UGameplayStatics::GetViewportMouseCaptureMode(this);
UE_LOG(LogTemp, Log, TEXT("Mouse capture mode: %d"), (int32)Mode);Version History
Introduced in: 4.0
| Version | Status | Notes |
|---|---|---|
| 5.6 | stable | — |
Feedback
Was this helpful?