Navigation
API > API/Plugins > API/Plugins/MLAdapter
References
| Module | MLAdapter |
| Header | /Engine/Plugins/AI/MLAdapter/Source/MLAdapter/Public/MLAdapterLibrarian.h |
| Include | #include "MLAdapterLibrarian.h" |
Syntax
USTRUCT ()
struct FMLAdapterLibrarian
Remarks
The FMLAdapterLibrarian discovers all classes that derived from UMLAdapterAgent, UMLAdapterSensor, or UMLAdapterActuator. It provides functionality for finding those classes by name, so that remote clients can spawn them via their name.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TMap< uint32, TSubclassOf< UMLAdapterActuator > > | KnownActuatorClasses | ||
| TArray< TSubclassOf< UMLAdapterAgent > > | KnownAgentClasses | ||
| TMap< uint32, TSubclassOf< UMLAdapterSensor > > | KnownSensorClasses | ||
| TMap< FName, FString > | RPCFunctionDescriptions |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddRPCFunctionDescription
(
const FName FunctionName, |
Add the given description to the mapped entry for the given function name. | |
| TSubclassOf< UMLAdapterActuator > | FindActuatorClass
(
const FName ClassName |
Find the actuator class with the given class name. | |
| TSubclassOf< UMLAdapterAgent > | FindAgentClass
(
const FName ClassName |
Find the agent class with the given class name. | |
| TSubclassOf< UMLAdapterSensor > | FindSensorClass
(
const FName ClassName |
Find the sensor class with the given class name. | |
| void | Register all the base classes and derived classes that inherit from UMLAdapterAgent, UMLAdapterSensor, or UMLAdapterActuator. | ||
| const FMLAdapterLibrarian & | Get () |
Gets the librarian owned by the singleton UMLAdapterManager instance. | |
| bool | GetActuatorDescription
(
const FName ActuatorName, |
Gets the description for the given actuator name. | |
| TMap< uint32, TSubclassOf< UMLAdapterActuator > >::TConstIterator | Get a const iterator over the list of known actuators. | ||
| TArray< TSubclassOf< UMLAdapterAgent > >::TConstIterator | Get a const iterator over the list of known agents. | ||
| bool | GetFunctionDescription
(
const FName FunctionName, |
Gets the function description for the given function name. | |
| bool | GetFunctionDescription
(
const FString& FunctionName, |
Inlines | |
| TMap< FName, FString >::TConstIterator | Get a const iterator over the list of function descriptions. | ||
| bool | GetSensorDescription
(
const FName SensorName, |
Gets the description for the given sensor name. | |
| TMap< uint32, TSubclassOf< UMLAdapterSensor > >::TConstIterator | Get a const iterator over the list of known sensors. | ||
| void | RegisterActuatorClass
(
const TSubclassOf< UMLAdapterActuator >& Class |
Add the actuator class to the list of known actuators. | |
| void | RegisterAgentClass
(
const TSubclassOf< UMLAdapterAgent >& Class |
Add the agent class to the list of known agents. | |
| void | RegisterSensorClass
(
const TSubclassOf< UMLAdapterSensor >& Class |
Add the sensor class to the list of known sensors. |