1. Epic GamesDeveloper
  3. UScriptableModularBehaviorTool

UScriptableModularBehaviorTool

A Scriptable tool base blueprint class which provides support for user defined mouse interaction behaviors

API > API/Plugins > API/Plugins/ScriptableToolsFramework

A Scriptable tool base blueprint class which provides support for user defined mouse interaction behaviors

   
Name UScriptableModularBehaviorTool
Type class
Header File /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/BaseTools/ScriptableModularBehaviorTool.h
Include Path #include "BaseTools/ScriptableModularBehaviorTool.h"

Syntax

UCLASS (MinimalAPI)  
class UScriptableModularBehaviorTool : public UScriptableInteractiveTool

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAltModifier bool   BaseTools/ScriptableModularBehaviorTool.h  
bCtrlModifier bool   BaseTools/ScriptableModularBehaviorTool.h  
bShiftModifier bool   BaseTools/ScriptableModularBehaviorTool.h  
ClickDragBehaviors TArray< TObjectPtr< UScriptableToolClickDragBehavior > >   BaseTools/ScriptableModularBehaviorTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization
DoubleClickBehaviors TArray< TObjectPtr< UScriptableToolDoubleClickBehavior > >   BaseTools/ScriptableModularBehaviorTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization
KeyInputBehaviors TArray< TObjectPtr< UScriptableToolKeyInputBehavior > >   BaseTools/ScriptableModularBehaviorTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization
MouseHoverBehaviors TArray< TObjectPtr< UScriptableToolMouseHoverBehavior > >   BaseTools/ScriptableModularBehaviorTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization
MouseWheelBehaviors TArray< TObjectPtr< UScriptableToolMouseWheelBehavior > >   BaseTools/ScriptableModularBehaviorTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization
MultiClickSequenceBehaviors TArray< TObjectPtr< UScriptableToolClickSequenceBehavior > >   BaseTools/ScriptableModularBehaviorTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization
SingleClickBehaviors TArray< TObjectPtr< UScriptableToolSingleClickBehavior > >   BaseTools/ScriptableModularBehaviorTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization
SingleClickOrDragBehaviors TArray< TObjectPtr< UScriptableToolSingleClickOrDragBehavior > >   BaseTools/ScriptableModularBehaviorTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddClickDragBehavior ( const FTestCanBeginClickDragSequenceDelegate CanBeginClickDragSequence,
const FOnClickPressDelegate OnClickPress,
const FOnClickDragDelegate OnClickDrag,
const FOnClickReleaseDelegate OnClickRelease,
const FOnTerminateDragSequenceDelegate OnTerminateDragSequence,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority,
EScriptableToolMouseButton MouseButton,
bool bUpdateModifiersDuringDrag
)

 Implements a standard "button-click-drag"-style input behavior. BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"
  • Meta=(AdvancedDisplay="CaptureCheck, CapturePriority, MouseButton, bUpdateModifiersDuringDrag")

void AddDoubleClickBehavior ( const FTestIfHitByClickDelegate IfHitByClick,
const FOnHitByClickDelegate OnHitByClick,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority,
EScriptableToolMouseButton MouseButton,
bool bHitTestOnRelease
)

 Implements a standard "button-click"-style input behavior The state machine works as follows: 1) on input-device-button-press, hit-test the target. If hit, begin capture 2) on input-device-button-release, hit-test the target. If hit, call OnHitByClick(). If not hit, ignore click.The second hit-test is required to allow the click to be "cancelled" by moving away from the target. This is standard GUI behavior. You can disable this second hit test using the HitTestOnRelease property. This is strongly discouraged. BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"
  • Meta=(AdvancedDisplay="CaptureCheck, CapturePriority, MouseButton, bHitTestOnRelease")

void AddMouseHoverBehavior ( FBeginHoverSequenceHitTestDelegate BeginHoverSequenceHitTest,
FOnBeginHoverDelegate OnBeginHover,
FOnUpdateHoverDelegate OnUpdateHover,
FOnEndHoverDelegate OnEndHover,
const FMouseBehaviorModiferCheckDelegate HoverCaptureCheck,
int CapturePriority
)

   BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"
  • Meta=(AdvancedDisplay="CaptureCheck, CapturePriority")

void AddMouseWheelBehavior ( FTestShouldRespondToMouseWheelDelegate TestShouldRespondToMouseWheel,
FOnMouseWheelScrollUpDelegate OnMouseWheelScrollUp,
FOnMouseWheelScrollDownDelegate OnMouseWheelScrollDown,
FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority
)

   BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"
  • Meta=(AdvancedDisplay="CaptureCheck, CapturePriority")

