Class ISingleAgentImitationScholaEnvironment

Class ISingleAgentImitationScholaEnvironment

• Defined in File SingleAgentImitationEnvironmentInterface.h

Inheritance Relationships

Base Type

• public IBaseImitationScholaEnvironment (Class IBaseImitationScholaEnvironment)

class ISingleAgentImitationScholaEnvironment
    : public IBaseImitationScholaEnvironment

Source: Source/Schola/Imitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h

Dependencies: FImitationAgentState, FInitialAgentState, FInteractionDefinition

Native interface for single-agent imitation learning environments.

Provides the contract for environments that manage a single agent. Includes compatibility methods to bridge single-agent and multi-agent APIs.

---

Public Functions

Symbol	Details
InitializeEnvironment	Initialize the environment and define the agent’s interaction space.
SeedEnvironment	Set the random seed for reproducible environment behavior.
SetEnvironmentOptions	Configure environment-specific options.
Reset	Reset the environment and return the agent’s initial state.
Step	Execute one environment step and return the agent’s imitation state.

InitializeEnvironment

void InitializeEnvironment(FInteractionDefinition &OutAgentDefinition)

Initialize the environment and define the agent’s interaction space.

Parameters

OutAgentDefinition – [out] The agent’s interaction definition (observation/action spaces)

#	Direction	Name	Type	Description
1	—	OutAgentDefinition	FInteractionDefinition &	The agent’s interaction definition (observation/action spaces)

Source: Source/Schola/Imitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h

SeedEnvironment

void SeedEnvironment(int InSeed)

Set the random seed for reproducible environment behavior.

Parameters

InSeed – [in] The random seed value

#	Direction	Name	Type	Description
1	—	InSeed	int	The random seed value

Source: Source/Schola/Imitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h

SetEnvironmentOptions

void SetEnvironmentOptions(const TMap<FString, FString> &InOptions)

Configure environment-specific options.

Parameters

InOptions – [in] Map of option names to their string values

#	Direction	Name	Type	Description
1	—	InOptions	const TMap< FString, FString > &	Map of option names to their string values

Source: Source/Schola/Imitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h

Reset

void Reset(FInitialAgentState &OutAgentState)

Reset the environment and return the agent’s initial state.

Parameters

OutAgentState – [out] The agent’s initial state

#	Direction	Name	Type	Description
1	—	OutAgentState	FInitialAgentState &	The agent’s initial state

Source: Source/Schola/Imitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h

Step

void Step(FImitationAgentState &OutAgentState)

Execute one environment step and return the agent’s imitation state.

Parameters

OutAgentState – [out] The agent’s imitation state (observations, expert actions, rewards)

#	Direction	Name	Type	Description
1	—	OutAgentState	FImitationAgentState &	The agent’s imitation state (observations, expert actions, rewards)

Source: Source/Schola/Imitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h

---

Public Static Functions

Symbol	Details
Execute_InitializeEnvironment	Compatibility wrapper to adapt single-agent InitializeEnvironment to multi-agent API.
Execute_Reset	Compatibility wrapper to adapt single-agent Reset to multi-agent API.
Execute_Step	Compatibility wrapper to adapt single-agent Step to multi-agent API.

Execute_InitializeEnvironment

static inline void Execute_InitializeEnvironment(
    UObject *Obj, TMap<FString, FInteractionDefinition> &OutAgentDefinitions)

Compatibility wrapper to adapt single-agent InitializeEnvironment to multi-agent API.

Parameters

• Obj – [in] The environment object

• OutAgentDefinitions – [out] Map populated with a “SingleAgent” entry

#	Direction	Name	Type	Description
1	—	Obj	UObject *	The environment object
2	—	OutAgentDefinitions	TMap< FString, FInteractionDefinition > &	Map populated with a “SingleAgent” entry

Attributes: inline, static

Source: Source/Schola/Imitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h

Execute_Reset

static inline void
Execute_Reset(UObject *Obj, TMap<FString, FInitialAgentState> &OutAgentState)

Compatibility wrapper to adapt single-agent Reset to multi-agent API.

Parameters

• Obj – [in] The environment object

• OutAgentState – [out] Map populated with a “SingleAgent” entry

#	Direction	Name	Type	Description
1	—	Obj	UObject *	The environment object
2	—	OutAgentState	TMap< FString, FInitialAgentState > &	Map populated with a “SingleAgent” entry

Attributes: inline, static

Source: Source/Schola/Imitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h

Execute_Step

static inline void
Execute_Step(UObject *Obj, TMap<FString, FImitationAgentState> &OutAgentStates)

Compatibility wrapper to adapt single-agent Step to multi-agent API.

Parameters

• Obj – [in] The environment object

• OutAgentStates – [out] Map populated with a “SingleAgent” entry

#	Direction	Name	Type	Description
1	—	Obj	UObject *	The environment object
2	—	OutAgentStates	TMap< FString, FImitationAgentState > &	Map populated with a “SingleAgent” entry

Attributes: inline, static

Source: Source/Schola/Imitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h