unreal.PlanarVelocityAction

class unreal.PlanarVelocityAction(outer: Object | None = None, name: Name | str = 'None')

Bases: LearningAgentsAction

A planar velocity action.

C++ Source:

  • Plugin: LearningAgents

  • Module: LearningAgents

  • File: LearningAgentsActions.h

Editor Properties: (see get_editor_property/set_editor_property)

  • interactor (LearningAgentsInteractor): [Read-Only] Reference to the Interactor this action is associated with.

classmethod add_planar_velocity_action(interactor, name='None', scale=200.000000, axis0=[1.000000, 0.000000, 0.000000], axis1=[0.000000, 1.000000, 0.000000]) → PlanarVelocityAction

Adds a new planar velocity action to the given agent interactor. The axis parameters define the plane. Call during ULearningAgentsInteractor::SetupActions event.

Parameters:

  • interactor (LearningAgentsInteractor) – The agent interactor to add this action to.

  • name (Name) – The name of this new action. Used for debugging.

  • scale (float) – Used to normalize the data for the action.

  • axis0 (Vector) – The forward axis of the plane.

  • axis1 (Vector) – The right axis of the plane.

Returns:

The newly created action.

Return type:

PlanarVelocityAction

get_planar_velocity_action(agent_id=-1) → Vector

Gets the data for this action. Call during ULearningAgentsInteractor::GetActions event.

Parameters:

agent_id (int32) – The agent id to get data for.

Returns:

The current action value.

Return type:

Vector

set_planar_velocity_action(agent_id=-1, velocity) → None

Sets the data for this action. Call during ULearningAgentsController::SetActions event.

Parameters:

  • agent_id (int32) – The agent id this data corresponds to.

  • velocity (Vector) – The velocity currently being observed.