Navigation
API > API/Plugins > API/Plugins/LearningAgentsTraining > API/Plugins/LearningAgentsTraining/ULearningAgentsRewards
References
| Module | LearningAgentsTraining |
| Header | /Engine/Plugins/Experimental/LearningAgents/Source/LearningAgentsTraining/Public/LearningAgentsRewards.h |
| Include | #include "LearningAgentsRewards.h" |
| Source | /Engine/Plugins/Experimental/LearningAgents/Source/LearningAgentsTraining/Private/LearningAgentsRewards.cpp |
UFUNCTION (BlueprintPure, Category="LearningAgents",
Meta=(AdvancedDisplay=6, DefaultToSelf="VisualLoggerListener"))
static float MakeRewardFromVelocityAlongSpline
(
const USplineComponent * SplineComponent,
const FVector Location,
const FVector Velocity,
const float VelocityScale,
const float RewardScale,
const float FiniteDifferenceDelta,
const FName Tag,
const bool bVisualLoggerEnabled,
ULearningAgentsManagerListener * VisualLoggerListener,
const int32 VisualLoggerAgentId,
const FVector VisualLoggerLocation,
const FLinearColor VisualLoggerColor
)
Remarks
Make a reward based on the velocity an object is moving along a spline. The resulting reward value.
Parameters
| Name | Description |
|---|---|
| SplineComponent | The spline. |
| Location | The location of the object. |
| Velocity | The velocity of the object. |
| VelocityScale | The expected scale for the velocity. |
| RewardScale | The scale of the reward. Use a negative scale to create a penalty. |
| FiniteDifferenceDelta | The finite difference to use when computing the velocity along the spline. |
| Tag | The tag for the reward. Used for debugging. |
| bVisualLoggerEnabled | When true, debug data will be sent to the visual logger. |
| VisualLoggerListener | The listener object which is making this reward. This must be set to use logging. |
| VisualLoggerAgentId | The agent id associated with this reward. |
| VisualLoggerLocation | A location for the visual logger information in the world. |
| VisualLoggerColor | The color for the visual logger display. |