FInputCaptureUpdate

IInputBehavior returns an [FInputCaptureUpdate](API\Runtime\InteractiveToolsFramework\FInputCaptureUpdate) from BeginCapture() and UpdateCapture(), which indicates to the InputRouter what the Behavior would like to have happen.

Windows
MacOS
Linux

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/InputBehavior.h

Include

#include "InputBehavior.h"

Syntax

struct FInputCaptureUpdate

Remarks

IInputBehavior returns an FInputCaptureUpdate from BeginCapture() and UpdateCapture(), which indicates to the InputRouter what the Behavior would like to have happen.

Variables

Name Description

Public variable

FInputCaptureDa...

 

Data

Custom data for the active capture that should be propagated to next UpdateCapture() call

Public variable

UInputBehavior ...

 

Source

Which Behavior did this update come from

Public variable

EInputCaptureSt...

 

State

Indicates what capture state the Behavior wants to transition to

Constructors

Name Description

Public function

FInputCaptureUpdate

(
    EInputCaptureState StateIn,
    UInputBehavior* SourceBehavior...,
    EInputCaptureSide WhichSideIn,
    void* CustomData
)

Functions

Name Description

Public function Static

FInputCaptur...

 

Begin

(
    UInputBehavior* SourceBehavior,
    EInputCaptureSide WhichSide,
    void* CustomData
)

Create a begin-capturing instance of FInputCaptureUpdate

Public function Static

FInputCaptur...

 

Continue()

Create a default continue-capturing instance of FInputCaptureUpdate

Public function Static

FInputCaptur...

 

End()

Create a default end-capturing instance of FInputCaptureUpdate

Public function Static

FInputCaptur...

 

Ignore()

Create a default ignore-capturing instance of FInputCaptureUpdate
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss