Skip to content

UTeleportActuator

class UTeleportActuator : public UDiscreteActuator

Dependencies: FDiscretePoint, FDiscreteSpace, UDiscreteActuator

Inherits from: public UDiscreteActuator

Public Interface

Public Functions:

GetActionSpace

virtual FDiscreteSpace GetActionSpace() override

Get the Space bounding the inputs to this actuator.

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

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

Returns: FDiscreteSpace

Attributes: virtual

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 61, column 16)

Implementation: Schola/Source/Schola/Private/Actuators/TeleportActuator.cpp (lines 5-26)

ConvertActionToFVector

FVector ConvertActionToFVector(const FDiscretePoint &Action)

Convert a Discrete Point with 3 values to an FVector.

Returns: FVector containing the converted DiscretePoint

Parameters:

  • Action (const FDiscretePoint &) – [in] DiscretePoint that will be converted

Returns: FVector

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 68, column 9)

Implementation: Schola/Source/Schola/Private/Actuators/TeleportActuator.cpp (lines 28-46)

GetVectorDimension

float GetVectorDimension(int Speed, int DiscretePointValue)

Get the magnitude of movement based on the value of a singular.

Returns: The magnitude of the movement, multiplied by the direction

Parameters:

  • Speed (int) – [in] The speed of the teleportaiton Actuator
  • DiscretePointValue (int) – [in] The value of the DiscretePoint, to check for forward, backward, or no movement

Returns: float

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 76, column 7)

Implementation: Schola/Source/Schola/Private/Actuators/TeleportActuator.cpp (lines 48-63)

TakeAction

virtual void TakeAction(const FDiscretePoint &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 FDiscretePoint &) – [in] DiscretePoint containing the inputs to this actuator

Attributes: virtual

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 78, column 6)

Implementation: Schola/Source/Schola/Private/Actuators/TeleportActuator.cpp (lines 65-80)

GenerateId

virtual FString GenerateId() const override const

Returns: FString

Attributes: const, virtual

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 80, column 9)

Implementation: Schola/Source/Schola/Private/Actuators/TeleportActuator.cpp (lines 82-102)

Public Members:

float XDimensionSpeed

float XDimensionSpeed

The distance this agent teleports in the X dimension.

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 27, column 7)

float YDimensionSpeed

float YDimensionSpeed

The distance this agent teleports in the Y dimension.

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 31, column 7)

float ZDimensionSpeed

float ZDimensionSpeed

The distance this agent teleports in the Z dimension.

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 35, column 7)

bool bHasXDimension

bool bHasXDimension = = true

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

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 39, column 6)

bool bHasZDimension

bool bHasZDimension = = true

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

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 43, column 6)

bool bHasYDimension

bool bHasYDimension = = true

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

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 47, column 6)

FOnTeleportSignature OnTeleportDelegate

FOnTeleportSignature OnTeleportDelegate

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

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 51, column 22)

ETeleportType TeleportType

ETeleportType TeleportType = = ETeleportType::None

Type of teleportation to use.

See SetActorLocation documentation for more details.

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 55, column 15)

bool bSweep

bool bSweep

Toggle for whether to sweep while teleporting the actor.

See SetActorLocation documentation for more details

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 59, column 6)

Source: Schola/Source/Schola/Public/Actuators/TeleportActuator.h (line 21, column 1)