Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/UInteractiveToolManager
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolManager.h |
| Include | #include "InteractiveToolManager.h" |
| Source | /Engine/Source/Runtime/InteractiveToolsFramework/Private/InteractiveToolManager.cpp |
virtual bool PostActiveToolShutdownRequest
&40;
UInteractiveTool &42; Tool,
EToolShutdownType ShutdownType,
bool bShowUnexpectedShutdownMessage,
const FText & UnexpectedShutdownMessage
&41;
Remarks
A Tool (or other code) can call this function to request that the Tool be deactivated. The Tool must be active. By default, ::DeactivateTool() wil be called. However if some external code has bound to the OnToolShutdownRequest delegate, the request will be forwarded to that function first (::DeactivateTool() will still be called if it returns false)
If this function is called during InteractiveTool::Setup(), the Tool invocation will be aborted, ie the Tool will be immediately shutdown with EToolShutdownType::Cancel, and never become "Active"/etc. Note also that in this case the shutdown request will not be forwarded to the OnToolShutdownRequest delegate.
Parameters
| Name | Description |
|---|---|
| bShowUnexpectedShutdownMessage | if this was an unexpected shutdown, passing true here, along with a non-empty UnexpectedShutdownMessage, will result in OnToolUnexpectedShutdownMessage being called |
| UnexpectedShutdownMessage | message provided by the caller meant to explain why the Tool has unexpectedly been shut down |