1. Epic GamesDeveloper
  3. FMLAdapterLibrarian

FMLAdapterLibrarian

The [FMLAdapterLibrarian](API\Plugins\MLAdapter\FMLAdapterLibrarian) discovers all classes that derived from [UMLAdapterAgent](API\Plugins\MLAdapter\Agents\UMLAdapterAgent), [UMLAdapterSensor](API\Plugins\MLAdapter\Sensors\UMLAdapterSensor), or [UMLAdapterActuator](API\Plugins\MLAdapter\Actuators\UMLAdapterActuator).

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
Protected variable UProperty TMap< uint32, TSubclassOf< UMLAdapterActuator > > KnownActuatorClasses  
Protected variable UProperty TArray< TSubclassOf< UMLAdapterAgent > > KnownAgentClasses  
Protected variable UProperty TMap< uint32, TSubclassOf< UMLAdapterSensor > > KnownSensorClasses  
Protected variable TMap< FName, FString > RPCFunctionDescriptions  

Functions

  Type Name Description
Public function void

AddRPCFunctionDescription ( const FName FunctionName,
FString&& Description
)

 Add the given description to the mapped entry for the given function name.
Public function Const TSubclassOf< UMLAdapterActuator >

FindActuatorClass ( const FName ClassName
)

 Find the actuator class with the given class name.
Public function Const TSubclassOf< UMLAdapterAgent >

FindAgentClass ( const FName ClassName
)

 Find the agent class with the given class name.
Public function Const TSubclassOf< UMLAdapterSensor >

FindSensorClass ( const FName ClassName
)

 Find the sensor class with the given class name.
Public function void Register all the base classes and derived classes that inherit from UMLAdapterAgent, UMLAdapterSensor, or UMLAdapterActuator.
Public function Static const FMLAdapterLibrarian &

Get ()

 Gets the librarian owned by the singleton UMLAdapterManager instance.
Public function Const bool

GetActuatorDescription ( const FName ActuatorName,
FString& OutDescription
)

 Gets the description for the given actuator name.
Public function Const TMap< uint32, TSubclassOf< UMLAdapterActuator > >::TConstIterator Get a const iterator over the list of known actuators.
Public function Const TArray< TSubclassOf< UMLAdapterAgent > >::TConstIterator Get a const iterator over the list of known agents.
Public function Const bool

GetFunctionDescription ( const FName FunctionName,
FString& OutDescription
)

 Gets the function description for the given function name.
Public function Const bool

GetFunctionDescription ( const FString& FunctionName,
FString& OutDescription
)

 Inlines
Public function Const TMap< FName, FString >::TConstIterator Get a const iterator over the list of function descriptions.
Public function Const bool

GetSensorDescription ( const FName SensorName,
FString& OutDescription
)

 Gets the description for the given sensor name.
Public function Const TMap< uint32, TSubclassOf< UMLAdapterSensor > >::TConstIterator Get a const iterator over the list of known sensors.
Public function void Add the actuator class to the list of known actuators.
Public function void Add the agent class to the list of known agents.
Public function void Add the sensor class to the list of known sensors.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page