Navigation
API > API/Plugins > API/Plugins/CommonUI > API/Plugins/CommonUI/UCommonGameViewportClient
- FViewportClient::InputAxis()
- UGameViewportClient::InputAxis()
- UCommonGameViewportClient::InputAxis()
References
| Module | CommonUI |
| Header | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonGameViewportClient.h |
| Include | #include "CommonGameViewportClient.h" |
| Source | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Private/CommonGameViewportClient.cpp |
virtual bool InputAxis
&40;
FViewport &42; Viewport,
FInputDeviceId InputDevice,
FKey Key,
float Delta,
float DeltaTime,
int32 NumSamples,
bool bGamepad
&41;
Remarks
Check an axis movement received by the viewport. If the viewport client uses the movement, it should return true to consume it. True to consume the axis movement, false to pass it on.
Parameters
| Name | Description |
|---|---|
| Viewport | The viewport which the axis movement is from. |
| InputDevice | The input device that triggered this axis movement |
| Key | The name of the axis which moved. |
| Delta | The axis movement delta. |
| DeltaTime | The time since the last axis update. |
| NumSamples | The number of device samples that contributed to this Delta, useful for things like smoothing |
| bGamepad | input came from gamepad (ie xbox controller) |