ULearningAgentsManagerListener

Base class for objects which can be added to a [ULearningAgentsManager](API\Plugins\LearningAgents\ULearningAgentsManager) to receive callbacks whenever agents are added, remove or reset.

API > API/Plugins > API/Plugins/LearningAgents

Base class for objects which can be added to a ULearningAgentsManager to receive callbacks whenever agents are added, remove or reset.

   
Name ULearningAgentsManagerListener
Type class
Header File /Engine/Plugins/Experimental/LearningAgents/Source/LearningAgents/Public/LearningAgentsManagerListener.h
Include Path #include "LearningAgentsManagerListener.h"

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, Blueprintable)  
class ULearningAgentsManagerListener : public UObject

Inheritance Hierarchy

Derived Classes

ULearningAgentsManagerListener derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ULearningAgentsManagerListener ( const FObjectInitializer& ObjectInitializer
)

 These constructors/destructors are needed to make forward declarations happy. LearningAgentsManagerListener.h  
  LearningAgentsManagerListener.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ULearningAgentsManagerListener()

   LearningAgentsManagerListener.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UObject * GetAgent ( const int32 AgentId
)

 Gets the agent corresponding to the given id. LearningAgentsManagerListener.h  

const UObject * GetAgent ( const int32 AgentId
) const

 -- Non-blueprint public interface -- LearningAgentsManagerListener.h  

const ULearningAgentsVisualLoggerObject * GetOrAddVisualLoggerObject ( const FName Name
)

 Either gets or adds a visual logger object for the given name LearningAgentsManagerListener.h  

bool HasAgent ( const int32 AgentId
) const

 Checks if the manager has an agent with the given agent id LearningAgentsManagerListener.h  

bool HasAgentManager()

 Checks if the object has an associated agent manager. LearningAgentsManagerListener.h  

bool IsSetup()

 Returns true if this object has been setup. Otherwise, false. LearningAgentsManagerListener.h
  • BlueprintPure
  • Category="LearningAgents"

void OnAgentsAdded ( const TArray< int32 >& AgentIds
)

 Called whenever agents are added to the manager. LearningAgentsManagerListener.h
  • BlueprintNativeEvent
  • Category="LearningAgents"

void OnAgentsManagerTick ( const TArray< int32 >& AgentIds,
const float DeltaTime
)

 Called whenever the manager object is ticked. LearningAgentsManagerListener.h
  • BlueprintNativeEvent
  • Category="LearningAgents"

void OnAgentsRemoved ( const TArray< int32 >& AgentIds
)

 Called whenever agents are removed from the manager. LearningAgentsManagerListener.h
  • BlueprintNativeEvent
  • Category="LearningAgents"

void OnAgentsReset ( const TArray< int32 >& AgentIds
)

 Called whenever agents are reset on the manager. LearningAgentsManagerListener.h
  • BlueprintNativeEvent
  • Category="LearningAgents"

Protected

Name Remarks Include Path Unreal Specifiers

UObject * GetAgent ( const int32 AgentId,
const TSubclassOf< UObject > AgentClass
) const

 -- Blueprint Convenience Functions -- LearningAgentsManagerListener.h
  • BlueprintPure
  • Category="LearningAgents"
  • Meta=(AgentId="-1", DeterminesOutputType="AgentClass")

ULearningAgentsManager * GetAgentManager()

 Gets the agent manager associated with this object. LearningAgentsManagerListener.h
  • BlueprintPure
  • Category="LearningAgents"

void GetAgents ( const TArray< int32 >& AgentIds,
const TSubclassOf< UObject > AgentClass,
TArray< UObject* >& OutAgents
) const

 Gets the agents associated with a set of ids from the manager. LearningAgentsManagerListener.h
  • BlueprintPure=false
  • Category="LearningAgents"
  • Meta=(DeterminesOutputType="AgentClass", DynamicOutputParam="OutAgents")

void GetAllAgents ( TArray< UObject* >& OutAgents,
TArray< int32 >& OutAgentIds,
const TSubclassOf< UObject > AgentClass
) const

 Gets all added agents from the manager. LearningAgentsManagerListener.h
  • BlueprintPure=false
  • Category="LearningAgents"
  • Meta=(DeterminesOutputType="AgentClass", DynamicOutputParam="OutAgents")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page