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 > API/Plugins/ScriptableToolsFramework/BaseTools

Inheritance Hierarchy

References

   
Module ScriptableToolsFramework
Header /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/BaseTools/ScriptableModularBehaviorTool.h
Include #include "BaseTools/ScriptableModularBehaviorTool.h"

Syntax

UCLASS ()  
class UScriptableModularBehaviorTool : public UScriptableInteractiveTool

Remarks

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

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta 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.
Public function UFunction BlueprintCallable, Category, Meta 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 OnClicked(). 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.
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta 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.
Public function UFunction BlueprintCallable, Category, Meta void

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

 AddMultiKeyInputBehavior implements a generic keyboard multi key listener behavior
Public function UFunction BlueprintCallable, Category, Meta 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 OnClicked(). 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.
Public function UFunction BlueprintCallable, Category, Meta 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.
Public function UFunction BlueprintCallable, Category, Meta void

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

 AddSingleKeyInputBehavior implements a generic keyboard key listener behavior
Public function UFunction BlueprintCallable, Category FScriptableToolModifierStates  
Public function void

OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

  
Public function Const UFunction BlueprintCallable, Category   Modifer Buttons Support
Public function Const UFunction BlueprintCallable, Category    
Public function Const UFunction BlueprintCallable, Category    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page