Navigation
API > API/Plugins > API/Plugins/ScriptableToolsFramework > API/Plugins/ScriptableToolsFramework/UScriptableModularBehaviorTool
Description
AddMouseHoverBehavior implements a generic mouse hover behavior. For example, this can be used to change the "mode" of the current tool depending on what actor (if any) the mouse is hovering over.
| Name | AddMouseHoverBehavior |
| Type | function |
| Header File | /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/BaseTools/ScriptableModularBehaviorTool.h |
| Include Path | #include "BaseTools/ScriptableModularBehaviorTool.h" |
| Source | /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Private/BaseTools/ScriptableModularBehaviorTool.cpp |
UFUNCTION (BlueprintCallable, Category="ScriptableTool|Input",
Meta=(AdvancedDisplay="CaptureCheck, CapturePriority"))
void AddMouseHoverBehavior
(
FBeginHoverSequenceHitTestDelegate BeginHoverSequenceHitTest,
FOnBeginHoverDelegate OnBeginHover,
FOnUpdateHoverDelegate OnUpdateHover,
FOnEndHoverDelegate OnEndHover,
const FMouseBehaviorModiferCheckDelegate HoverCaptureCheck,
int CapturePriority
)
Parameters
| Name | Remarks |
|---|---|
| BeginHoverSequenceHitTest | Do hover hit-test. If this returns False, no further events below are executed. |
| OnBeginHover | Initialize hover sequence at given position |
| OnUpdateHover | Update active hover sequence with new input position |
| OnEndHover | Terminate active hover sequence |
| HoverCaptureCheck | Only enable hover capture if returns true |
| CapturePriority | The priority is used to resolve situations where multiple behaviors want the same capture. Lower values, including negative, have higher priority. |