Deprecated persistent_lines in docs

This commit is contained in:
Marc Garcia Puig 2019-07-12 18:25:05 +02:00
parent f820826f7f
commit e6e4b8c9d2
2 changed files with 32 additions and 21 deletions

View File

@ -627,7 +627,7 @@ Class that provides drawing debug shapes.
- `size` (_float_)
- `color` (_[carla.Color](#carla.Color)_)
- `life_time` (_float_)
- `persistent_lines` (_bool_)
- `persistent_lines` (_bool_) _Deprecated, use `life_time=0` instead_.
- <a name="carla.DebugHelper.draw_line"></a>**<font color="#7fb800">draw_line</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**begin**</font>, <font color="#00a6ed">**end**</font>, <font color="#00a6ed">**thickness**=0.1f</font>, <font color="#00a6ed">**color**=(255,0,0)</font>, <font color="#00a6ed">**life_time**=-1.0f</font>, <font color="#00a6ed">**persistent_lines**=True</font>)
- **Parameters:**
- `begin` (_[carla.Location](#carla.Location)_)
@ -635,7 +635,7 @@ Class that provides drawing debug shapes.
- `thickness` (_float_)
- `color` (_[carla.Color](#carla.Color)_)
- `life_time` (_float_)
- `persistent_lines` (_bool_)
- `persistent_lines` (_bool_) _Deprecated, use `life_time=0` instead_.
- <a name="carla.DebugHelper.draw_arrow"></a>**<font color="#7fb800">draw_arrow</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**begin**</font>, <font color="#00a6ed">**end**</font>, <font color="#00a6ed">**thickness**=0.1f</font>, <font color="#00a6ed">**arrow_size**=0.1f</font>, <font color="#00a6ed">**color**=(255,0,0)</font>, <font color="#00a6ed">**life_time**=-1.0f</font>, <font color="#00a6ed">**persistent_lines**=True</font>)
- **Parameters:**
- `begin` (_[carla.Location](#carla.Location)_)
@ -644,7 +644,7 @@ Class that provides drawing debug shapes.
- `arrow_size` (_float_)
- `color` (_[carla.Color](#carla.Color)_)
- `life_time` (_float_)
- `persistent_lines` (_bool_)
- `persistent_lines` (_bool_) _Deprecated, use `life_time=0` instead_.
- <a name="carla.DebugHelper.draw_box"></a>**<font color="#7fb800">draw_box</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**box**</font>, <font color="#00a6ed">**rotation**</font>, <font color="#00a6ed">**thickness**=0.1f</font>, <font color="#00a6ed">**color**=(255,0,0)</font>, <font color="#00a6ed">**life_time**=-1.0f</font>, <font color="#00a6ed">**persistent_lines**=True</font>)
- **Parameters:**
- `box` (_[carla.BoundingBox](#carla.BoundingBox)_)
@ -652,7 +652,7 @@ Class that provides drawing debug shapes.
- `thickness` (_float_)
- `color` (_[carla.Color](#carla.Color)_)
- `life_time` (_float_)
- `persistent_lines` (_bool_)
- `persistent_lines` (_bool_) _Deprecated, use `life_time=0` instead_.
- <a name="carla.DebugHelper.draw_string"></a>**<font color="#7fb800">draw_string</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**location**</font>, <font color="#00a6ed">**text**</font>, <font color="#00a6ed">**draw_shadow**=False</font>, <font color="#00a6ed">**color**=(255,0,0)</font>, <font color="#00a6ed">**life_time**=-1.0f</font>, <font color="#00a6ed">**persistent_lines**=True</font>)
- **Parameters:**
- `location` (_[carla.Location](#carla.Location)_)
@ -660,7 +660,7 @@ Class that provides drawing debug shapes.
- `draw_shadow` (_bool_)
- `color` (_[carla.Color](#carla.Color)_)
- `life_time` (_float_)
- `persistent_lines` (_bool_)
- `persistent_lines` (_bool_) _Deprecated, set a high `life_time` instead_.
---

View File

@ -324,6 +324,8 @@
- param_name: persistent_lines
type: bool
default: True
doc: >
_Deprecated, use `life_time=0` instead_
doc: >
# --------------------------------------
- def_name: draw_line
@ -344,6 +346,8 @@
- param_name: persistent_lines
type: bool
default: True
doc: >
_Deprecated, use `life_time=0` instead_
doc: >
# --------------------------------------
- def_name: draw_arrow
@ -367,6 +371,8 @@
- param_name: persistent_lines
type: bool
default: True
doc: >
_Deprecated, use `life_time=0` instead_
doc: >
# --------------------------------------
- def_name: draw_box
@ -387,25 +393,30 @@
- param_name: persistent_lines
type: bool
default: True
doc: >
_Deprecated, use `life_time=0` instead_
doc: >
# --------------------------------------
- def_name: draw_string
params:
- param_name: location
type: carla.Location
- param_name: text
type: str
- param_name: draw_shadow
type: bool
default: False
- param_name: color
type: carla.Color
default: (255,0,0)
- param_name: life_time
type: float
default: -1.0f
- param_name: persistent_lines
type: bool
default: true
- param_name: location
type: carla.Location
- param_name: text
type: str
- param_name: draw_shadow
type: bool
default: False
- param_name: color
type: carla.Color
default: (255,0,0)
- param_name: life_time
type: float
default: -1.0f
- param_name: persistent_lines
type: bool
default: true
doc: >
_Deprecated, set a high `life_time` instead_
doc: >
# --------------------------------------
...