UKeyInputBehavior | Unreal Engine 5.5 Documentation

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

Inheritance Hierarchy

UObject
UInputBehavior
UKeyInputBehavior

References


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

Syntax

UCLASS (MinimalAPI)  
class UKeyInputBehavior : public UInputBehavior

Remarks

UKeyInputBehavior provides a keyboard capturing behavior that works with single or multiple keys. Provided with a single key, the behavior triggers OnKeyPressed and OnKeyReleased events upon seeing the target key pressed down and released for the first time, ignoring any other key presses. When provided with multiple keys, the Behavior has variable behavior depending on whether bRequireAllKeys is set.

If true, the behavior sequence is as follows:

Initiate capture when any of the target keys are pressed.

Continue capture until all target keys are pressed simultaneously

Upon seeing the last key to complete the full set of target keys, issue an OnKeyPressed for whichever key completed the requirement. 3b. If any of the target keys are released after the full set was pressed, issue an OnKeyReleased for whichever key was released, then end Capture.

If at any point all target keys are released after capture begins, end capture.

If false, the behavior sequence is as follows:

Initiate capture when any of the target keys are pressed.

Continue capture while any of the target keys are still pressed.

Issue an OnKeyPressed for any target key pressed during the capture period.

Issue an OnKeyReleased for any target key released during the capture period.

If at any point all target keys are released, end capture.

Variables

Type	Name	Description
bool	bRequireAllKeys	If true, behavior requires all keys provided at initialization to be active at the same time in order to count as a "key down" event.
TArray< bool >	KeyActivations
TFunction< bool(const FInputDeviceState &)>	ModifierCheckFunc	WantsCapture() will only return capture request if this function returns true (or is null)
FInputBehaviorModifierStates	Modifiers	The modifier set for this behavior
IKeyInputBehaviorTarget *	Target	Modifier Target object
TArray< FKey >	TargetKeys

Constructors

	Type	Name	Description
		UKeyInputBehavior ()

Functions

	Type	Name	Description
	void	Initialize ( IKeyInputBehaviorTarget* Target, const FKey& Key )	Initialize this behavior with the given Target
	void	Initialize ( IKeyInputBehaviorTarget* Target, const TArray< FKey >& Keys )	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