Update docs

Added PythonAPI methods:
 - show_debug_telemetry()
 - ApplyVehiclePhysicsControl command
This commit is contained in:
Daniel Santos-Oliván 2021-07-14 10:42:41 +02:00 committed by bernat
parent a2c4cc5ffd
commit 6090344a00
2 changed files with 35 additions and 0 deletions

View File

@ -133,6 +133,14 @@
warning: >
Enabling a constant velocity for a vehicle managed by the [Traffic Manager](https://carla.readthedocs.io/en/latest/adv_traffic_manager/) may cause conflicts. This method overrides any changes in velocity by the TM.
# --------------------------------------
- def_name: enable_debug_telemetry
params:
- param_name: enabled
type: bool
default: True
doc: >
Enables or disables the telemetry on this vehicle. This shows information about the vehicles current state and forces applied to it in the spectator window. Only information for one vehicle can be shown so if you enable a second one, the previous will be automatically disabled.
# --------------------------------------
- def_name: get_acceleration
return: carla.Vector3D
return_units: m/s<sup>2</sup>

View File

@ -90,6 +90,33 @@
Actor or its ID to whom the command will be applied to.
# --------------------------------------
- class_name: ApplyVehiclePhysicsControl
# - DESCRIPTION ------------------------
doc: >
Command adaptation of __<font color="#7fb800">apply_physics_control()</font>__ in carla.Vehicle. Applies a new physics control to a vehicle,
modifying its physical parameters.
# - PROPERTIES -------------------------
instance_variables:
- var_name: actor_id
type: int
doc: >
Vehicle actor affected by the command.
- var_name: control
type: carla.VehiclePhysicsControl
doc: >
Physics control to be applied.
# - METHODS ----------------------------
methods:
- def_name: __init__
params:
- param_name: actor
type: carla.Actor or int
doc: >
Actor or its ID to whom the command will be applied to.
- param_name: control
type: carla.VehiclePhysicsControl
# --------------------------------------
- class_name: ApplyVehicleControl
# - DESCRIPTION ------------------------
doc: >