1. Epic GamesDeveloper
  3. UMLAdapterAgent

UMLAdapterAgent

An agent capable of controlling a single avatar (e.g. a Pawn or Controller).

API > API/Plugins > API/Plugins/MLAdapter > API/Plugins/MLAdapter/Agents

Inheritance Hierarchy

References

   
Module MLAdapter
Header /Engine/Plugins/AI/MLAdapter/Source/MLAdapter/Public/Agents/MLAdapterAgent.h
Include #include "Agents/MLAdapterAgent.h"

Syntax

UCLASS&40;Blueprintable, EditInlineNew&41;  
class UMLAdapterAgent : public UObject

Remarks

An agent capable of controlling a single avatar (e.g. a Pawn or Controller). Contains sensors for perceiving information about the environment and actuators for taking actions in the game.

Variables

  Type Name Description
Protected variable FCriticalSection ActionDurationCS  
Protected variable UProperty Category, EditAnywhere float ActionDurationSeconds How long should agents wait before they can change their action.
Protected variable UProperty Category, EditDefaultsOnly BlueprintReadOnly instanced TArray< TObjectPtr< UMLAdapterActuator > > Actuators  
Protected variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TSubclassOf< AActor > AvatarClass  
Protected variable UProperty Category visibleinstanceonly bool bActionDurationElapsed  
Protected variable UProperty Category, EditAnywhere bool bEnableActionDuration If true, then agents won't be able to make a new decision until each action duration has elapsed.
Protected variable UProperty Category visibleinstanceonly float CurrentActionDuration How much time has the current action been executing.
Protected variable UProperty Category, EditDefaultsOnly BlueprintReadOnly instanced TArray< TObjectPtr< UMLAdapterSensor > > Sensors  
Protected variable friend UMLAdapterSession  

Constructors

  Type Name Description
Public function  

UMLAdapterAgent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

Act ( const float DeltaTime
)

 Tick all of the agent's actuators.
Public function Virtual void

Configure ( const FMLAdapterAgentConfig& NewConfig
)

 Setup this agent's avatar, sensors, and actuators. Typically used for agents spawned via RPC.
Public function Virtual void Move data into the actuators for the next time Act is called.
Public function void

EnableActionDuration ( bool bEnable,
float DurationSeconds
)

 Enable/disable the action durations with the specified time duration in seconds.
Public function Virtual Const void Get the overall action space of this agent based on all its actuators.
Public function UMLAdapterActuator *

GetActuator ( const uint32 ActuatorID
)

 Get the actuator with the given ID if this agent has it.
Public function Const TArray< TObjectPtr< UMLAdapterActuator > >::TConstIterator  
Public function Const FMLAdapter::FAgentID Get this agent's ID.
Public function Const AActor * Get the avatar this agent is controlling.
Public function Const const FMLAdapterAgentConfig & Get this agent's current config.
Public function Const const AController * Get the Controller this agent is controlling.
Public function AController * Get the Controller this agent is controlling.
Public function void Retrieve all the sensor data from the last time Sense was called.
Public function Virtual Const void Get the overall observation space of this agent based on all its sensors.
Public function APawn *

GetPawn ()

 Get the Pawn this agent is controlling.
Public function Const const APawn *

GetPawn ()

 Get the Pawn this agent is controlling.
Public function Virtual Const float If the avatar is a controller, then get the current score from the controller's player state.
Public function Const TArray< TObjectPtr< UMLAdapterSensor > >::TConstIterator  
Public function UMLAdapterSession & Get the session that this agent belongs to.
Public function Virtual Const bool

IsDone ()

 The agent is done if its avatar has been destroyed and it can't request a new one.
Public function Const bool

IsReady ()

 Returns true if this agent has an avatar set.
Public function Virtual Const bool

IsSuitableAvatar ( AActor& InAvatar
)

 Returns true is the given avatar can be controlled by this agent.
Protected function Virtual UFunction void

OnAvatarDestroyed ( AActor* DestroyedActor
)

 When the agent's avatar is destroyed, we need to cleanup callbacks and references to the avatar.
Protected function Virtual void

OnPawnChanged ( APawn* NewPawn,
AController* InController
)

 If the Pawn changed, we need to let all the sensors know.
Protected function UFunction void

OnPawnControllerChanged ( APawn* InPawn,
AController* InController
)

 Will be bound to UGameInstance.OnPawnControllerChanged if current avatar is a pawn or a controller.
Public function Virtual bool Add a sensor to this agent. Returns true if the sensor was successfully added.
Public function Virtual void

Sense ( const float DeltaTime
)

 Updates all the sensors that are configured as 'IsPolling'.
Protected function void Set this agent's ID to its new ID.
Public function Virtual void

SetAvatar ( AActor* InAvatar
)

 Sets the avatar for this agent and all of its sensors and actuators. Registers callbacks.
Protected function Virtual void  
Public function Virtual void

Think ( const float DeltaTime
)

 Decide what action to take based on the current observations.
Public function bool Resets the action duration flag if it has elapsed.

Overridden from UObject

  Type Name Description
Public function Virtual void Shutdown all the sensors and actuators and cleanup references to the avatar.
Public function Virtual void Perform initial setup for blueprint spawned agents.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page