unreal.ScalarVelocityArrayObservation

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

Bases: LearningAgentsObservation

An observation of an array of velocities along a single axis.

C++ Source:

  • Plugin: LearningAgents

  • Module: LearningAgents

  • File: LearningAgentsObservations.h

Editor Properties: (see get_editor_property/set_editor_property)

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

classmethod add_scalar_velocity_array_observation(interactor, name='None', velocity_num=1, scale=200.000000) → ScalarVelocityArrayObservation

Adds a new scalar velocity observation to the given agent interactor. Call during ULearningAgentsInteractor::SetupObservations event.

Parameters:

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

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

  • velocity_num (int32) – The number of velocities in the array.

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

Returns:

The newly created observation.

Return type:

ScalarVelocityArrayObservation

set_scalar_velocity_array_observation(agent_id=-1, velocities) → None

Sets the data for this observation. Call during ULearningAgentsInteractor::SetObservations event.

Parameters:

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

  • velocities (Array[float]) – The velocities currently being observed.

set_scalar_velocity_array_observation_with_axis(agent_id=-1, velocities, axis=[0.000000, 0.000000, 1.000000]) → None

Sets the data for this observation. Call during ULearningAgentsInteractor::SetObservations event.

Parameters:

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

  • velocities (Array[Vector]) – The velocities currently being observed.

  • axis (Vector) – The axis to encode the velocity along