carla/PythonAPI/docs/weather.yml

---
- module_name: carla
  doc: >
  # - CLASSES ------------------------------
  classes:
  - class_name: WeatherParameters
    # - DESCRIPTION ------------------------
    doc: >
      WeatherParameters class is used for requesting and changing the lighting and weather conditions inside the world.
    # - PROPERTIES -------------------------
    instance_variables:
    - var_name: cloudyness
      type: float
      doc: >
        Weather cloudyness. Values range from 0 to 100.
    # --------------------------------------
    - var_name: precipitation
      type: float
      doc: >
        Precipitation amount for controlling rain intensity. Values range from 0 to 100.
    # --------------------------------------
    - var_name: precipitation_deposits
      type: float
      doc: >
        Precipitation deposits for controlling the area of puddles on roads. Values range from 0 to 100.
    # --------------------------------------
    - var_name: wind_intensity
      type: float
      doc: >
        Wind intensity. Values range from 0 to 100.
    # --------------------------------------
    - var_name: sun_azimuth_angle
      type: float
      doc: >
        Azimuth angle of the sun in degrees. Values range from 0 to 360.
    # --------------------------------------
    - var_name: sun_altitude_angle
      type: float
      doc: >
        Altitude angle of the sun in degrees. Values range from -90 to 90.

    # - METHODS ----------------------------
    methods:
    - def_name: __init__
      params:
      - param_name: cloudyness
        type: float
        default: 0.0
      - param_name: precipitation
        type: float
        default: 0.0
      - param_name: precipitation_deposits
        type: float
        default: 0.0
      - param_name: wind_intensity
        type: float
        default: 0.0
      - param_name: sun_azimuth_angle
        type: float
        default: 0.0
      - param_name: sun_altitude_angle
        type: float
        default: 0.0
      doc: >
        WeatherParameters constructor
    # --------------------------------------
    - def_name: __eq__
      params:
      - param_name: other
      return: bool
      doc: >
        Returns True if `self` and `other` are equal
    # --------------------------------------
    - def_name: __ne__
      params:
      - param_name: other
      return: bool
      doc: >
        Returns True if `self` and `other` are not equal
    # --------------------------------------
    - def_name: __str__
      doc: > 
    # --------------------------------------
...