diff --git a/Docs/core_world.md b/Docs/core_world.md index ec2ebebc0..c0c809b14 100644 --- a/Docs/core_world.md +++ b/Docs/core_world.md @@ -181,7 +181,7 @@ Street lights are categorized using their attribute __light_group__, of type [__ ```py # Get the light manager and lights -lmanager = world.get_light_manager() +lmanager = world.get_lightmanager() mylights = lmanager.get_all_lights() # Custom a specific light diff --git a/Docs/img/docs_version_panel.jpg b/Docs/img/docs_version_panel.jpg new file mode 100644 index 000000000..e9a1b419f Binary files /dev/null and b/Docs/img/docs_version_panel.jpg differ diff --git a/Docs/index.md b/Docs/index.md index eec2eaef0..1b762e08f 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -14,8 +14,8 @@ The CARLA forum is available to post any doubts or suggestions that may arise du CARLA forum -!!! Important - This documentation refers to CARLA 0.9.0 or later. To read about previous versions, check the [stable branch](https://carla.readthedocs.io/en/stable/). +!!! Warning + Change the docs version to fit the CARLA version you are using. Use the pannel in the bottom-right side of this window to change to previous versions. ![docs_version_panel](img/docs_version_panel.jpg) --- diff --git a/Docs/python_api.md b/Docs/python_api.md index 6ae8de89b..2bd8dc9c7 100644 --- a/Docs/python_api.md +++ b/Docs/python_api.md @@ -55,7 +55,7 @@ Returns the actor's 3D acceleration vector the client recieved during last tick. - **Return:** _[carla.Vector3D](#carla.Vector3D) – m/s2_ - **get_angular_velocity**(**self**) Returns the actor's angular velocity vector the client recieved during last tick. The method does not call the simulator. - - **Return:** _[carla.Vector3D](#carla.Vector3D) – rad/s_ + - **Return:** _[carla.Vector3D](#carla.Vector3D) – deg/s_ - **get_location**(**self**) Returns the actor's location the client recieved during last tick. The method does not call the simulator. - **Return:** _[carla.Location](#carla.Location) – meters_ @@ -75,7 +75,7 @@ Returns the world this actor belongs to.
- **set_target_angular_velocity**(**self**, **angular_velocity**) Sets the actor's angular velocity vector. The modification will be effective two frames after the setting. Also, this is applied before the physics step so the resulting angular velocity will be affected by external forces at this frame such as friction. - **Parameters:** - - `angular_velocity` (_[carla.Vector3D](#carla.Vector3D)_) + - `angular_velocity` (_[carla.Vector3D](#carla.Vector3D) – deg/s_) - **Note:** _The update will not be effective until two frames after it is set. _ - **set_location**(**self**, **location**) @@ -1172,7 +1172,7 @@ All lights. --- ## carla.LightManager -This class handles the lights in the scene. Its main use is to get and set the state of groups or lists of lights in one call. An instance of this class can be retrieved by the [carla.World.get_light_manager](#carla.World.get_light_manager)(). +This class handles the lights in the scene. Its main use is to get and set the state of groups or lists of lights in one call. An instance of this class can be retrieved by the [carla.World.get_lightmanager](#carla.World.get_lightmanager)(). __Note.__ So far, though there is a `vehicle` group, vehicle lights are not available as [carla.Light](#carla.Light) objects. These have to be managed using [carla.Vehicle](#carla.Vehicle) and [carla.VehicleLightState](#carla.VehicleLightState). diff --git a/PythonAPI/docs/actor.yml b/PythonAPI/docs/actor.yml index 361b84ed6..4791e2a87 100644 --- a/PythonAPI/docs/actor.yml +++ b/PythonAPI/docs/actor.yml @@ -108,7 +108,7 @@ # -------------------------------------- - def_name: get_angular_velocity return: carla.Vector3D - return_units: rad/s + return_units: deg/s doc: > Returns the actor's angular velocity vector the client recieved during last tick. The method does not call the simulator. # -------------------------------------- @@ -138,6 +138,7 @@ params: - param_name: angular_velocity type: carla.Vector3D + param_units: deg/s doc: > Sets the actor's angular velocity vector. The modification will be effective two frames after the setting. Also, this is applied before the physics step so the resulting angular velocity will be affected by external forces at this frame such as friction. note: > diff --git a/PythonAPI/docs/light_manager.yml b/PythonAPI/docs/light_manager.yml index 3455644a8..0a157e518 100644 --- a/PythonAPI/docs/light_manager.yml +++ b/PythonAPI/docs/light_manager.yml @@ -163,7 +163,7 @@ - class_name: LightManager # - DESCRIPTION ------------------------ doc: > - This class handles the lights in the scene. Its main use is to get and set the state of groups or lists of lights in one call. An instance of this class can be retrieved by the carla.World.get_light_manager(). + This class handles the lights in the scene. Its main use is to get and set the state of groups or lists of lights in one call. An instance of this class can be retrieved by the carla.World.get_lightmanager(). __Note.__ So far, though there is a `vehicle` group, vehicle lights are not available as carla.Light objects. These have to be managed using carla.Vehicle and carla.VehicleLightState.