Navigation
API > API/Plugins > API/Plugins/ScriptableToolsFramework > API/Plugins/ScriptableToolsFramework/UScriptableInteractiveTool
Description
Request that the active Tool be shut down. The Tool can post this to shut itself down (eg in a Tool where the interaction paradigm is "click to do something and exit").
| Name | RequestToolShutdown |
| Type | function |
| Header File | /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/ScriptableInteractiveTool.h |
| Include Path | #include "ScriptableInteractiveTool.h" |
| Source | /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Private/ScriptableInteractiveTool.cpp |
UFUNCTION (BlueprintCallable, Category="ScriptableTool", Meta=(Identifier="Settings"))
void RequestToolShutdown
(
bool bAccept,
bool bShowUserPopupMessage,
FText UserMessage
)
Parameters
| Name | Remarks |
|---|---|
| bAccept | if this is an Accept/Cancel Tool, Accept it, otherwise Cancel. Ignored for Complete-type Tools. |