UGameViewportClient::InputAxis

Check an axis movement received by the viewport.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/GameViewportClient.h

Include

#include "Engine/GameViewportClient.h"

Source

/Engine/Source/Runtime/Engine/Private/GameViewportClient.cpp

Syntax

virtual bool InputAxis
(
    FViewport * Viewport,
    int32 ControllerId,
    FKey Key,
    float Delta,
    float DeltaTime,
    int32 NumSamples,
    bool bGamepad
)

Remarks

Check an axis movement received by the viewport. If the viewport client uses the movement, it should return true to consume it.

Returns

True to consume the axis movement, false to pass it on.

Parameters

Parameter

Description

Viewport

The viewport which the axis movement is from.

ControllerId

The controller which the axis movement is from.

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)