UInputBehaviorSet | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/InteractiveToolsFramework

UInputBehaviorSet manages a set of UInputBehaviors, and provides various functions to query and forward events to the set. Tools and Widgets provide instances of this via IInputBehaviorSource, and UInputRouter collects and manages them (see comments there)

Behaviors in the set each have a source pointer and group tag, which allows sets of behaviors to be managed together. For example one UInputBehaviorSet can be merged into another and removed later.


Name	UInputBehaviorSet
Type	class
Header File	/Engine/Source/Runtime/InteractiveToolsFramework/Public/InputBehaviorSet.h
Include Path	#include "InputBehaviorSet.h"

Syntax

UCLASS (Transient, MinimalAPI)  
class UInputBehaviorSet : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UInputBehaviorSet

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UInputBehaviorSet()		InputBehaviorSet.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~UInputBehaviorSet()		InputBehaviorSet.h

Functions

Public

Name	Remarks	Include Path
virtual void Add ( UInputBehavior* Behavior, void* Source, const FString& GroupName )	Add a Behavior to the set	InputBehaviorSet.h
virtual void Add ( const UInputBehaviorSet* OtherSet, void* NewSource, const FString& NewGroupName )	Merge another BehaviorSet into this Set	InputBehaviorSet.h
virtual void CollectWantsCapture ( const FInputDeviceState& InputState, TArray< FInputCaptureRequest >& ResultOut )	Queries and Event Forwarding Call UInputBehavior::WantsCapture() on each valid Behavior and collect up the requests that indicated a Capture was desired.	InputBehaviorSet.h
virtual void CollectWantsForceEndCapture ( TArray< UInputBehavior* >& ResultOut )	Call UInputBehavior::WantsForceEndCapture on each valid Behavior and collect up the requests that indicated that a ForceEndCapture was desired.	InputBehaviorSet.h
virtual void CollectWantsHoverCapture ( const FInputDeviceState& InputState, TArray< FInputCaptureRequest >& ResultOut )	Call UInputBehavior::WantsCapture() on each valid Behavior and collect up the requests that indicated a Capture was desired.	InputBehaviorSet.h
virtual bool IsEmpty()	Set Management	InputBehaviorSet.h
virtual bool Remove ( UInputBehavior* Behavior )	Remove a Behavior from the Set	InputBehaviorSet.h
virtual void RemoveAll()	Remove all Behaviors from the set	InputBehaviorSet.h
virtual bool RemoveByGroup ( const FString& GroupName )	Remove a group of Behaviors from the Set	InputBehaviorSet.h
virtual bool RemoveBySource ( void* Source )	Remove a group of Behaviors from the Set	InputBehaviorSet.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
virtual void BehaviorsModified()	Called internally when Behaviors list is updated, to re-sort by Priority, etc (	InputBehaviorSet.h
bool SupportsInputType ( UInputBehavior* Behavior, const FInputDeviceState& InputState )		InputBehaviorSet.h

Navigation