Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Declarative description of a ToolGroup.
A ToolGroup describes:
- which tool types should be registered (FTool entries),
- which shared, context-wide features should be installed (Install/Uninstall callbacks),
- which input behaviors should be active (built into a per-context UInputBehaviorSet),
- optional context policy hooks (eg editor-only widget visibility).
ToolGroups are intentionally immutable descriptors and must not own per-context runtime state. All per-context state (registered tool ids, acquired features, behavior sets, etc.) is owned by UToolGroupManager in FEnabledToolGroupState.
| Name | FToolGroup |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/ToolGroup.h |
| Include Path | #include "ToolGroup.h" |
Syntax
class FToolGroup
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FToolGroup() |
ToolGroup.h |
Structs
| Name | Remarks |
|---|---|
| FFeature | A shared, reference-counted feature installed into a UInteractiveToolsContext. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FBuildBehaviorsHook | TFunction< void(UInteractiveToolsContext &ToolsContext, UInputBehaviorSet &BehaviorSet)> | Hook used to build the per-context input behaviors for this group. | ToolGroup.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BuildBehaviorsFunc | FBuildBehaviorsHook | Optional behavior builder (called per enabled group per context). | ToolGroup.h | |
| Features | TArray< FFeature > | Declarative feature requirements. | ToolGroup.h | |
| Tools | TArray< FTool > | Declarative tool list. | ToolGroup.h |