UAbstractInteractor

class UAbstractInteractor : public UObject

An abstract class objects that can interact with the environment, either by observing or acting.

Inherits from: public UObject

Subclassed by: UAbstractObserver, UActuator

Public Interface

Public Functions:

TryGetOwner

AActor * TryGetOwner() const const

Try and Get the Actor this Observer is attached to, may return nullptr.

Returns: the Agent this Observer is attached to in, may return nullptr

Returns: AActor *

Attributes: const

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 39, column 8)

Implementation: Schola/Source/Schola/Private/Common/AbstractInteractor.cpp (lines 5-57)

GetLabel

FString GetLabel() const const

Get an non-unique label of this Interactor, based on the class of the object containing the interactor.

Returns: the collected ID

Returns: FString

Attributes: const

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 46, column 9)

Implementation: Schola/Source/Schola/Private/Common/AbstractInteractor.cpp (lines 86-107)

GetId

virtual FString GetId() const const

Get the label of this Interactor.

Returns: the collected ID

Returns: FString

Attributes: const, virtual

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 53, column 17)

Implementation: Schola/Source/Schola/Private/Common/AbstractInteractor.cpp (lines 109-120)

GetSanitizedId

virtual FString GetSanitizedId() const const

Get the label of this Interactor, sanitized to remove characters that can cause issues (e.g.

’.’

Returns: The ID with invalid characters replaced or removed

Returns: FString

Attributes: const, virtual

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 60, column 17)

Implementation: Schola/Source/Schola/Private/Common/AbstractInteractor.cpp (lines 122-127)

GetLocation

UObject * GetLocation() const const

Get an Outer for this object that is unique w.r.t the agent for getting the ID.

Returns: a UObject ptr to an owning object in the heirarchy

Note: If the UObject is inside a Controller returns the controller. If the UObject is inside a Component return the owner of the component.

Returns: UObject *

Attributes: const

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 68, column 9)

Implementation: Schola/Source/Schola/Private/Common/AbstractInteractor.cpp (lines 59-84)

Reset

inline virtual void Reset()

Internal function called when an episode ends, Does any preparation required for the next episode.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 73, column 14)

Public Members:

bool bUseCustomId

bool bUseCustomId = = false

Replace the Autogenerated ID from GenerateID with the String ID here.

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 28, column 6)

FString CustomId

FString CustomId = = FString()

Replace the Autogenerated ID from GenerateID with the String ID here.

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 32, column 9)

Protected Interface

Protected Functions:

GenerateId

virtual FString GenerateId() const const

Returns: FString

Attributes: const, virtual

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 22, column 17)

Implementation: Schola/Source/Schola/Private/Common/AbstractInteractor.cpp (lines 129-132)

Used By: UAbstractObserver, UActuator

Source: Schola/Source/Schola/Public/Common/AbstractInteractor.h (line 16, column 1)