Skip to content

IScholaActuator

Interface for actuator components that receive and execute agent actions.

This interface provides methods for defining the action space and processing actions from reinforcement learning agents. Can be implemented in both C++ and Blueprints.

Subclassed by UMovementInputActuator, URotationActuator, UTeleportActuator

class IScholaActuator

Methods

InitActuator

void InitActuator()

Initialize the actuator component.

InitActuator_Implementation

inline virtual void InitActuator_Implementation()

Default implementation of InitActuator (no-op).

GetActionSpace

void GetActionSpace(FInstancedStruct &OutActionSpace) const

Return the actuator definition (the action space) as an instanced FSpace struct.

Parameters

  • OutActionSpace (FInstancedStruct)

GetActionSpace_Implementation

inline virtual void
GetActionSpace_Implementation(FInstancedStruct &OutActionSpace) const

Default C++ implementation returns a default box space.

Parameters

  • OutActionSpace (FInstancedStruct)

TakeAction

void TakeAction(const FInstancedStruct &InAction)

Apply an action to the actuator provided as an instanced FPoint struct.

Parameters

  • InAction (const FInstancedStruct)

TakeAction_Implementation

inline virtual void TakeAction_Implementation(const FInstancedStruct &InAction)

Default C++ implementation is a no-op.

Parameters

  • InAction (const FInstancedStruct)

Execute_GetActionSpace

static inline void
Execute_GetActionSpace(const UObject *Obj,
                       TInstancedStruct<FSpace> &OutActionSpace)

Static helper to execute GetActionSpace with typed parameters.

Parameters

  • Obj (const UObject)

  • OutActionSpace (TInstancedStruct<FSpace>)

Execute_TakeAction

static inline void Execute_TakeAction(UObject *Obj,
                                      const TInstancedStruct<FPoint> &InAction)

Static helper to execute TakeAction with typed parameters.

Parameters

  • Obj (UObject)

  • InAction (const TInstancedStruct<FPoint>)

Source: Source/ScholaInteractors/Public/ActuatorInterface.h