Skip to content

UAbstractEnvironmentUtilityComponent

class UAbstractEnvironmentUtilityComponent : public UActorComponent

An Abstract Base class for an ActorComponent that provides utility functions for an environment.

Dependencies: FTrainerState

Inherits from: public UActorComponent

Subclassed by: UBlueprintEnvironmentUtilityComponent

Public Interface

Public Functions:

OnEnvironmentStep

inline virtual void OnEnvironmentStep(int AgentID, FTrainerState &State)

Callback for when an agent takes a step in the environment.

Parameters:

  • AgentID (int) – [in] The ID of the agent that took the step.
  • State (FTrainerState &) – [in] The state of the agent after taking the step.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Environment/EnvironmentComponents/AbstractEnvironmentUtilityComponent.h (line 24, column 14)

OnEnvironmentReset

inline virtual void OnEnvironmentReset()

Callback for when the environment is reset.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Environment/EnvironmentComponents/AbstractEnvironmentUtilityComponent.h (line 29, column 14)

OnAgentRegister

inline virtual void OnAgentRegister(int AgentID)

Callback for when an agent is registered in the environment.

Parameters:

  • AgentID (int) – [in] The ID of the agent that was registered.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Environment/EnvironmentComponents/AbstractEnvironmentUtilityComponent.h (line 35, column 14)

OnEnvironmentInit

virtual void OnEnvironmentInit(int Id)

Callback for when the environment is initialized.

Parameters:

  • Id (int) – [in] The ID of the environment.

Attributes: virtual

Source: Schola/Source/Schola/Public/Environment/EnvironmentComponents/AbstractEnvironmentUtilityComponent.h (line 41, column 14)

Implementation: Schola/Source/Schola/Private/Environment/EnvironmentComponents/AbstractEnvironmentUtilityComponent.cpp (lines 5-8)

OnEnvironmentEnd

inline virtual void OnEnvironmentEnd()

Callback for when the environment ends.

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Environment/EnvironmentComponents/AbstractEnvironmentUtilityComponent.h (line 46, column 14)

Protected Interface

Protected Members:

int EnvId

int EnvId

The ID of the environment this component is attached to.

Attributes: protected

Source: Schola/Source/Schola/Public/Environment/EnvironmentComponents/AbstractEnvironmentUtilityComponent.h (line 51, column 5)

Used By: AAbstractScholaEnvironment, UBlueprintEnvironmentUtilityComponent

Source: Schola/Source/Schola/Public/Environment/EnvironmentComponents/AbstractEnvironmentUtilityComponent.h (line 14, column 1)