Class UManualGymConnector

Class UManualGymConnector

• Defined in File ManualGymConnector.h

Inheritance Relationships

Base Type

• public UAbstractGymConnector (Class UAbstractGymConnector)

class UManualGymConnector : public UAbstractGymConnector

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

Dependencies: FInitialState, FPoint, FTrainingDefinition, FTrainingState, FTrainingStateUpdate

Manual gym connector for testing and debugging without external training processes.

Provides a gym connector interface that can be controlled directly from C++ or Blueprint. Useful for testing environment implementations or creating custom training loops in Unreal.

---

Public Functions

Symbol	Details
UManualGymConnector	Constructor for the manual gym connector.
Init	Initialize the connector (no-op for manual connector).
SubmitState	Submit state (no-op for manual connector).
SubmitStateWithInitialState	Submit state with initial state (no-op for manual connector).
SubmitInitialState	Submit initial state (no-op for manual connector).
ResolveEnvironmentStateUpdate	Resolve the next environment state update.
CheckForStart	Check if the connector is ready to start.
ManualStep	Manually execute a step with the given actions.
ManualReset	Manually reset specified environments with optional seeds and options.
Close	Close the connector and stop processing.
GetAutoResetType	Get the auto-reset behavior for this connector.

UManualGymConnector

inline UManualGymConnector()

Constructor for the manual gym connector.

Initializes with default values.

Attributes: inline

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

Init

inline virtual void Init(const FTrainingDefinition &AgentDefinitions)

Initialize the connector (no-op for manual connector).

Parameters

AgentDefinitions – [in] The training definitions.

#	Direction	Name	Type	Description
1	—	AgentDefinitions	const FTrainingDefinition &	The training definitions.

Attributes: inline, virtual

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

SubmitState

inline virtual void SubmitState(const FTrainingState &InTrainingState)

Submit state (no-op for manual connector).

Parameters

InTrainingState – [in] The training state to submit.

#	Direction	Name	Type	Description
1	—	InTrainingState	const FTrainingState &	The training state to submit.

Attributes: inline, virtual

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

SubmitStateWithInitialState

inline virtual void
SubmitStateWithInitialState(const FTrainingState &InTrainingState,
                            const FInitialState &InInitialAgentStates)

Submit state with initial state (no-op for manual connector).

Parameters

• InTrainingState – [in] The training state to submit.

• InInitialAgentStates – [in] The initial states to submit.

#	Direction	Name	Type	Description
1	—	InTrainingState	const FTrainingState &	The training state to submit.
2	—	InInitialAgentStates	const FInitialState &	The initial states to submit.

Attributes: inline, virtual

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

SubmitInitialState

inline virtual void
SubmitInitialState(const FInitialState &InInitialAgentStates)

Submit initial state (no-op for manual connector).

Parameters

InInitialAgentStates – [in] The initial states to submit.

#	Direction	Name	Type	Description
1	—	InInitialAgentStates	const FInitialState &	The initial states to submit.

Attributes: inline, virtual

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

ResolveEnvironmentStateUpdate

inline virtual FTrainingStateUpdate *ResolveEnvironmentStateUpdate()

Resolve the next environment state update.

Returns:

Pointer to the NextUpdate member set via ManualStep or ManualReset.

Attributes: inline, virtual

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

CheckForStart

inline virtual bool CheckForStart()

Check if the connector is ready to start.

Returns:

Always returns true for manual connectors.

Attributes: inline, virtual

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

ManualStep

inline void
ManualStep(const TArray<TMap<FString, TInstancedStruct<FPoint>>> &InActions,
           FInitialState &OutInitialState, FTrainingState &OutTrainingState)

Manually execute a step with the given actions.

Parameters

• InActions – [in] Array of action maps (one per environment), each mapping agent IDs to actions.

• OutInitialState – [out] The initial states for any environments that reset.

• OutTrainingState – [out] The resulting training state after the step.

#	Direction	Name	Type	Description
1	—	InActions	const TArray< TMap< FString, TInstancedStruct< FPoint > > > &	Array of action maps (one per environment), each mapping agent IDs to actions.
2	—	OutInitialState	FInitialState &	The initial states for any environments that reset.
3	—	OutTrainingState	FTrainingState &	The resulting training state after the step.

Attributes: inline

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

ManualReset

inline void ManualReset(const TMap<int, int> &Seeds,
                        const TMap<int, TMap<FString, FString>> &OutEnvOptions,
                        FInitialState &OutInitialState)

Manually reset specified environments with optional seeds and options.

Parameters

• Seeds – [in] Map of environment IDs to random seeds.

• OutEnvOptions – [in] Map of environment IDs to their configuration options.

• OutInitialState – [out] The initial states after reset.

#	Direction	Name	Type	Description
1	—	Seeds	const TMap< int, int > &	Map of environment IDs to random seeds.
2	—	OutEnvOptions	const TMap< int, TMap< FString, FString > > &	Map of environment IDs to their configuration options.
3	—	OutInitialState	FInitialState &	The initial states after reset.

Attributes: inline

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

Close

inline void Close()

Close the connector and stop processing.

Attributes: inline

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

GetAutoResetType

inline virtual EAutoResetType GetAutoResetType()

Get the auto-reset behavior for this connector.

Returns:

The configured auto-reset type.

Attributes: inline, virtual

Source: Source/Schola/Training/Public/GymConnectors/ManualGymConnector.h

---

Public Members

Symbol	Details
AutoResetType	The auto-reset behavior for this connector.
NextUpdate	The next update to be applied (set via ManualStep or ManualReset).

---

AutoResetType

EAutoResetType AutoResetType = EAutoResetType::SameStep

The auto-reset behavior for this connector.

---

NextUpdate

FTrainingStateUpdate NextUpdate = FTrainingStateUpdate()

The next update to be applied (set via ManualStep or ManualReset).