void AddMultiClickSequenceBehavior ( FOnBeginSequencePreviewDelegate OnBeginSequencePreview,
FCanBeginClickSequenceDelegate CanBeginClickSequence,
FOnBeginClickSequenceDelegate OnBeginClickSequence,
FOnNextSequencePreviewDelegate OnNextSequencePreview,
FOnNextSequenceClickDelegate OnNextSequenceClick,
FOnTerminateClickSequenceDelegate OnTerminateClickSequence,
FRequestAbortClickSequenceDelegate RequestAbortClickSequence,
FMouseBehaviorModiferCheckDelegate CaptureCheck,
const FMouseBehaviorModiferCheckDelegate HoverCaptureCheck,
int CapturePriority,
EScriptableToolMouseButton MouseButton
)

 MultiClickSequenceBehavior implements a generic multi-click-sequence input behavior. BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"
  • Meta=(AdvancedDisplay="CaptureCheck, HoverCaptureCheck, CapturePriority, MouseButton")

void AddMultiKeyInputBehavior ( FOnKeyStateToggleDelegate OnKeyPressed,
FOnKeyStateToggleDelegate OnKeyReleased,
TArray< FKey > Keys,
bool bRequireAllKeys,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority
)

   BaseTools/ScriptableModularBehaviorTool.h  

void AddMultiKeyInputBehavior ( FOnKeyStateToggleDelegate OnKeyPressed,
FOnKeyStateToggleDelegate OnKeyReleased,
FOnForceEndCaptureDelegate_ScriptableTools OnForceEndCaptureFuncIn,
TArray< FKey > Keys,
bool bRequireAllKeys,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority
)

 AddMultiKeyInputBehavior implements a generic keyboard multi key listener behavior BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"
  • Meta=(AdvancedDisplay="CaptureCheck, CapturePriority")

void AddSingleClickBehavior ( const FTestIfHitByClickDelegate IfHitByClick,
const FOnHitByClickDelegate OnHitByClick,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority,
EScriptableToolMouseButton MouseButton,
bool bHitTestOnRelease
)

 Implements a standard "button-click"-style input behavior The state machine works as follows: 1) on input-device-button-press, hit-test the target. If hit, begin capture 2) on input-device-button-release, hit-test the target. If hit, call OnHitByClick(). If not hit, ignore click.The second hit-test is required to allow the click to be "cancelled" by moving away from the target. This is standard GUI behavior. You can disable this second hit test using the HitTestOnRelease property. This is strongly discouraged. BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"
  • Meta=(AdvancedDisplay="CaptureCheck, CapturePriority, MouseButton, bHitTestOnRelease")

void AddSingleClickOrDragBehavior ( FTestIfHitByClickDelegate IfHitByClick,
FOnHitByClickDelegate OnHitByClick,
FTestCanBeginClickDragSequenceDelegate CanBeginClickDragSequence,
FOnClickPressDelegate OnClickPress,
FOnClickDragDelegate OnClickDrag,
FOnClickReleaseDelegate OnClickRelease,
FOnTerminateDragSequenceDelegate OnTerminateDragSequence,
FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority,
EScriptableToolMouseButton MouseButton,
bool bBeginDragIfClickTargetNotHit,
float ClickDistanceThreshold
)

 SingleClickOrDragBehavior is a combination of a SingleClickBehavior and ClickDragBehavior, and allows for the common UI interaction where a click-and-release does one action, but if the mouse is moved, then a drag interaction is started. BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"
  • Meta=(AdvancedDisplay="CaptureCheck, CapturePriority, MouseButton, bBeginDragIfClickTargetNotHit, ClickDistanceThreshold")

void AddSingleKeyInputBehavior ( FOnKeyStateToggleDelegate OnKeyPressed,
FOnKeyStateToggleDelegate OnKeyReleased,
FKey Key,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority
)

   BaseTools/ScriptableModularBehaviorTool.h  

void AddSingleKeyInputBehavior ( FOnKeyStateToggleDelegate OnKeyPressed,
FOnKeyStateToggleDelegate OnKeyReleased,
FOnForceEndCaptureDelegate_ScriptableTools OnForceEndCaptureFuncIn,
FKey Key,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority
)

 AddSingleKeyInputBehavior implements a generic keyboard key listener behavior BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"
  • Meta=(AdvancedDisplay="CaptureCheck, CapturePriority")

FScriptableToolModifierStates GetActiveModifiers()

   BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

bool IsAltDown()

   BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

bool IsCtrlDown()

   BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

bool IsShiftDown ()

 Modifer Buttons Support BaseTools/ScriptableModularBehaviorTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

void OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

   BaseTools/ScriptableModularBehaviorTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page