From fd8d6122dd92cac7782a998b6712a9ccd9cc3149 Mon Sep 17 00:00:00 2001 From: Daniel Date: Wed, 24 Jul 2024 18:16:23 +0200 Subject: [PATCH] Apply changes to .md output --- Docs/python_api.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/Docs/python_api.md b/Docs/python_api.md index faad5c525..e30667d51 100644 --- a/Docs/python_api.md +++ b/Docs/python_api.md @@ -2321,10 +2321,6 @@ Sensors compound a specific family of actors quite diverse and unique. They are - [Obstacle detector](ref_sensors.md#obstacle-detector)
- [V2X sensor](ref_sensors.md#v2x-sensor). -### Instance Variables -- **is_listening** (_boolean_) -When **True** the sensor will be waiting for data. - ### Methods - **disable_for_ros**(**self**) Commands the sensor to not be processed for publishing in ROS2 if there is no any listen to it. @@ -3626,7 +3622,7 @@ World objects are created by the client to have a place for the simulation to ha ### Instance Variables - **id** (_int_) -The ID of the episode associated with this world. Episodes are different sessions of a simulation. These change everytime a world is disabled or reloaded. Keeping track is useful to avoid possible issues. +The ID of the episode associated with this world. Episodes are different sessions of a simulation. These change every time a world is disabled or reloaded. Keeping track is useful to avoid possible issues. - **debug** (_[carla.DebugHelper](#carla.DebugHelper)_) Responsible for creating different shapes for debugging. Take a look at its class to learn more about it. @@ -3705,7 +3701,7 @@ Loads the selected layers to the level. If the layer is already loaded the call - `map_layers` (_[carla.MapLayer](#carla.MapLayer)_) - Mask of level layers to be loaded. - **Warning:** _This only affects "Opt" maps. The minimum layout includes roads, sidewalks, traffic lights and traffic signs._ - **on_tick**(**self**, **callback**) -This method is used in [__asynchronous__ mode](https://[carla.readthedocs.io](#carla.readthedocs.io)/en/latest/adv_synchrony_timestep/). It starts callbacks from the client for the function defined as `callback`, and returns the ID of the callback. The function will be called everytime the server ticks. It requires a [carla.WorldSnapshot](#carla.WorldSnapshot) as argument, which can be retrieved from __wait_for_tick()__. Use __remove_on_tick()__ to stop the callbacks. +This method is used in [__asynchronous__ mode](https://[carla.readthedocs.io](#carla.readthedocs.io)/en/latest/adv_synchrony_timestep/). It starts callbacks from the client for the function defined as `callback`, and returns the ID of the callback. The function will be called every time the server ticks. It requires a [carla.WorldSnapshot](#carla.WorldSnapshot) as argument, which can be retrieved from __wait_for_tick()__. Use __remove_on_tick()__ to stop the callbacks. - **Parameters:** - `callback` (_[carla.WorldSnapshot](#carla.WorldSnapshot)_) - Function with a snapshot as compulsory parameter that will be called when the client receives a tick. - **Return:** _int_ @@ -3849,7 +3845,7 @@ _ - **Note:** _Should be set before pedestrians are spawned. If you want to repeat the same exact bodies (blueprint) for each pedestrian, then use the same seed in the Python code (where the blueprint is chosen randomly) and here, otherwise the pedestrians will repeat the same paths but the bodies will be different. _ - **set_weather**(**self**, **weather**) -Changes the weather parameteres ruling the simulation to another ones defined in an object. +Changes the weather parameters ruling the simulation to another ones defined in an object. - **Parameters:** - `weather` (_[carla.WeatherParameters](#carla.WeatherParameters)_) - New conditions to be applied. - **Getter:** _[carla.World.get_weather](#carla.World.get_weather)_ @@ -3880,7 +3876,7 @@ The maximum number of physics substepping that are allowed. By default, the valu - **max_culling_distance** (_float_) Configure the max draw distance for each mesh of the level. - **deterministic_ragdolls** (_bool_) -Defines wether to use deterministic physics for pedestrian death animations or physical ragdoll simulation. When enabled, pedestrians have less realistic death animation but ensures determinism. When disabled, pedestrians are simulated as ragdolls with more realistic simulation and collision but no determinsm can be ensured. +Defines wether to use deterministic physics for pedestrian death animations or physical ragdoll simulation. When enabled, pedestrians have less realistic death animation but ensures determinism. When disabled, pedestrians are simulated as ragdolls with more realistic simulation and collision but no determinism can be ensured. - **tile_stream_distance** (_float_) Used for large maps only. Configures the maximum distance from the hero vehicle to stream tiled maps. Regions of the map within this range will be visible (and capable of simulating physics). Regions outside this region will not be loaded. - **actor_active_distance** (_float_)