Navigation
API > API/Plugins > API/Plugins/ScriptableToolsFramework > API/Plugins/ScriptableToolsFramework/UScriptableModularBehaviorTool
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddMultiKeyInputBehavior
(
FOnKeyStateToggleDelegate OnKeyPressed, |
BaseTools/ScriptableModularBehaviorTool.h | ||
void AddMultiKeyInputBehavior
(
FOnKeyStateToggleDelegate OnKeyPressed, |
AddMultiKeyInputBehavior implements a generic keyboard multi key listener behavior | BaseTools/ScriptableModularBehaviorTool.h |
|
AddMultiKeyInputBehavior(FOnKeyStateToggleDelegate, FOnKeyStateToggleDelegate, TArray< FKey >, bool, const FMouseBehaviorModiferCheckDelegate, int)
| Name | AddMultiKeyInputBehavior |
| Type | function |
| Header File | /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/BaseTools/ScriptableModularBehaviorTool.h |
| Include Path | #include "BaseTools/ScriptableModularBehaviorTool.h" |
void AddMultiKeyInputBehavior
(
FOnKeyStateToggleDelegate OnKeyPressed,
FOnKeyStateToggleDelegate OnKeyReleased,
TArray < FKey > Keys,
bool bRequireAllKeys,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority
)
AddMultiKeyInputBehavior(FOnKeyStateToggleDelegate, FOnKeyStateToggleDelegate, FOnForceEndCaptureDelegate_ScriptableTools, TArray< FKey >, bool, const FMouseBehaviorModiferCheckDelegate, int)
Description
AddMultiKeyInputBehavior implements a generic keyboard multi key listener behavior
| Name | AddMultiKeyInputBehavior |
| 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 AddMultiKeyInputBehavior
(
FOnKeyStateToggleDelegate OnKeyPressed,
FOnKeyStateToggleDelegate OnKeyReleased,
FOnForceEndCaptureDelegate_ScriptableTools OnForceEndCaptureFuncIn,
TArray < FKey > Keys,
bool bRequireAllKeys,
const FMouseBehaviorModiferCheckDelegate CaptureCheck,
int CapturePriority
)
Parameters
| Name | Remarks |
|---|---|
| OnKeyPressed | Callback when the target key(s) is pressed. Only triggers once if bRequireAllKeys is true. |
| OnKeyReleased | Callback when the target key(s) is pressed. Only triggers once if bRequireAllKeys is true. |
| OnForceEndCaptureFuncIn | Callback when capture is ended prematurely, typically due to the viewport losing focus, in which case the release callback will not be called. |
| Keys | Target keys to watch for |
| bRequireAllKeys | If true, all target keys must be pressed simultaniously to recieve press/release events. Otherwise, any and all keys can trigger events. |
| CaptureCheck | Only enable capture if returns true |
| CapturePriority | The priority is used to resolve situations where multiple behaviors want the same capture |