UKeyAsModifierInputBehavior | Unreal Engine 5.2 Documentation

API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseBehaviors

Inheritance Hierarchy

UObjectBase
UObjectBaseUtility
UObject
UInputBehavior
UKeyAsModifierInputBehavior

References


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

Syntax

class UKeyAsModifierInputBehavior : public UInputBehavior

Remarks

UKeyAsModifierInputBehavior converts a specific key press/release into a "Modifier" toggle via the IModifierToggleBehaviorTarget interface. It does not capture the key press; rather, it updates the modifier its WantsCapture call. This means that the modifier won't be updated if another behavior captures the keyboard.

Variables

	Type	Name	Description
	FInputBehaviorModifierStates	Modifiers	Modifier set for this behavior, internally initialized with check on ModifierKey
	IModifierToggleBehaviorTarget *	Target	Modifier Target object

Constructors

	Type	Name	Description
		UKeyAsModifierInputBehavior ()

Functions

	Type	Name	Description
	void	Initialize ( IModifierToggleBehaviorTarget* Target, int ModifierID, const FKey& ModifierKey )	Initialize this behavior with the given Target
	void	Initialize ( IModifierToggleBehaviorTarget* TargetIn, int ModifierID, TFunction< bool(const FInputDeviceState&)> ModifierCheckFunc )	Initialize this behavior with the given Target

Overridden from UInputBehavior

Type	Name	Description
FInputCaptureUpdate	BeginCapture ( const FInputDeviceState& InputState, EInputCaptureSide eSide )	Called after WantsCapture() returns a capture request that was accepted
void	ForceEndCapture ( const FInputCaptureData& CaptureData )	If this is called, the Behavior has forcibly lost capture (eg due to app losing focus for example) and needs to clean up accordingly
EInputDevices	GetSupportedDevices ()	Which device types does this Behavior support
FInputCaptureUpdate	UpdateCapture ( const FInputDeviceState& InputState, const FInputCaptureData& CaptureData )	Called for each new input event during a capture sequence.
FInputCaptureRequest	WantsCapture ( const FInputDeviceState& Input )	UInputBehavior implementation.

Navigation