Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UKeyAsModifierInputBehavior

[UKeyAsModifierInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UKeyAsModifierInputBehavior) converts a specific key press/release into a "Modifier" toggle via the [IModifierToggleBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IModifierToggleBehaviorTarget) interface

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInputBehavior

UKeyAsModifierInputBehavior

References

Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/Experimental/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

Variables

	Name	Description
TFunction< bool...	ModifierCheckFunc	WantsCapture() will only return capture request if this function returns true (or is null) Intended to be used for alt/ctrl/cmd/shift modifiers on the main ModifierKey
FKey	ModifierKey	Key that is used as modifier
FInputBehaviorM...	Modifiers	Modifier set for this behavior, internally initialized with check on ModifierKey
FKey	PressedButton	The key that was pressed to activate capture
IModifierToggle...	Target	Modifier Target object

Constructors

	Name	Description
	UKeyAsModifierInputBehavior()

Functions

		Name	Description
	void	Initialize ( IModifierToggleBehaviorTarget*..., int ModifierID, const FKey& ModifierKey )	Initialize this behavior with the given Target

Overridden from UInputBehavior

	Name	Description
FInputCaptur...	BeginCapture ( const FInputDeviceState& InputStat..., EInputCaptureSide eSide )	Called after WantsCapture() returns a capture request that was accepted
void	ForceEndCapture ( const FInputCaptureData& CaptureDa... )	If this is called, the Behavior has forcibly lost capture (eg due to app losing focus for example) and needs to clean up accordingly
EInputDevice...	GetSupportedDevices()	Which device types does this Behavior support
FInputCaptur...	UpdateCapture ( const FInputDeviceState& InputStat..., const FInputCaptureData& CaptureDa... )	Called for each new input event during a capture sequence.
FInputCaptur...	WantsCapture ( const FInputDeviceState& InputStat... )	Given the input state, does this Behavior want to begin capturing some input devices?

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss