FToolsetRegistry

Registry for AI toolsets.

API > API/Plugins > API/Plugins/ToolsetRegistry

Registry for AI toolsets. Allows registering, unregistering, finding, and executing tools from toolsets.

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

Syntax

class FToolsetRegistry

Constructors

Name Remarks Include Path Unreal Specifiers

FToolsetRegistry ( const TArray< FString >& InBlockedNames,
const TArray< FString >& InAllowedNames
)

   ToolsetRegistry/ToolsetRegistry.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FToolsetRegistry()

   ToolsetRegistry/ToolsetRegistry.h  

Typedefs

Name Type Remarks Include Path
FOnToolsetRegistryChanged TMulticastDelegate_NoParams< void > Delegate to be called when the toolset registry changes. ToolsetRegistry/ToolsetRegistry.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AllowedNames TArray< FString > Allow-list pattern strings. ToolsetRegistry/ToolsetRegistry.h  
BlockedNames TArray< FString > Block-list pattern strings. ToolsetRegistry/ToolsetRegistry.h  
JsonConverters TMap< FString, TSharedPtr< FToolsetJsonConverter > > The set of registered converters. ToolsetRegistry/ToolsetRegistry.h  
OnToolsetRegistryChanged FOnToolsetRegistryChanged Callbacks to be called when the toolset registry changes. ToolsetRegistry/ToolsetRegistry.h  
ToolsetHandlers TMap< FString, TSharedPtr< FToolset > > The set of registered toolset handlers. ToolsetRegistry/ToolsetRegistry.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddAllowedName ( const FString& Name
)

 Add a pattern to the allow-list. ToolsetRegistry/ToolsetRegistry.h  

void AddBlockedName ( const FString& Name
)

 Add a pattern to the block-list. ToolsetRegistry/ToolsetRegistry.h  

TFuture< TValueOrError< FString, FString > > ExecuteTool ( const FString& ToolName,
const FString& JsonInput
)

 Execute a tool from a registered toolset handler. ToolsetRegistry/ToolsetRegistry.h  

TFuture< TValueOrError< FString, FString > > ExecuteTool ( const FToolDescriptor& ToolDescriptor,
const FString& JsonInput
)

 Execute a tool from a registered toolset handler. ToolsetRegistry/ToolsetRegistry.h  

TSharedPtr< FToolset > Find ( const FString& ToolsetName,
bool LogErrors,
FString* ErrorMessage
)

 Find a registered toolset handler by name, and optionally log errors. ToolsetRegistry/ToolsetRegistry.h  

void ForEachToolset ( TFunctionRef< void(const FString&Name, const FToolset&Toolset)> Callback
) const

 Iterate all registered toolsets. ToolsetRegistry/ToolsetRegistry.h  

const TArray< FString > & GetAllowedNames()

 Returns the current allow-list patterns. ToolsetRegistry/ToolsetRegistry.h  

const TArray< FString > & GetBlockedNames()

 Returns the current block-list patterns. ToolsetRegistry/ToolsetRegistry.h  

TSharedPtr< FToolsetJsonConverter > GetConverterForProperty ( TNotNull< const FProperty* > Property
)

 Returns the converter that can handle the specified property, if any. ToolsetRegistry/ToolsetRegistry.h  
Get the JSON schemas for all registered toolsets. ToolsetRegistry/ToolsetRegistry.h  

FOnToolsetRegistryChanged & OnToolsetRegistered()

 Get the delegate for toolset registry changes. ToolsetRegistry/ToolsetRegistry.h  

bool RegisterConverter ( TSharedPtr< FToolsetJsonConverter > JsonConverter
)

 Register a custom JSON converter. Returns true if registration was successful. ToolsetRegistry/ToolsetRegistry.h  

bool RegisterToolset ( TSharedPtr< FToolset > ToolsetHandler
)

 Register a toolset handler. Returns true if registration was successful. ToolsetRegistry/ToolsetRegistry.h  

void RemoveAllowedName ( const FString& Name
)

 Remove a pattern from the allow-list. No-op if the pattern is not present. ToolsetRegistry/ToolsetRegistry.h  

void RemoveBlockedName ( const FString& Name
)

 Remove a pattern from the block-list. No-op if the pattern is not present. ToolsetRegistry/ToolsetRegistry.h  

bool UnregisterConverter ( TSharedPtr< FToolsetJsonConverter > JsonConverter
)

 Unregister a custom JSON converter. Returns true if unregistration was successful. ToolsetRegistry/ToolsetRegistry.h  

bool UnregisterToolset ( TSharedPtr< FToolset > ToolsetHandler
)

 Unregister a toolset handler. Returns true if unregistration was successful. ToolsetRegistry/ToolsetRegistry.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page