UE4U4MLAgentElement

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UE4U4MLAgentElement

References

Module

UE4ML

Header

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

Include

#include "Agents/4MLAgentElement.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract)
class UE4U4MLAgentElement : public UObject

Variables

Name Description

Protected variable

FString

 

Description

Can be queried by remote clients

Protected variable UProperty

uint32

 

ElementID

@note this is not a common counter, meaning Sensors and Actuators (for example) track the ID separately

Protected variable UProperty

FString

 

Nickname

User-configured name for this element, mostly for debugging purposes but comes in handy when fetching observation/action spaces descriptions.

Protected variable

TSharedRef< F4M...

 

SpaceDef

Functions

Name Description

Public function Virtual

void

 

Configure

(
    const TMap< FName, FString >& Para...
)

Protected function Virtual Const

TSharedPtr< ...

 

ConstructSpaceDef()

Public function Const

const U4MLAg...

 

GetAgent()

Public function Const

AActor *

 

GetAvatar()

Public function Const

AController ...

 

GetControllerAvatar()

Public function Virtual Const

FString

 

GetDescription()

Public function Const

uint32

 

GetElementID()

Public function Const

const FStrin...

 

GetNickname()

Public function Const

bool

 

GetPawnAndControllerAvatar

(
    APawn*& OutPawn,
    AController*& OutController
)

Fetches both the pawn and the controller associated with the current agent. It's like both calling

Public function Const

APawn *

 

GetPawnAvatar()

Public function Const

const F4ML::...

 

GetSpaceDef()

Public function Virtual

void

 

OnAvatarSet

(
    AActor* Avatar
)

Public function

void

 

SetNickname

(
    const FString& NewNickname
)

Public function Virtual

void

 

Shutdown()

Called before object's destruction.

Public function

 

U4MLAgentElement

(
    const FObjectInitializer& ObjectIn...
)

Public function Virtual

void

 

UpdateSpaceDef()

Overridden from UObject

Name Description

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

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