FInputCaptureRequest

[UInputBehavior](API\Runtime\InteractiveToolsFramework\UInputBehavior) returns an [FInputCaptureRequest](API\Runtime\InteractiveToolsFramework\FInputCaptureRequest) from WantsCapture() to indicate whether it wants to capture or ignore an input event

Windows
MacOS
Linux

References

Module

InteractiveToolsFramework

Header

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

Include

#include "InputBehavior.h"

Syntax

struct FInputCaptureRequest

Remarks

UInputBehavior returns an FInputCaptureRequest from WantsCapture() to indicate whether it wants to capture or ignore an input event

Variables

Name Description

Public variable

float

 

HitDepth

Depth along hit-test ray

Public variable

void *

 

Owner

Owner of the requesting behavior. Behavior doesn't know this, so this is initialized to null

Public variable

EInputCaptureSi...

 

Side

Which side does request want to capture on

Public variable

UInputBehavior ...

 

Source

Which input behavior generated this request

Public variable

EInputCaptureRe...

 

Type

What type of capture request is this (Begin or Ignore)

Constructors

Name Description

Public function

FInputCaptureRequest

(
    EInputCaptureRequestType type,
    UInputBehavior* behavior,
    EInputCaptureSide whichSide,
    float hitDepth
)

Functions

Name Description

Public function Static

FInputCaptur...

 

Begin

(
    UInputBehavior* behavior,
    EInputCaptureSide whichSide,
    float hitDepth
)

Create a Begin-capture request

Public function Static

FInputCaptur...

 

Ignore()

Create an ignore-capture request

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss