From 6090344a00159d84ccb31519003e182618de5476 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Santos-Oliv=C3=A1n?= Date: Wed, 14 Jul 2021 10:42:41 +0200 Subject: [PATCH] Update docs Added PythonAPI methods: - show_debug_telemetry() - ApplyVehiclePhysicsControl command --- PythonAPI/docs/actor.yml | 8 ++++++++ PythonAPI/docs/commands.yml | 27 +++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/PythonAPI/docs/actor.yml b/PythonAPI/docs/actor.yml index 7bfd4861a..664ad128b 100644 --- a/PythonAPI/docs/actor.yml +++ b/PythonAPI/docs/actor.yml @@ -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/s2 diff --git a/PythonAPI/docs/commands.yml b/PythonAPI/docs/commands.yml index f9edf58fe..f9adcd88c 100644 --- a/PythonAPI/docs/commands.yml +++ b/PythonAPI/docs/commands.yml @@ -90,6 +90,33 @@ Actor or its ID to whom the command will be applied to. # -------------------------------------- + - class_name: ApplyVehiclePhysicsControl + # - DESCRIPTION ------------------------ + doc: > + Command adaptation of __apply_physics_control()__ 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: >