UE4U4MLAgent

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UE4ML

Header

/Engine/Plugins/AI/UE4ML/Source/UE4ML/Public/Agents/4MLAgent.h

Include

#include "Agents/4MLAgent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, EditInlineNew)
class UE4U4MLAgent : public UObject

Variables

Name Description

Protected variable UProperty Category, EditAnywhere BlueprintReadWrite

TArray< U4MLAct...

 

Actuators

Protected variable UProperty Category, EditAnywhere BlueprintReadWrite

TArray< U4MLSen...

 

Sensors

Protected variable

friend

 

U4MLSession

Functions

Name Description

Public function Virtual

void

 

Act

(
    const float DeltaTime
)

Trigger all of the agent's

Public function Virtual

void

 

Configure

(
    const F4MLAgentConfig& NewConfig
)

Public function Virtual

void

 

DigestActions

(
    F4MLMemoryReader& ValueStream
)

Virtual void DigestActions(const std::vector& ValueStream);

Public function Virtual Const

void

 

GetActionSpaceDescription

(
    F4MLSpaceDescription& OutSpaceDesc
)

Public function

U4MLActuator...

 

GetActuator

(
    const uint32 ActuatorID
)

Public function Const

TArray< U4ML...

 

GetActuatorsConstIterator()

Public function Const

F4ML::FAgent...

 

GetAgentID()

Public function Const

AActor *

 

GetAvatar()

Public function Const

const F4MLAg...

 

GetConfig()

Public function Const

const AContr...

 

GetController()

Public function

AController ...

 

GetController()

Public function

void

 

GetObservations

(
    F4MLMemoryWriter& Ar
)

Public function Virtual Const

void

 

GetObservationSpaceDescription

(
    F4MLSpaceDescription& OutSpaceDesc
)

Public function

APawn *

 

GetPawn()

Public function Const

const APawn ...

 

GetPawn()

Public function Virtual Const

float

 

GetReward()

Public function Const

TArray< U4ML...

 

GetSensorsConstIterator()

Public function

[U4MLSession](API\Plugins\UE4ML\Agents\UE4U4MLAgent\U4MLSession) ...

 

GetSession()

Public function Virtual Const

bool

 

IsDone()

Public function Const

bool

 

IsReady()

Public function Virtual Const

bool

 

IsSuitableAvatar

(
    AActor& InAvatar
)

Protected function Virtual UFunction

void

 

OnAvatarDestroyed

(
    AActor* DestroyedActor
)

Protected function Virtual

void

 

OnPawnChanged

(
    APawn* NewPawn,
    AController* InController
)

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

 

RegisterSensor

(
    U4MLSensor& Sensor
)

Public function Virtual

void

 

Sense

(
    const float DeltaTime
)

Updates all the senses that are configured as 'IsPolling'

Protected function

void

 

SetAgentID

(
    F4ML::FAgentID NewAgentID
)

Public function Virtual

void

 

SetAvatar

(
    AActor* InAvatar
)

Protected function Virtual

void

 

ShutDownSensorsAndActuators()

Public function

 

U4MLAgent

(
    const FObjectInitializer& ObjectIn...
)

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss