FToolset | Unreal Engine 5.8 Documentation

Base class for toolsets.


Name	FToolset
Type	class
Header File	/Engine/Plugins/Experimental/ToolsetRegistry/Source/ToolsetRegistry/Public/ToolsetRegistry/Toolset.h
Include Path	#include "ToolsetRegistry/Toolset.h"

Syntax

class FToolset

Name	Remarks	Include Path	Unreal Specifiers
FToolset()		ToolsetRegistry/Toolset.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FToolset()		ToolsetRegistry/Toolset.h

Name	Type	Remarks	Include Path	Unreal Specifiers
bEnabled	bool	Whether this toolset has been explicitly enabled or disabled via SetEnabled().	ToolsetRegistry/Toolset.h
DisabledTools	TSet< FString >	Full names of disabled tools.	ToolsetRegistry/Toolset.h

Name	Remarks	Include Path
TFuture< TValueOrError< FString, FString > > ExecuteTool ( const FString& ToolName, const FString& JsonInput )	Executes a tool with the given name and JSON input.	ToolsetRegistry/Toolset.h
FString GetJsonSchema ()	Get the JSON schema the enabled tools in this toolset.	ToolsetRegistry/Toolset.h
FString GetToolsetDescription()	Returns a description of what this toolset does and when it should be used.	ToolsetRegistry/Toolset.h
FString GetToolsetName()	Returns the name of the toolset.	ToolsetRegistry/Toolset.h
FString GetToolsetVersion()	Returns the version of the toolset.	ToolsetRegistry/Toolset.h
bool IsEnabled()	Returns true if the toolset is enabled.	ToolsetRegistry/Toolset.h
bool IsToolEnabled ( const FString& FullToolName ) const	Returns true if the given tool passes the per-tool block/allow filters.	ToolsetRegistry/Toolset.h
TArray< FString > ListToolNames()	Returns the full names of all tools in this toolset, ignoring per-tool filters and the enabled state of the toolset.	ToolsetRegistry/Toolset.h
void SetEnabled ( bool bInEnabled )	Enable or disable the toolset.	ToolsetRegistry/Toolset.h
void SetNameFilters ( const TArray< FString >& BlockPatterns, const TArray< FString >& AllowPatterns )	Set the block and allow filter patterns.	ToolsetRegistry/Toolset.h

Name	Remarks	Include Path	Unreal Specifiers
virtual UClass * GetToolsetClass()	Returns the UClass that implements this toolset, if any.	ToolsetRegistry/Toolset.h

Name	Remarks	Include Path	Unreal Specifiers
TFuture< TValueOrError< FString, FString > > ExecuteToolInternal ( const FString& ToolName, const FString& JsonInput )	Executes a tool by name. Called by ExecuteTool() after enable checks pass.	ToolsetRegistry/Toolset.h
FString GetJsonSchemaInternal()	Get the JSON schema for all tools in the toolset.	ToolsetRegistry/Toolset.h