UInputBehaviorSet | Unreal Engine 5.5 Documentation

API > API/Runtime > API/Runtime/InteractiveToolsFramework

Inheritance Hierarchy

UObject
UInputBehaviorSet

References


Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/InteractiveToolsFramework/Public/InputBehaviorSet.h
Include	#include "InputBehaviorSet.h"

Syntax

UCLASS (Transient, MinimalAPI)  
class UInputBehaviorSet : public UObject

Remarks

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.

Variables

	Type	Name	Description
	TArray< FBehaviorInfo >	Behaviors	Current set of known Behaviors

Constructors

	Type	Name	Description
		UInputBehaviorSet ()

Destructors

	Type	Name	Description
		~UInputBehaviorSet ()

Functions

Type	Name	Description
void	Add ( UInputBehavior* Behavior, void* Source, const FString& GroupName )	Add a Behavior to the set
void	Add ( const UInputBehaviorSet* OtherSet, void* NewSource, const FString& NewGroupName )	Merge another BehaviorSet into this Set
void	BehaviorsModified ()	Called internally when Behaviors list is updated, to re-sort by Priority, etc (
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.
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.
bool	IsEmpty ()	Set Management
bool	Remove ( UInputBehavior* Behavior )	Remove a Behavior from the Set
void	RemoveAll ()	Remove all Behaviors from the set
bool	RemoveByGroup ( const FString& GroupName )	Remove a group of Behaviors from the Set
bool	RemoveBySource ( void* Source )	Remove a group of Behaviors from the Set
bool	SupportsInputType ( UInputBehavior* Behavior, const FInputDeviceState& InputState )

Navigation