unreal.VelocityArrayObservation

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

Bases: LearningAgentsObservation

An observation of an array of velocities.

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_velocity_array_observation(interactor, name='None', velocity_num=1, scale=200.000000) → VelocityArrayObservation

Adds a new 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:

VelocityArrayObservation

set_velocity_array_observation(agent_id=-1, velocities, relative_rotation=[0.000000, 0.000000, 0.000000]) → None

Sets the data for this observation. The relative rotation can be used to make this observation relative to the agent’s perspective, e.g. by passing the agent’s forward rotation. Call during ULearningAgentsInteractor::SetObservations event.

Parameters:

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

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

  • relative_rotation (Rotator) – The frame of reference rotation.