Skip to content

UMovementInputActuator

class UMovementInputActuator : public UBoxActuator

Dependencies: FBoxPoint, FBoxSpace, UBoxActuator

Inherits from: public UBoxActuator

Public Interface

Public Functions:

GetActionSpace

virtual FBoxSpace GetActionSpace() override

Get the Space bounding the inputs to this actuator.

Returns: BoxSpace containing the bounds of the inputs to this actuator

Note: This function must be implemented in the derived class.

Returns: FBoxSpace

Attributes: virtual

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 54, column 11)

Implementation: Schola/Source/Schola/Private/Actuators/MovementInputActuator.cpp (lines 5-23)

ConvertActionToFVector

FVector ConvertActionToFVector(const FBoxPoint &Action)

Convert a Box Point with 3 values to an FVector.

Returns: FVector containing the converted BoxPoint

Parameters:

  • Action (const FBoxPoint &) – [in] BoxPoint that will be converted

Returns: FVector

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 61, column 9)

Implementation: Schola/Source/Schola/Private/Actuators/MovementInputActuator.cpp (lines 25-48)

TakeAction

virtual void TakeAction(const FBoxPoint &Action) override

Use this actuator to take an action impacting the world.

Note: This function must be implemented in the derived class.

Parameters:

  • Action (const FBoxPoint &) – [in] BoxPoint containing the inputs to this actuator

Attributes: virtual

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 63, column 6)

Implementation: Schola/Source/Schola/Private/Actuators/MovementInputActuator.cpp (lines 50-67)

GenerateId

virtual FString GenerateId() const override const

Returns: FString

Attributes: const, virtual

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 65, column 9)

Implementation: Schola/Source/Schola/Private/Actuators/MovementInputActuator.cpp (lines 69-86)

Public Members:

bool bHasXDimension

bool bHasXDimension = = true

Toggle for whether this actuator moves the Agent along the X dimension.

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 24, column 6)

bool bHasZDimension

bool bHasZDimension = = true

Toggle for whether this actuator moves the Agent along the Z dimension.

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 28, column 6)

bool bHasYDimension

bool bHasYDimension = = true

Toggle for whether this actuator moves the Agent along the Y dimension.

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 32, column 6)

float MinSpeed

float MinSpeed = = 0.0

The minimum speed at which the agent can move.

Set to negative to allow for backwards movement along each axis.

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 36, column 7)

float MaxSpeed

float MaxSpeed = = 1.0

The maximum speed at which the agent can move.

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 40, column 7)

FOnMovementInputSignature OnMovementDelegate

FOnMovementInputSignature OnMovementDelegate

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

Useful for debugging and logging

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 44, column 27)

float ScaleValue

float ScaleValue = = 1

Scale to apply input.

See AddMovementInput for more details.

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 48, column 7)

bool bForce

bool bForce = = false

Force the Pawn to Move.

See AddMovementInput for more details.

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 52, column 6)

Source: Schola/Source/Schola/Public/Actuators/MovementInputActuator.h (line 17, column 1)