Class IScholaActuator

Defined in File ActuatorInterface.h

Inheritance Relationships

Derived Types

public UMovementInputActuator (Class UMovementInputActuator)
public URotationActuator (Class URotationActuator)
public UTeleportActuator (Class UTeleportActuator)

class IScholaActuator

Source: Source/Schola/Interactors/Public/ActuatorInterface.h

Dependencies: FPoint, FSpace

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

Public Functions

Symbol	Details
`InitActuator`	Initialize the actuator component.
`InitActuator_Implementation`	Default implementation of InitActuator (no-op).
`GetActionSpace`	Return the actuator definition (the action space) as an instanced FSpace struct.
`GetActionSpace_Implementation`	Default C++ implementation returns a default box space.
`TakeAction`	Apply an action to the actuator provided as an instanced FPoint struct.
`TakeAction_Implementation`	Default C++ implementation is a no-op.

InitActuator

void InitActuator()

Initialize the actuator component.

Called once to set up the actuator. Override this method to perform any necessary initialization such as caching references or validating configuration.

Source: Source/Schola/Interactors/Public/ActuatorInterface.h

InitActuator_Implementation

inline virtual void InitActuator_Implementation()

Default implementation of InitActuator (no-op).

Attributes: inline, virtual

Source: Source/Schola/Interactors/Public/ActuatorInterface.h

GetActionSpace

void GetActionSpace(FInstancedStruct &OutActionSpace) const

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

This method defines what actions are valid for this actuator. The returned space describes the structure, dimensionality, and bounds of the action space. BlueprintNativeEvent so Blueprints can override; C++ classes can implement the _Implementation.

Parameters

OutActionSpace – [out] The action space definition to be populated

#	Direction	Name	Type	Description
1	—	`OutActionSpace`	`FInstancedStruct &`	The action space definition to be populated

Attributes: const

Source: Source/Schola/Interactors/Public/ActuatorInterface.h

GetActionSpace_Implementation

inline virtual void
GetActionSpace_Implementation(FInstancedStruct &OutActionSpace) const

Default C++ implementation returns a default box space.

Parameters

OutActionSpace – [out] The action space definition to be populated

#	Direction	Name	Type	Description
1	—	`OutActionSpace`	`FInstancedStruct &`	The action space definition to be populated

Attributes: inline, const, virtual

Source: Source/Schola/Interactors/Public/ActuatorInterface.h

TakeAction

void TakeAction(const FInstancedStruct &InAction)

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

This method receives an action from a brain/policy and applies it to the environment. The action format must match the action space returned by GetActionSpace. BlueprintNativeEvent so Blueprints can override; C++ classes can implement the _Implementation.

Parameters

InAction – [in] The action to apply, must be compatible with this actuator’s action space

#	Direction	Name	Type	Description
1	—	`InAction`	`const FInstancedStruct &`	The action to apply, must be compatible with this actuator’s action space

Source: Source/Schola/Interactors/Public/ActuatorInterface.h

TakeAction_Implementation

inline virtual void TakeAction_Implementation(const FInstancedStruct &InAction)

Default C++ implementation is a no-op.

Parameters

InAction – [in] The action to apply (unused in default implementation)

#	Direction	Name	Type	Description
1	—	`InAction`	`const FInstancedStruct &`	The action to apply (unused in default implementation)

Attributes: inline, virtual

Source: Source/Schola/Interactors/Public/ActuatorInterface.h

Public Static Functions

Symbol	Details
`Execute_GetActionSpace`	Static helper to execute GetActionSpace with typed parameters.
`Execute_TakeAction`	Static helper to execute TakeAction with typed parameters.

Execute_GetActionSpace

static inline void
Execute_GetActionSpace(const UObject *Obj,
                       TInstancedStruct&lt;FSpace&gt; &OutActionSpace)

Static helper to execute GetActionSpace with typed parameters.

Parameters

Obj – [in] The object implementing this interface
OutActionSpace – [out] The action space to be populated

#	Direction	Name	Type	Description
1	—	`Obj`	`const UObject *`	The object implementing this interface
2	—	`OutActionSpace`	`TInstancedStruct< FSpace > &`	The action space to be populated

Attributes: inline, static

Source: Source/Schola/Interactors/Public/ActuatorInterface.h

Execute_TakeAction

static inline void Execute_TakeAction(UObject *Obj,
                                      const TInstancedStruct&lt;FPoint&gt; &InAction)

Static helper to execute TakeAction with typed parameters.

Parameters

Obj – [inout] The object implementing this interface
InAction – [in] The action to apply

#	Direction	Name	Type	Description
1	—	`Obj`	`UObject *`	The object implementing this interface
2	—	`InAction`	`const TInstancedStruct< FPoint > &`	The action to apply

Attributes: inline, static

Source: Source/Schola/Interactors/Public/ActuatorInterface.h