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

UMouseHoverBehavior

Trivial InputBehavior that forwards InputBehavior hover events to a Target object via the [IHoverBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IHoverBehaviorTarget) interface.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInputBehavior

UMouseHoverBehavior

ULocalMouseHoverBehavior

References

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

Syntax

class UMouseHoverBehavior : public UInputBehavior

Remarks

Trivial InputBehavior that forwards InputBehavior hover events to a Target object via the IHoverBehaviorTarget interface.

Variables

		Name	Description
	FInputBehaviorM...	Modifiers	The modifier set for this behavior
	IHoverBehaviorT...	Target

Constructors

	Name	Description
	UMouseHoverBehavior()

Functions

		Name	Description
	void	Initialize ( IHoverBehaviorTarget* Target )

Overridden from UInputBehavior

	Name	Description
FInputCaptur...	BeginHoverCapture ( const FInputDeviceState& InputStat..., EInputCaptureSide eSide )	Called after WantsHoverCapture() returns a capture request that was accepted
void	EndHoverCapture()	If a different hover capture begins, focus is lost, a tool starts, etc, any active hover visualization needs to terminate
EInputDevice...	GetSupportedDevices()	Which device types does this Behavior support
FInputCaptur...	UpdateHoverCapture ( const FInputDeviceState& InputStat... )	Called on each new hover input event, ie if no other behavior is actively capturing input
FInputCaptur...	WantsHoverCapture ( const FInputDeviceState& InputStat... )	Given the input state, does this Behavior want to begin capturing some input devices for hover
bool	WantsHoverEvents()	Hover support (optional)return true if this Behavior supports hover (ie passive input events)