[NO_BUILD] Missing Python API docs (#4453)

* Adding pythonapi methods

* Added missing Python API methods

* Further missing methods added

* Mssing get_crosswalks method added

* Correction to set gravity method and command
This commit is contained in:
Corinne 2021-07-29 16:21:02 +02:00 committed by GitHub
parent 4151d6a18c
commit 4a8342fae1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 256 additions and 9 deletions

View File

@ -63,7 +63,7 @@ Sets a vehicle's velocity vector to a constant value over time. The resulting ve
_</font>
- **Warning:** <font color="#ED2F2F">_Enabling a constant velocity for a vehicle managed by the [Traffic Manager](https://[carla.readthedocs.io](#carla.readthedocs.io)/en/latest/adv_traffic_manager/) may cause conflicts. This method overrides any changes in velocity by the TM.
_</font>
- <a name="carla.Actor.enable_debug_telemetry"></a>**<font color="#7fb800">enable_debug_telemetry</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**enabled**=True</font>)
- <a name="carla.Actor.show_debug_telemetry"></a>**<font color="#7fb800">show_debug_telemetry</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**enabled**=True</font>)
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.
- **Parameters:**
- `enabled` (_bool_)
@ -91,6 +91,10 @@ Returns the world this actor belongs to.
- **Return:** _[carla.World](#carla.World)_
##### Setters
- <a name="carla.Actor.set_enable_gravity"></a>**<font color="#7fb800">set_enable_gravity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**enabled**</font>)
Enables or disables gravity for the actor. __Default__ is True.
- **Parameters:**
- `enabled` (_bool_)
- <a name="carla.Actor.set_location"></a>**<font color="#7fb800">set_location</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**location**</font>)
Teleports the actor to a given location.
- **Parameters:**
@ -453,6 +457,10 @@ Load a new world with default settings using `map_name` map. All actors present
- `duration` (_float<small> seconds</small>_) Time that will be reenacted using the information `name` file. If the end is reached, the simulation will continue.
- `follow_id` (_int_) ID of the actor to follow. If this is 0 then camera is disabled.
- `replay_sensors` (_bool_) Flag to enable or disable the spawn of sensors during playback.
- <a name="carla.Client.request_file"></a>**<font color="#7fb800">request_file</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**name**</font>)
Requests one of the required files returned by [carla.Client.get_required_files](#carla.Client.get_required_files).
- **Parameters:**
- `name` (_str_) Name of the file you are requesting.
- <a name="carla.Client.show_recorder_actors_blocked"></a>**<font color="#7fb800">show_recorder_actors_blocked</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**filename**</font>, <font color="#00a6ed">**min_time**</font>, <font color="#00a6ed">**min_distance**</font>)
The terminal will show the information registered for actors considered blocked. An actor is considered blocked when it does not move a minimum distance in a period of time, being these `min_distance` and `min_time`.
- **Parameters:**
@ -506,6 +514,11 @@ Returns a list of strings containing the paths of the maps available on server.
- <a name="carla.Client.get_client_version"></a>**<font color="#7fb800">get_client_version</font>**(<font color="#00a6ed">**self**</font>)
Returns the client libcarla version by consulting it in the "Version.h" file. Both client and server can use different libcarla versions but some issues may arise regarding unexpected incompatibilities.
- **Return:** _str_
- <a name="carla.Client.get_required_files"></a>**<font color="#7fb800">get_required_files</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**folder**</font>, <font color="#00a6ed">**download**=True</font>)
Asks the server which files are required by the client to use the current map. Option to download files automatically if they are not already in the cache.
- **Parameters:**
- `folder` (_str_) Folder where files required by the client will be downloaded to.
- `download` (_bool_) If True, downloads files that are not already in cache.
- <a name="carla.Client.get_server_version"></a>**<font color="#7fb800">get_server_version</font>**(<font color="#00a6ed">**self**</font>)
Returns the server libcarla version by consulting it in the "Version.h" file. Both client and server should use the same libcarla version.
- **Return:** _str_
@ -519,6 +532,12 @@ Returns the world object currently active in the simulation. This world will be
- **Return:** _[carla.World](#carla.World)_
##### Setters
- <a name="carla.Client.set_files_base_folder"></a>**<font color="#7fb800">set_files_base_folder</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**path**</font>)
- **Parameters:**
- `path` (_str_) Specifies the base folder where the local cache for required files will be placed.
- <a name="carla.Client.set_replayer_ignore_hero"></a>**<font color="#7fb800">set_replayer_ignore_hero</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**ignore_hero**</font>)
- **Parameters:**
- `ignore_hero` (_bool_) Enables or disables playback of the hero vehicle during a playback of a recorded simulation.
- <a name="carla.Client.set_replayer_time_factor"></a>**<font color="#7fb800">set_replayer_time_factor</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**time_factor**=1.0</font>)
When used, the time speed of the reenacted simulation is modified at will. It can be used several times while a playback is in curse.
- **Parameters:**
@ -1403,6 +1422,9 @@ Returns Euclidean distance from this location to another one.
- **Return:** _float<small> meters</small>_
##### Dunder methods
- <a name="carla.Location.__abs__"></a>**<font color="#7fb800">\__abs__</font>**(<font color="#00a6ed">**self**</font>)
Returns a Location with the absolute value of the components x, y and z.
- **Return:** _[carla.Location](#carla.Location)_
- <a name="carla.Location.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Location](#carla.Location)</font>)
Returns __True__ if both locations are the same point in space.
- **Return:** _bool_
@ -1461,6 +1483,9 @@ Returns the landmarks of a specific type. Landmarks retrieved using this method
- **Parameters:**
- `type` (_string_) The type of the landmarks.
- **Return:** _list([carla.Landmark](#carla.Landmark))_
- <a name="carla.Map.get_crosswalks"></a>**<font color="#7fb800">get_crosswalks</font>**(<font color="#00a6ed">**self**</font>)
Returns a list of locations with all crosswalk zones in the form of closed polygons. The first point is repeated, symbolizing where the polygon begins and ends.
- **Return:** _list([carla.Location](#carla.Location))_
- <a name="carla.Map.get_landmark_group"></a>**<font color="#7fb800">get_landmark_group</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**landmark**</font>)
Returns the landmarks in the same group as the specified landmark (including itself). Returns an empty list if the landmark does not belong to any group.
- **Parameters:**
@ -2251,6 +2276,13 @@ Returns the port where the Traffic Manager is connected. If the object is a TM-C
- **Return:** _uint16_
##### Setters
- <a name="carla.TrafficManager.set_boundaries_respawn_dormant_vehicles"></a>**<font color="#7fb800">set_boundaries_respawn_dormant_vehicles</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**lower_bound**=25.0</font>, <font color="#00a6ed">**upper_bound**=actor_active_distance</font>)
Sets the upper and lower boundaries for dormant actors to be respawned near the hero vehicle.
- **Parameters:**
- `lower_bound` (_float_) The minimum distance in meters from the hero vehicle that a dormant actor will be respawned.
- `upper_bound` (_float_) The maximum distance in meters from the hero vehicle that a dormant actor will be respawned.
- **Warning:** <font color="#ED2F2F">_The `upper_bound` cannot be higher than the `actor_active_distance`. The `lower_bound` cannot be less than 25.
_</font>
- <a name="carla.TrafficManager.set_global_distance_to_leading_vehicle"></a>**<font color="#7fb800">set_global_distance_to_leading_vehicle</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**distance**</font>)
Sets the minimum distance in meters that vehicles have to keep with the rest. The distance is in meters and will affect the minimum moving distance. It is computed from center to center of the vehicle objects.
- **Parameters:**
@ -2276,6 +2308,10 @@ During the localization stage, this method sets a percent chance that vehicle wi
Sets a specific random seed for the Traffic Manager, thereby setting it to be deterministic.
- **Parameters:**
- `value` (_int_) Seed value for the random number generation of the Traffic Manager.
- <a name="carla.TrafficManager.set_respawn_dormant_vehicles"></a>**<font color="#7fb800">set_respawn_dormant_vehicles</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**mode_switch**=False</font>)
If __True__, vehicles in large maps will respawn near the hero vehicle when they become dormant. Otherwise, they will stay dormant until they are within `actor_active_distance` of the hero vehicle again.
- **Parameters:**
- `mode_switch` (_bool_)
- <a name="carla.TrafficManager.set_synchronous_mode"></a>**<font color="#7fb800">set_synchronous_mode</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**mode_switch**=True</font>)
Sets the Traffic Manager to [synchronous mode](adv_traffic_manager.md#synchronous-mode). In a [multiclient situation](adv_traffic_manager.md#multiclient), only the TM-Server can tick. Similarly, in a [multiTM situation](adv_traffic_manager.md#multitm), only one TM-Server must tick. Use this method in the client that does the world tick, and right after setting the world to synchronous mode, to set which TM will be the master while in sync.
- **Parameters:**
@ -2395,6 +2431,9 @@ Z-axis value.
- `z` (_float_)
##### Dunder methods
- <a name="carla.Vector3D.__abs__"></a>**<font color="#7fb800">\__abs__</font>**(<font color="#00a6ed">**self**</font>)
Returns a Vector3D with the absolute value of the components x, y and z.
- **Return:** _[carla.Vector3D](#carla.Vector3D)_
- <a name="carla.Vector3D.__add__"></a>**<font color="#7fb800">\__add__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector3D](#carla.Vector3D)</font>)
- <a name="carla.Vector3D.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector3D](#carla.Vector3D)</font>)
Returns __True__ if values for every axis are equal.
@ -2594,7 +2633,7 @@ Enable the use of sweep for wheel collision. By default, it is disabled and it u
List of wheel physics objects. This list should have 4 elements, where index 0 corresponds to the front left wheel, index 1 corresponds to the front right wheel, index 2 corresponds to the back left wheel and index 3 corresponds to the back right wheel. For 2 wheeled vehicles, set the same values for both front and back wheels.
### Methods
- <a name="carla.VehiclePhysicsControl.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**torque_curve**=[[0.0, 500.0], [5000.0, 500.0]]</font>, <font color="#00a6ed">**max_rpm**=5000.0</font>, <font color="#00a6ed">**moi**=1.0</font>, <font color="#00a6ed">**damping_rate_full_throttle**=0.15</font>, <font color="#00a6ed">**damping_rate_zero_throttle_clutch_engaged**=2.0</font>, <font color="#00a6ed">**damping_rate_zero_throttle_clutch_disengaged**=0.35</font>, <font color="#00a6ed">**use_gear_autobox**=True</font>, <font color="#00a6ed">**gear_switch_time**=0.5</font>, <font color="#00a6ed">**clutch_strength**=10.0</font>, <font color="#00a6ed">**final_ratio**=4.0</font>, <font color="#00a6ed">**forward_gears**=list()</font>, <font color="#00a6ed">**mass**=1000.0</font>, <font color="#00a6ed">**drag_coefficient**=0.3</font>, <font color="#00a6ed">**center_of_mass**=[0.0, 0.0, 0.0]</font>, <font color="#00a6ed">**steering_curve**=[[0.0, 1.0], [10.0, 0.5]]</font>, <font color="#00a6ed">**wheels**=list()</font>)
- <a name="carla.VehiclePhysicsControl.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**torque_curve**=[[0.0, 500.0], [5000.0, 500.0]]</font>, <font color="#00a6ed">**max_rpm**=5000.0</font>, <font color="#00a6ed">**moi**=1.0</font>, <font color="#00a6ed">**damping_rate_full_throttle**=0.15</font>, <font color="#00a6ed">**damping_rate_zero_throttle_clutch_engaged**=2.0</font>, <font color="#00a6ed">**damping_rate_zero_throttle_clutch_disengaged**=0.35</font>, <font color="#00a6ed">**use_gear_autobox**=True</font>, <font color="#00a6ed">**gear_switch_time**=0.5</font>, <font color="#00a6ed">**clutch_strength**=10.0</font>, <font color="#00a6ed">**final_ratio**=4.0</font>, <font color="#00a6ed">**forward_gears**=list()</font>, <font color="#00a6ed">**drag_coefficient**=0.3</font>, <font color="#00a6ed">**center_of_mass**=[0.0, 0.0, 0.0]</font>, <font color="#00a6ed">**steering_curve**=[[0.0, 1.0], [10.0, 0.5]]</font>, <font color="#00a6ed">**wheels**=list()</font>, <font color="#00a6ed">**use_sweep_wheel_collision**=False</font>, <font color="#00a6ed">**mass**=1000.0</font>)
VehiclePhysicsControl constructor.
- **Parameters:**
- `torque_curve` (_list([carla.Vector2D](#carla.Vector2D))_)
@ -2612,6 +2651,8 @@ VehiclePhysicsControl constructor.
- `center_of_mass` (_[carla.Vector3D](#carla.Vector3D)_)
- `steering_curve` (_[carla.Vector2D](#carla.Vector2D)_)
- `wheels` (_list([carla.WheelPhysicsControl](#carla.WheelPhysicsControl))_)
- `use_sweep_wheel_collision` (_bool_)
- `mass` (_float<small> kilograms</small>_)
##### Dunder methods
- <a name="carla.VehiclePhysicsControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.VehiclePhysicsControl](#carla.VehiclePhysicsControl)</font>)
@ -2848,9 +2889,15 @@ Fog start distance. Values range from 0 to infinite.
Wetness intensity. It only affects the RGB camera sensor. Values range from 0 to 100.
- <a name="carla.WeatherParameters.fog_falloff"></a>**<font color="#f8805a">fog_falloff</font>** (_float_)
Density of the fog (as in specific mass) from 0 to infinity. The bigger the value, the more dense and heavy it will be, and the fog will reach smaller heights. Corresponds to <a href="https://docs.unrealengine.com/en-US/Engine/Actors/FogEffects/HeightFog/index.html#:~:text=Using%20Exponential%20Height%20Fog%20Features,-The%20sections%20below&text=Add%20a%20second%20fog%20layer,height%20falloff%2C%20and%20height%20offset">Fog Height Falloff</a> in the UE docs. <br> If the value is 0, the fog will be lighter than air, and will cover the whole scene. <br> A value of 1 is approximately as dense as the air, and reaches normal-sized buildings. <br> For values greater than 5, the air will be so dense that it will be compressed on ground level.
- <a name="carla.WeatherParameters.scattering_intensity"></a>**<font color="#f8805a">scattering_intensity</font>** (_float_)
Controls how much the light will contribute to volumetric fog. When set to 0, there is no contribution.
- <a name="carla.WeatherParameters.mie_scattering_scale"></a>**<font color="#f8805a">mie_scattering_scale</font>** (_float_)
Controls interaction of light with large particles like pollen or air pollution resulting in a hazy sky with halos around the light sources. When set to 0, there is no contribution.
- <a name="carla.WeatherParameters.rayleigh_scattering_scale"></a>**<font color="#f8805a">rayleigh_scattering_scale</font>** (_float_)
Controls interaction of light with small particles like air molecules. Dependent on light wavelength, resulting in a blue sky in the day or red sky in the evening.
### Methods
- <a name="carla.WeatherParameters.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**cloudiness**=0.0</font>, <font color="#00a6ed">**precipitation**=0.0</font>, <font color="#00a6ed">**precipitation_deposits**=0.0</font>, <font color="#00a6ed">**wind_intensity**=0.0</font>, <font color="#00a6ed">**sun_azimuth_angle**=0.0</font>, <font color="#00a6ed">**sun_altitude_angle**=0.0</font>, <font color="#00a6ed">**fog_density**=0.0</font>, <font color="#00a6ed">**fog_distance**=0.0</font>, <font color="#00a6ed">**wetness**=0.0</font>, <font color="#00a6ed">**fog_falloff**=0.2</font>)
- <a name="carla.WeatherParameters.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**cloudiness**=0.0</font>, <font color="#00a6ed">**precipitation**=0.0</font>, <font color="#00a6ed">**precipitation_deposits**=0.0</font>, <font color="#00a6ed">**wind_intensity**=0.0</font>, <font color="#00a6ed">**sun_azimuth_angle**=0.0</font>, <font color="#00a6ed">**sun_altitude_angle**=0.0</font>, <font color="#00a6ed">**fog_density**=0.0</font>, <font color="#00a6ed">**fog_distance**=0.0</font>, <font color="#00a6ed">**wetness**=0.0</font>, <font color="#00a6ed">**fog_falloff**=0.0</font>, <font color="#00a6ed">**scattering_intensity**=0.0</font>, <font color="#00a6ed">**mie_scattering_scale**=0.0</font>, <font color="#00a6ed">**rayleigh_scattering_scale**=0.0331</font>)
Method to initialize an object defining weather conditions. This class has some presets for different noon and sunset conditions listed in a note below.
- **Parameters:**
- `cloudiness` (_float_) 0 is a clear sky, 100 complete overcast.
@ -2863,6 +2910,9 @@ Method to initialize an object defining weather conditions. This class has some
- `fog_distance` (_float<small> meters</small>_) Distance where the fog starts in meters.
- `wetness` (_float_) Humidity percentages of the road, from 0 to 100.
- `fog_falloff` (_float_) Density (specific mass) of the fog, from 0 to infinity.
- `scattering_intensity` (_float_) Controls how much the light will contribute to volumetric fog. When set to 0, there is no contribution.
- `mie_scattering_scale` (_float_) Controls interaction of light with large particles like pollen or air pollution resulting in a hazy sky with halos around the light sources. When set to 0, there is no contribution.
- `rayleigh_scattering_scale` (_float_) Controls interaction of light with small particles like air molecules. Dependent on light wavelength, resulting in a blue sky in the day or red sky in the evening.
- **Note:** <font color="#8E8E8E">_ClearNoon, CloudyNoon, WetNoon, WetCloudyNoon, SoftRainNoon, MidRainyNoon, HardRainNoon, ClearSunset, CloudySunset, WetSunset, WetCloudySunset, SoftRainSunset, MidRainSunset, HardRainSunset.
_</font>
@ -3431,6 +3481,22 @@ Port of the Traffic Manager where the vehicle is to be registered or unlisted.
---
## command.SetEnableGravity<a name="command.SetEnableGravity"></a>
Command adaptation of __<font color="#7fb800">set_enable_gravity()</font>__ in [carla.Actor](#carla.Actor). Enables or disables gravity on an actor.
### Instance Variables
- <a name="command.SetEnableGravity.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_[carla.Actor](#carla.Actor) or int_)
Actor that is affected by the command.
- <a name="command.SetEnableGravity.enabled"></a>**<font color="#f8805a">enabled</font>** (_bool_)
### Methods
- <a name="command.SetEnableGravity.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**actor**</font>, <font color="#00a6ed">**enabled**</font>)
- **Parameters:**
- `actor` (_[carla.Actor](#carla.Actor) or int_) Actor or Actor ID to which the command will be applied to.
- `enabled` (_bool_)
---
## command.SetSimulatePhysics<a name="command.SetSimulatePhysics"></a>
Command adaptation of __<font color="#7fb800">set_simulate_physics()</font>__ in [carla.Actor](#carla.Actor). Determines whether an actor will be affected by physics or not.
@ -3465,6 +3531,22 @@ Defines the light state of a vehicle.
---
## command.ShowDebugTelemetry<a name="command.ShowDebugTelemetry"></a>
Command adaptation of __<font color="#7fb800">show_debug_telemetry()</font>__ in [carla.Actor](#carla.Actor). Displays vehicle control telemetry data.
### Instance Variables
- <a name="command.ShowDebugTelemetry.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_[carla.Actor](#carla.Actor) or int_)
Actor that is affected by the command.
- <a name="command.ShowDebugTelemetry.enabled"></a>**<font color="#f8805a">enabled</font>** (_bool_)
### Methods
- <a name="command.ShowDebugTelemetry.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**actor**</font>, <font color="#00a6ed">**enabled**</font>)
- **Parameters:**
- `actor` (_[carla.Actor](#carla.Actor) or int_) Actor or Actor ID to which the command will be applied to.
- `enabled` (_bool_)
---
## command.SpawnActor<a name="command.SpawnActor"></a>
Command adaptation of __<font color="#7fb800">spawn_actor()</font>__ in [carla.World](#carla.World). Spawns an actor into the world based on the blueprint provided and the transform. If a parent is provided, the actor is attached to it.

View File

@ -133,7 +133,7 @@
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
- def_name: show_debug_telemetry
params:
- param_name: enabled
type: bool
@ -219,6 +219,13 @@
# --------------------------------------
- def_name: __str__
# --------------------------------------
- def_name: set_enable_gravity
params:
- param_name: enabled
type: bool
doc: >
Enables or disables gravity for the actor. __Default__ is True.
- class_name: VehicleLightState
# - DESCRIPTION ------------------------
doc: >

View File

@ -299,6 +299,42 @@
doc: >
Sets the maxixum time a network call is allowed before blocking it and raising a timeout exceeded error.
# --------------------------------------
- def_name: set_replayer_ignore_hero
params:
- param_name: ignore_hero
type: bool
doc: >
Enables or disables playback of the hero vehicle during a playback of a recorded simulation.
# --------------------------------------
- def_name: set_files_base_folder
params:
- param_name: path
type: str
doc: >
Specifies the base folder where the local cache for required files will be placed.
# --------------------------------------
- def_name: get_required_files
params:
- param_name: folder
type: str
doc: >
Folder where files required by the client will be downloaded to.
- param_name: download
type: bool
default: True
doc: >
If True, downloads files that are not already in cache.
doc: >
Asks the server which files are required by the client to use the current map. Option to download files automatically if they are not already in the cache.
# --------------------------------------
- def_name: request_file
params:
- param_name: name
type: str
doc: >
Name of the file you are requesting.
doc: >
Requests one of the required files returned by carla.Client.get_required_files.
- class_name: TrafficManager
# - DESCRIPTION ------------------------
@ -526,6 +562,31 @@
warning: >
If the server is set to synchronous mode, the TM <b>must</b> be set to synchronous mode too in the same client that does the tick.
# --------------------------------------
- def_name: set_respawn_dormant_vehicles
params:
- param_name: mode_switch
type: bool
default: false
doc: >
If __True__, vehicles in large maps will respawn near the hero vehicle when they become dormant. Otherwise, they will stay dormant until they are within `actor_active_distance` of the hero vehicle again.
# --------------------------------------
- def_name: set_boundaries_respawn_dormant_vehicles
params:
- param_name: lower_bound
type: float
default: 25.0
doc: >
The minimum distance in meters from the hero vehicle that a dormant actor will be respawned.
- param_name: upper_bound
type: float
default: actor_active_distance
doc: >
The maximum distance in meters from the hero vehicle that a dormant actor will be respawned.
doc: >
Sets the upper and lower boundaries for dormant actors to be respawned near the hero vehicle.
warning: >
The `upper_bound` cannot be higher than the `actor_active_distance`. The `lower_bound` cannot be less than 25.
# --------------------------------------
- class_name: OpendriveGenerationParameters
# - DESCRIPTION ------------------------

View File

@ -489,4 +489,52 @@
doc: >
Recaps the state of the lights of a vehicle, these can be used as a flags.
# --------------------------------------
- class_name: SetEnableGravity
# - DESCRIPTION ------------------------
doc: >
Command adaptation of __<font color="#7fb800">set_enable_gravity()</font>__ in carla.Actor. Enables or disables gravity on an actor.
# - PROPERTIES -------------------------
instance_variables:
- var_name: actor_id
type: carla.Actor or int
doc: >
Actor that is affected by the command.
- var_name: enabled
type: bool
# - METHODS ----------------------------
methods:
- def_name: __init__
params:
- param_name: actor
type: carla.Actor or int
doc: >
Actor or Actor ID to which the command will be applied to.
- param_name: enabled
type: bool
# --------------------------------------
- class_name: ShowDebugTelemetry
# - DESCRIPTION ------------------------
doc: >
Command adaptation of __<font color="#7fb800">show_debug_telemetry()</font>__ in carla.Actor. Displays vehicle control telemetry data.
# - PROPERTIES -------------------------
instance_variables:
- var_name: actor_id
type: carla.Actor or int
doc: >
Actor that is affected by the command.
- var_name: enabled
type: bool
# - METHODS ----------------------------
methods:
- def_name: __init__
params:
- param_name: actor
type: carla.Actor or int
doc: >
Actor or Actor ID to which the command will be applied to.
- param_name: enabled
type: bool
# --------------------------------------
...

View File

@ -349,9 +349,6 @@
- param_name: forward_gears
default: list()
type: list(carla.GearPhysicsControl)
- param_name: mass
default: 1000.0
param_units: kilograms
- param_name: drag_coefficient
default: 0.3
type: float
@ -364,6 +361,13 @@
- param_name: wheels
default: list()
type: list(carla.WheelPhysicsControl)
- param_name: use_sweep_wheel_collision
default: False
type: bool
- param_name: mass
default: 1000.0
type: float
param_units: kilograms
doc: >
VehiclePhysicsControl constructor
# --------------------------------------

View File

@ -141,6 +141,11 @@
doc: >
Returns the axis values for the vector parsed as string.
# --------------------------------------
- def_name: __abs__
return: carla.Vector3D
doc: >
Returns a Vector3D with the absolute value of the components x, y and z.
# --------------------------------------
- class_name: Location
parent: carla.Vector3D
@ -210,6 +215,12 @@
doc: >
Parses the axis' values to string.
# --------------------------------------
- def_name: __abs__
return: carla.Location
doc: >
Returns a Location with the absolute value of the components x, y and z.
# --------------------------------------
- class_name: Rotation
# - DESCRIPTION ------------------------

View File

@ -270,6 +270,11 @@
Specify the length from the road start.
return: carla.Waypoint
# --------------------------------------
- def_name: get_crosswalks
doc: >
Returns a list of locations with all crosswalk zones in the form of closed polygons. The first point is repeated, symbolizing where the polygon begins and ends.
return: list(carla.Location)
# --------------------------------------
- def_name: __str__
# --------------------------------------

View File

@ -62,7 +62,21 @@
type: float
doc: >
Density of the fog (as in specific mass) from 0 to infinity. The bigger the value, the more dense and heavy it will be, and the fog will reach smaller heights. Corresponds to <a href="https://docs.unrealengine.com/en-US/Engine/Actors/FogEffects/HeightFog/index.html#:~:text=Using%20Exponential%20Height%20Fog%20Features,-The%20sections%20below&text=Add%20a%20second%20fog%20layer,height%20falloff%2C%20and%20height%20offset">Fog Height Falloff</a> in the UE docs. <br> If the value is 0, the fog will be lighter than air, and will cover the whole scene. <br> A value of 1 is approximately as dense as the air, and reaches normal-sized buildings. <br> For values greater than 5, the air will be so dense that it will be compressed on ground level.
# --------------------------------------
- var_name: scattering_intensity
type: float
doc: >
Controls how much the light will contribute to volumetric fog. When set to 0, there is no contribution.
# --------------------------------------
- var_name: mie_scattering_scale
type: float
doc: >
Controls interaction of light with large particles like pollen or air pollution resulting in a hazy sky with halos around the light sources. When set to 0, there is no contribution.
# --------------------------------------
- var_name: rayleigh_scattering_scale
type: float
doc: >
Controls interaction of light with small particles like air molecules. Dependent on light wavelength, resulting in a blue sky in the day or red sky in the evening.
# - METHODS ----------------------------
methods:
- def_name: __init__
@ -117,9 +131,24 @@
Humidity percentages of the road, from 0 to 100.
- param_name: fog_falloff
type: float
default: 0.2
default: 0.0
doc: >
Density (specific mass) of the fog, from 0 to infinity.
- param_name: scattering_intensity
type: float
default: 0.0
doc: >
Controls how much the light will contribute to volumetric fog. When set to 0, there is no contribution.
- param_name: mie_scattering_scale
type: float
default: 0.0
doc: >
Controls interaction of light with large particles like pollen or air pollution resulting in a hazy sky with halos around the light sources. When set to 0, there is no contribution.
- param_name: rayleigh_scattering_scale
type: float
default: 0.0331
doc: >
Controls interaction of light with small particles like air molecules. Dependent on light wavelength, resulting in a blue sky in the day or red sky in the evening.
note: >
ClearNoon, CloudyNoon, WetNoon, WetCloudyNoon, SoftRainNoon, MidRainyNoon, HardRainNoon, ClearSunset, CloudySunset, WetSunset, WetCloudySunset, SoftRainSunset, MidRainSunset, HardRainSunset.
doc: >