1. Epic GamesDeveloper
  3. ULearningAgentsManager

ULearningAgentsManager

The agent manager is responsible for tracking which game objects are agents.

API > API/Plugins > API/Plugins/LearningAgents

Inheritance Hierarchy

  • UActorComponent
  • ULearningAgentsManager

References

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

Syntax

UCLASS (BlueprintType, Blueprintable, Meta=(BlueprintSpawnableComponent))  
class ULearningAgentsManager : public UActorComponent

Remarks

The agent manager is responsible for tracking which game objects are agents. It's the central class around which most of Learning Agents is built.

If you have multiple different types of objects you want controlled by Learning Agents, you should consider creating one agent manager per object type, rather than trying to share an agent manager.

Variables

  Type Name Description
Protected variable UProperty Category, EditDefaultsOnly, Meta int32 MaxAgentNum Maximum number of agents.

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 UFunction BlueprintCallable, Category int32

AddAgent ( UObject* Agent
)

 Adds the given object as an agent to the manager.
Public function UFunction BlueprintCallable, Category void

AddAgents ( TArray< int32 >& OutAgentIds,
const TArray< UObject* >& InAgents
)

 Adds the given objects as an agents to the manager.
Public function UFunction BlueprintCallable, Category void Adds a listener to be tracked by this manager.
Public function Const UFunction BlueprintPure, Category, Meta UObject *

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

 Gets the agent with the given id.
Public function UObject *

GetAgent ( const int32 AgentId
)

 Gets the agent corresponding to the given id.
Public function Const const UObject *

GetAgent ( const int32 AgentId
)

 -- Non-blueprint public interface --
Public function Const UFunction BlueprintPure, Category int32

GetAgentId ( UObject* Agent
)

 Gets the agent id associated with a given agent.
Public function Const UFunction BlueprintPure, Category void

GetAgentIds ( TArray< int32 >& OutAgentIds,
const TArray< UObject* >& InAgents
)

 Gets the agent ids associated with a set of agents.
Public function Const UFunction BlueprintPure, Category int32 Gets the number of agents added
Public function Const UFunction BlueprintPure, Category, Meta void

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

 Gets the agents associated with a set of ids.
Public function Const TConstArrayView< TObjectPtr< UObject > > Get a const array view of this manager's agent objects.
Public function Const const TArray< int32 > & Gets the set of agent ids currently added
Public function Const UFunction BlueprintPure, Category, Meta void

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

 Gets all added agents.
Public function Const UE::Learning::FIndexSet Gets the set of agent ids currently added as an FIndexSet
Public function Const UFunction BlueprintPure, Category int32 -- Agent Management --
Public function Const UFunction BlueprintPure, Category, Meta bool

HasAgent ( const int32 AgentId
)

 Returns true if the given id is an agent used by the manager; Otherwise, false.
Public function Const UFunction BlueprintPure, Category bool

HasAgentObject ( UObject* Agent
)

 Returns true if the given object is an agent used by the manager; Otherwise, false.
Public function Virtual void  
Public function UFunction BlueprintCallable, Category, Meta void

RemoveAgent ( const int32 AgentId
)

 Removes the agent with the given id from the manager.
Public function UFunction BlueprintCallable, Category void

RemoveAgents ( const TArray< int32 >& AgentIds
)

 Removes the agents with the given ids from the manager.
Public function UFunction BlueprintCallable, Category void Removes all agents from the manager.
Public function UFunction BlueprintCallable, Category void Removes a listener from being tracked by this manager.
Public function UFunction BlueprintCallable, Category, Meta void

ResetAgent ( const int32 AgentId
)

 Resets the agent with the given id on the manager.
Public function UFunction BlueprintCallable, Category void

ResetAgents ( const TArray< int32 >& AgentIds
)

 Resets the agents with the given ids on the manager.
Public function UFunction BlueprintCallable, Category void Resets all the agents on the manager.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page