FInputCaptureUpdate Struct Reference

#include <InputBehavior.h>

Public Member Functions
	FInputCaptureUpdate (EInputCaptureState StateIn, UInputBehavior *SourceBehaviorIn, EInputCaptureSide WhichSideIn, void *CustomData=nullptr)

Static Public Member Functions
static FInputCaptureUpdate	Begin (UInputBehavior *SourceBehavior, EInputCaptureSide WhichSide, void *CustomData=nullptr)
static FInputCaptureUpdate	Continue ()
static FInputCaptureUpdate	End ()
static FInputCaptureUpdate	Ignore ()

Public Attributes
EInputCaptureState	State
UInputBehavior *	Source
FInputCaptureData	Data

Detailed Description

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

Constructor & Destructor Documentation

FInputCaptureUpdate()

FInputCaptureUpdate::FInputCaptureUpdate ( EInputCaptureState  StateIn, UInputBehavior *  SourceBehaviorIn, EInputCaptureSide  WhichSideIn, void *  CustomData = nullptr  )

inline

Parameters

StateIn	desired capture state
Source	UInputBehavior that is returning this update
Which	Which side we are capturing on
CustomData	client-provided data that will be passed to UInputBehavior::UpdateCapture() calls. Client owns this memory!

Member Function Documentation

Begin()

static FInputCaptureUpdate FInputCaptureUpdate::Begin ( UInputBehavior *  SourceBehavior, EInputCaptureSide  WhichSide, void *  CustomData = nullptr  )

inlinestatic

Create a begin-capturing instance of FInputCaptureUpdate

Parameters

Source	UInputBehavior that is returning this update
Which	Which side we are capturing on
CustomData	client-provided data that will be passed to UInputBehavior::UpdateCapture() calls. Client owns this memory!

Continue()

static FInputCaptureUpdate FInputCaptureUpdate::Continue ( )

inlinestatic

Create a default continue-capturing instance of FInputCaptureUpdate

End()

static FInputCaptureUpdate FInputCaptureUpdate::End ( )

inlinestatic

Create a default end-capturing instance of FInputCaptureUpdate

Ignore()

static FInputCaptureUpdate FInputCaptureUpdate::Ignore ( )

inlinestatic

Create a default ignore-capturing instance of FInputCaptureUpdate

Member Data Documentation

Data

FInputCaptureData FInputCaptureUpdate::Data

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

Source

UInputBehavior* FInputCaptureUpdate::Source

Which Behavior did this update come from

State

EInputCaptureState FInputCaptureUpdate::State

Indicates what capture state the Behavior wants to transition to

---

The documentation for this struct was generated from the following file:

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