1. Epic GamesDeveloper
  3. ULearningAgentsManagerComponent

ULearningAgentsManagerComponent

Base class for components which can be attached to an [ALearningAgentsManager](API\Plugins\LearningAgents\ALearningAgentsManager).

API > API/Plugins > API/Plugins/LearningAgents

Inheritance Hierarchy

References

   
Module LearningAgents
Header /Engine/Plugins/Experimental/LearningAgents/Source/LearningAgents/Public/LearningAgentsManagerComponent.h
Include #include "LearningAgentsManagerComponent.h"

Syntax

UCLASS&40;Abstract, BlueprintType, Blueprintable&41;  
class ULearningAgentsManagerComponent : public UActorComponent

Remarks

Base class for components which can be attached to an ALearningAgentsManager.

Variables

  Type Name Description
Protected variable UProperty Category Transient visibleanywhere bool bIsSetup True if this component has been setup. Otherwise, false.
Protected variable UProperty Category Transient visibleanywhere TArray< TObjectPtr< ULearningAgentsHelper > > HelperObjects The list of current helper objects.
Protected variable UProperty Category Transient visibleanywhere TObjectPtr< ALearningAgentsManager > Manager The associated manager this component is attached to.

Constructors

  Type Name Description
Public function   These constructors/destructors are needed to make forward declarations happy.
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Helpers
Public function UFunction Category blueprintnativeevent void

AgentsAdded ( const TArray< int32 >& AgentIds
)

 During this event, any additional logic required for when agents are added can be executed.
Public function UFunction Category blueprintnativeevent void

AgentsRemoved ( const TArray< int32 >& AgentIds
)

 During this event, any additional logic required for when agents are removed can be executed.
Public function UFunction Category blueprintnativeevent void

AgentsReset ( const TArray< int32 >& AgentIds
)

 During this event, any additional logic required for when agents are reset can be executed.
Protected function Const UFunction BlueprintPure, Category, Meta UObject *

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

 Blueprint Convenience Functions
Public function Const const UObject *

GetAgent ( const int32 AgentId
)

 Non-blueprint public interface
Public function UObject *

GetAgent ( const int32 AgentId
)

 Gets the agent corresponding to the given id.
Protected function Const UFunction BlueprintPure, Category, Meta ALearningAgentsManager *

GetAgentManager ( const TSubclassOf< ALearningAgentsManager > AgentManagerClass
)

 Gets the agent manager associated with this component.
Public function ALearningAgentsManager * Gets the associated agent manager assuming it exists.
Public function Const const ALearningAgentsManager * Gets the associated agent manager assuming it exists.
Protected function Const UFunction BlueprintPure, Category, Meta void

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

 Gets the agents associated with a set of ids from the manager.
Protected function Const UFunction BlueprintPure, Category, Meta void

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

 Gets all added agents from the manager.
Public function Const bool

HasAgent ( const int32 AgentId
)

 Checks if the component has the given agent id
Public function Const bool Checks if the component has an agent manager.
Public function Const UFunction BlueprintPure, Category bool

IsSetup ()

 Returns true if this component has been setup. Otherwise, false.
Public function Virtual void

OnAgentsAdded ( const TArray< int32 >& AgentIds
)

 Called whenever agents are added to the parent ALearningAgentsManager object.
Public function Virtual void

OnAgentsRemoved ( const TArray< int32 >& AgentIds
)

 Called whenever agents are removed from the parent ALearningAgentsManager object.
Public function Virtual void

OnAgentsReset ( const TArray< int32 >& AgentIds
)

 Called whenever agents are reset on the parent ALearningAgentsManager object.

Overridden from UObject

  Type Name Description
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page