Navigation
API > API/Plugins > API/Plugins/ScriptableToolsFramework > API/Plugins/ScriptableToolsFramework/UScriptableModularBehaviorTool
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddSingleKeyInputBehavior
(
FOnKeyStateToggleDelegate OnKeyPressed, |
BaseTools/ScriptableModularBehaviorTool.h | ||
void AddSingleKeyInputBehavior
(
FOnKeyStateToggleDelegate OnKeyPressed, |
AddSingleKeyInputBehavior implements a generic keyboard key listener behavior. | BaseTools/ScriptableModularBehaviorTool.h |
|
AddSingleKeyInputBehavior(FOnKeyStateToggleDelegate, FOnKeyStateToggleDelegate, FKey, const FMouseBehaviorModiferCheckDelegate, int)
| Name | AddSingleKeyInputBehavior |
| Type | function |
| Header File | /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/BaseTools/ScriptableModularBehaviorTool.h |
| Include Path | #include "BaseTools/ScriptableModularBehaviorTool.h" |
void AddSingleKeyInputBehavior
(
FOnKeyStateToggleDelegate OnKeyPressed,
FOnKeyStateToggleDelegate OnKeyReleased,
FKey Key,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority
)
AddSingleKeyInputBehavior(FOnKeyStateToggleDelegate, FOnKeyStateToggleDelegate, FOnForceEndCaptureDelegate_ScriptableTools, FKey, const FMouseBehaviorModiferCheckDelegate, int)
Description
AddSingleKeyInputBehavior implements a generic keyboard key listener behavior. This is often used to add "hotkeys" or "shortcuts" to the tool.
CapturePriority can be used to either give priority to "built in" viewport hotkeys (the default) or to have this behavior's key be the priority, using CapturePriority numbers lower than 50, for example.
| Name | AddSingleKeyInputBehavior |
| 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 AddSingleKeyInputBehavior
(
FOnKeyStateToggleDelegate OnKeyPressed,
FOnKeyStateToggleDelegate OnKeyReleased,
FOnForceEndCaptureDelegate_ScriptableTools OnForceEndCaptureFuncIn,
FKey Key,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority
)
Parameters
| Name | Remarks |
|---|---|
| OnKeyPressed | Callback when the target key is pressed. |
| OnKeyReleased | Callback when the target key is released |
| OnForceEndCaptureFuncIn | Callback when capture is ended prematurely, typically due to the viewport losing focus, in which case the release callback will not be called. |
| Key | Target key to watch for |
| CaptureCheck | Only enable 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. |