Skip to content
This repository was archived by the owner on Aug 15, 2024. It is now read-only.

Commit 3733521

Browse files
committed
Convert args to table
1 parent 095595f commit 3733521

File tree

1 file changed

+26
-27
lines changed

1 file changed

+26
-27
lines changed

aitk/robots/robot.py

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -73,33 +73,32 @@ def __init__(
7373
"""
7474
A simulated robot.
7575
76-
Args:
77-
x (int): starting location in the horizontal direction. Leave 0 to
78-
place in a random location.
79-
y (int): starting location in the horizontal direction. Leave 0 to
80-
place in a random location.
81-
a (float): starting angle in degrees.
82-
color (str): the name of a color for the robot
83-
name (str): a name to give your robot
84-
do_trace (bool): should the robot leave a trace?
85-
height (int): height of robot (use number < 1)
86-
max_trace_length (int): max length of trace, in seconds
87-
state (dict): serializable memory for a robot
88-
va (float): angle velocity
89-
vx (float): x velocity
90-
vy (float): y velocity
91-
tva (float): angle target velocity
92-
tvx (float): x target velocity
93-
tvy (float): y target velocity
94-
va_max (float): angle max velocity
95-
vx_max (float): x max velocity
96-
vy_max (float): y max velocity
97-
va_ramp (float): angle linear acceleration
98-
vx_ramp (float): x linear acceleration
99-
vy_ramp (float): y linear acceleration
100-
image_data (dataset-name, index): to use a 3D set of images
101-
body (List): data structure that defines a robot body
102-
devices (List): list of serialized devices
76+
Option | Type | Description | Default
77+
------ | ---- | ----------- | -------
78+
x | int | starting location in the horizontal direction. Leave 0 to place in a random location. | 0
79+
y | int | starting location in the horizontal direction. Leave 0 to place in a random location. | 0
80+
a | float | starting angle in degrees. | 0
81+
color | str | the name of a color for the robot | "red"
82+
name | str | a name to give your robot | "Robbie"
83+
do_trace | bool | should the robot leave a trace? | True
84+
height | int | height of robot use number < 1 | 0.25
85+
max_trace_length | int | max length of trace, in seconds | 10
86+
state | dict | serializable memory for a robot | None
87+
va | float | angle velocity | None
88+
vx | float | x velocity | None
89+
vy | float | y velocity | None
90+
tva | float | angle target velocity | None
91+
tvx | float | x target velocity | None
92+
tvy | float | y target velocity | None
93+
va_max | float | angle max velocity | None
94+
vx_max | float | x max velocity | None
95+
vy_max | float | y max velocity | None
96+
va_ramp | float | angle linear acceleration | None
97+
vx_ramp | float | x linear acceleration | None
98+
vy_ramp | float | y linear acceleration | None
99+
image_data | dataset-name, index | to use a 3D set of images | None
100+
body | List | data structure that defines a robot body | None
101+
devices | List | list of serialized devices | None
103102
"""
104103
# Get the args:
105104
config = {

0 commit comments

Comments
 (0)