Skip to content

ISingleAgentImitationScholaEnvironment

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.

Subclassed by AImitationPlayerController

class ISingleAgentImitationScholaEnvironment
    : public IBaseImitationScholaEnvironment

Methods

InitializeEnvironment

void InitializeEnvironment(FInteractionDefinition &OutAgentDefinition)

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

Parameters

  • OutAgentDefinition (FInteractionDefinition)

SeedEnvironment

void SeedEnvironment(int InSeed)

Set the random seed for reproducible environment behavior.

Parameters

  • InSeed (int)

SetEnvironmentOptions

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

Configure environment-specific options.

Parameters

  • InOptions (const TMap<FString, FString>)

Reset

void Reset(FInitialAgentState &OutAgentState)

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

Parameters

  • OutAgentState (FInitialAgentState)

Step

void Step(FImitationAgentState &OutAgentState)

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

Parameters

  • OutAgentState (FImitationAgentState)

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 (UObject)

  • OutAgentDefinitions (TMap<FString, FInteractionDefinition>)

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 (UObject)

  • OutAgentState (TMap<FString, FInitialAgentState>)

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 (UObject)

  • OutAgentStates (TMap<FString, FImitationAgentState>)

Source: Source/ScholaImitation/Public/Environment/SingleAgentImitationEnvironmentInterface.h