Skip to content

UMovementInputActuator

Movement input actuator that applies continuous movement to a Pawn.

Uses AddMovementInput to apply movement along enabled axes (X, Y, Z). Accepts a BoxPoint action where each dimension corresponds to forward/right/up movement speed.

class UMovementInputActuator : public UActorComponent, public IScholaActuator

Methods

Public

GetActionSpace_Implementation

virtual void
GetActionSpace_Implementation(FInstancedStruct &OutActionSpace) const override

Get the action space for this actuator.

Parameters

  • OutActionSpace (FInstancedStruct)

TakeAction_Implementation

virtual void
TakeAction_Implementation(const FInstancedStruct &InAction) override

Apply an action to this actuator.

Parameters

  • InAction (const FInstancedStruct)

TakeAction

void TakeAction(const FBoxPoint &Action)

Typed convenience method for taking action with a BoxPoint directly.

Parameters

  • Action (const FBoxPoint)

GenerateId

FString GenerateId() const

Generate a unique ID string for this actuator.

Protected

ConvertActionToFVector

FVector ConvertActionToFVector(const FBoxPoint &Action,
                               APawn *&OutOwnerPawn) const

Convert a Box Point to an FVector for movement input.

Parameters

  • Action (const FBoxPoint)

  • OutOwnerPawn (APawn)

Attributes

bHasXDimension

bool bHasXDimension = true

Toggle for whether this actuator moves the Agent along the X dimension (forward/backward)

bHasYDimension

bool bHasYDimension = true

Toggle for whether this actuator moves the Agent along the Y dimension (left/right)

bHasZDimension

bool bHasZDimension = true

Toggle for whether this actuator moves the Agent along the Z dimension (up/down)

MinSpeed

float MinSpeed = 0.0f

The minimum speed at which the agent can move.

MaxSpeed

float MaxSpeed = 1.0f

The maximum speed at which the agent can move.

ScaleValue

float ScaleValue = 1.0f

Scale to apply to input.

bForce

bool bForce = false

Force the Pawn to move.

OnMovementDelegate

FOnMovementInputSignature OnMovementDelegate

A delegate invoked when this actuator receives input from a brain.

Source: Source/ScholaInteractors/Public/Actuators/MovementInputActuator.h