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 > UMultiClickSequenceInputBehavior

Light Theme

Dark Theme

UMultiClickSequenceInputBehavior

[UMultiClickSequenceInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UMultiClickSeque-) implements a generic multi-click-sequence input behavior.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInputBehavior

UAnyButtonInputBehavior

UMultiClickSequenceInputBehavior

References

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

Syntax

class UMultiClickSequenceInputBehavior : public UAnyButtonInputBehavior

Remarks

UMultiClickSequenceInputBehavior implements a generic multi-click-sequence input behavior. For example this behavior could be used to implement a multi-click polygon-drawing interaction.

The internal state machine works as follows: 1) on input-device-button-press, check if target wants to begin sequence. If so, begin capture. 2) on button release, check if target wants to continue or terminate sequence a) if terminate, release capture b) if continue, do nothing (capture continues between presses)

The target will receive "preview" notifications (basically hover) during updates where there is not a release. This can be used to (eg) update a rubber-band selection end point

Variables

	Name	Description
TFunction< bool...	ModifierCheckFunc	The first click will only be accepted if this function returns true (or is null)
FInputBehaviorM...	Modifiers	The modifier set for this behavior
ESequenceState	State
IClickSequenceB...	Target	Click Target object

Constructors

	Name	Description
	UMultiClickSequenceInputBehavior()

Functions

		Name	Description
	void	Initialize ( IClickSequenceBehaviorTarget* ... )	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
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
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
FInputCaptur...	UpdateCapture ( const FInputDeviceState& InputStat..., const FInputCaptureData& CaptureDa... )	Called for each new input event during a capture sequence.
FInputCaptur...	UpdateHoverCapture ( const FInputDeviceState& InputStat... )	Called on each new hover input event, ie if no other behavior is actively capturing input
FInputCaptur...	WantsCapture ( const FInputDeviceState& InputStat... )	Given the input state, does this Behavior want to begin capturing some input devices?
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)

Enums

	Name	Description
	ESequenceState

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

Take our survey

Dismiss