Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Allows an interactive tool to influence the way it is shut down, if the tool host supports that kind of customization. This can be helpful, for example, if your tool prefers a specific shutdown type in various situations, but a tool can't rely on this interface being queried unless it knows that it will only be used by systems that respect it. A simple interactive tools framework context implementation does not need to bother querying the tool on its preferences (aside from the already existing CanAccept method on the actual tool object).
Note that there are different systems that might choose to query this interface. The tool manager might want to query it if its ToolSwitchMode is set to be customizable, or the mode or mode toolkit might query it when shutting down the tool in various situations.
| Name | IInteractiveToolShutdownQueryAPI |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolQueryInterfaces.h |
| Include Path | #include "InteractiveToolQueryInterfaces.h" |
Syntax
class IInteractiveToolShutdownQueryAPI
Enums
Public
| Name | Remarks |
|---|---|
| EShutdownReason |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EToolShutdownType GetPreferredShutdownType
(
EShutdownReason ShutdownReason, |
Given a shutdown situation, tells what kind of shutdown method the tool might prefer. | InteractiveToolQueryInterfaces.h |