UKeyAsModifierInputBehavior | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/InteractiveToolsFramework

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.


Name	UKeyAsModifierInputBehavior
Type	class
Header File	/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseBehaviors/KeyAsModifierInputBehavior.h
Include Path	#include "BaseBehaviors/KeyAsModifierInputBehavior.h"

Syntax

UCLASS (MinimalAPI)  
class UKeyAsModifierInputBehavior : public UInputBehavior

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UInputBehavior → UKeyAsModifierInputBehavior

Derived Classes

UMouseButtonAsModifierInputBehavior

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UKeyAsModifierInputBehavior()		BaseBehaviors/KeyAsModifierInputBehavior.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
virtual void Initialize ( IModifierToggleBehaviorTarget* Target, int ModifierID, const FKey& ModifierKey )	Initialize this behavior with the given Target	BaseBehaviors/KeyAsModifierInputBehavior.h
void Initialize ( IModifierToggleBehaviorTarget* TargetIn, int ModifierID, TFunction< bool(const FInputDeviceState&)> ModifierCheckFunc )	Initialize this behavior with the given Target	BaseBehaviors/KeyAsModifierInputBehavior.h

Overridden from UInputBehavior

Name	Remarks	Include Path
virtual FInputCaptureUpdate BeginCapture ( const FInputDeviceState& InputState, EInputCaptureSide eSide )	Called after WantsCapture() returns a capture request that was accepted	BaseBehaviors/KeyAsModifierInputBehavior.h
virtual 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	BaseBehaviors/KeyAsModifierInputBehavior.h
virtual EInputDevices GetSupportedDevices()	Which device types does this Behavior support	BaseBehaviors/KeyAsModifierInputBehavior.h
virtual FInputCaptureUpdate UpdateCapture ( const FInputDeviceState& InputState, const FInputCaptureData& CaptureData )	Called for each new input event during a capture sequence.	BaseBehaviors/KeyAsModifierInputBehavior.h
virtual FInputCaptureRequest WantsCapture ( const FInputDeviceState& Input )	UInputBehavior implementation.	BaseBehaviors/KeyAsModifierInputBehavior.h
virtual bool WantsForceEndCapture ()	When this function returns true, this behavior will always receive ForceEndCapture calls even when it is not actively capturing.	BaseBehaviors/KeyAsModifierInputBehavior.h

Navigation