Skip to content

FEnvUpdate

struct FEnvUpdate

A Struct representing an update to an environment in the form of either a reset or step.

Dependencies: FEnvReset, FEnvStep

Public Interface

Constructors:

FEnvUpdate

inline FEnvUpdate()

Construct a new default FEnvUpdate object.

Attributes: inline

Source: Schola/Source/Schola/Public/Training/UpdateStructs/EnvironmentUpdate.h (line 57, column 1)

FEnvUpdate

inline FEnvUpdate(FEnvStep &EnvStep)

Construct a new step FEnvUpdate object.

Parameters:

  • EnvStep (FEnvStep &) – [in] The step to create the object from

Attributes: inline

Source: Schola/Source/Schola/Public/Training/UpdateStructs/EnvironmentUpdate.h (line 66, column 1)

FEnvUpdate

inline FEnvUpdate(FEnvReset &EnvReset)

Construct a new reset FEnvUpdate object.

Parameters:

  • EnvReset (FEnvReset &) – [in] The reset to create the object from

Attributes: inline

Source: Schola/Source/Schola/Public/Training/UpdateStructs/EnvironmentUpdate.h (line 76, column 1)

Public Functions:

IsReset

inline bool IsReset() const const

Check if the update is a reset.

Returns: true iff the update is a reset

Returns: bool

Attributes: const, inline

Source: Schola/Source/Schola/Public/Training/UpdateStructs/EnvironmentUpdate.h (line 85, column 6)

IsStep

inline bool IsStep() const const

Check if the update is a step.

Returns: true iff the update is a step

Returns: bool

Attributes: const, inline

Source: Schola/Source/Schola/Public/Training/UpdateStructs/EnvironmentUpdate.h (line 94, column 6)

GetStep

inline const FEnvStep & GetStep() const const

Get the step contained in the update.

Returns: The step contained in the update

Returns: const FEnvStep &

Attributes: const, inline

Source: Schola/Source/Schola/Public/Training/UpdateStructs/EnvironmentUpdate.h (line 103, column 16)

GetReset

inline const FEnvReset & GetReset() const const

Get the reset contained in the update.

Returns: The reset contained in the update

Returns: const FEnvReset &

Attributes: const, inline

Source: Schola/Source/Schola/Public/Training/UpdateStructs/EnvironmentUpdate.h (line 112, column 17)

Public Members:

TVariant<FEnvReset, FEnvStep> Update

TVariant<FEnvReset, FEnvStep> Update

A variant containing either a reset or a step.

Source: Schola/Source/Schola/Public/Training/UpdateStructs/EnvironmentUpdate.h (line 52, column 10)

Used By: FTrainingStateUpdate, ProtobufDeserializer

Source: Schola/Source/Schola/Public/Training/UpdateStructs/EnvironmentUpdate.h (line 48, column 1)