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

> Unreal Engine API Reference > Runtime > InteractiveToolsFramework > BaseBehaviors > UAnyButtonInputBehavior

Light Theme

Dark Theme

UAnyButtonInputBehavior

[UAnyButtonInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UAnyButtonInputBehavior) is a base behavior that provides a generic interface to a TargetButton on a physical Input Device.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInputBehavior

UAnyButtonInputBehavior

UClickDragInputBehavior

ULocalClickDragInputBehavior

UMouseWheelInputBehavior

UMultiClickSequenceInputBehavior

UScalableConeGizmoInputBehavior

UScalableSphereGizmoInputBehavior

USingleClickInputBehavior

ULocalSingleClickInputBehavior

USingleClickOrDragInputBehavior

References

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

Syntax

class UAnyButtonInputBehavior : public UInputBehavior

Remarks

UAnyButtonInputBehavior is a base behavior that provides a generic interface to a TargetButton on a physical Input Device. You can subclass UAnyButtonInputBehavior to write InputBehaviors that can work independent of a particular device type or button, by using the UAnyButtonInputBehavior functions below.

The target device button is selected using the .ButtonNumber property, or you can override the relevant GetXButtonState() function if you need more control.

Variables

		Name	Description
	EInputDevices	ActiveDevice	Which device is currently active
	TUniqueFunction...	GetMouseButtonStateFunc	Returns FDeviceButtonState for target mouse button

Constructors

	Name	Description
	UAnyButtonInputBehavior()

Functions

	Name	Description
EInputDevice...	GetActiveDevice()
FDeviceButto...	GetButtonStateFunc ( const FInputDeviceState& Input )	Returns FDeviceButtonState for target active device button
FVector2D	GetClickPoint ( const FInputDeviceState& input )
FInputDevice...	GetDeviceRay ( const FInputDeviceState& input )
FRay	GetWorldRay ( const FInputDeviceState& input )
bool	IsDown ( const FInputDeviceState& input )
bool	IsPressed ( const FInputDeviceState& input )
bool	IsReleased ( const FInputDeviceState& input )
void	SetUseCustomMouseButton ( TUniqueFunction< FDeviceButtonState... )	Configure a custom target mouse button
void	SetUseLeftMouseButton()	Configure the target Mouse button to be the left button
void	SetUseMiddleMouseButton()	Configure the target Mouse button to be the middle button
void	SetUseRightMouseButton()	Configure the target Mouse button to be the right button

Overridden from UInputBehavior

		Name	Description
	EInputDevice...	GetSupportedDevices()	Return set of devices supported by this behavior