Skip to content

Commit 3a6f699

Browse files
committed
Add documentation for ActionResult enums
1 parent de51e98 commit 3a6f699

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,11 @@ observations, action_result = b.step('move_distance', {'distance': 5})
104104
```
105105
The returned `observations` variable holds a dictionary with key-value pairs corresponding to the name-data defined by each observation channel. A full list of observation channels for the default channel set is provided below.
106106

107+
The `action_result` is an enumerated value denoting the result of the action (use `from benchbot_api import ActionResult` to access the `Enum` class). You should use this result to guide the progression of your algorithm either manually or in the `is_done()` method of your `Agent`. Possible values for the returned `action_result` are:
108+
- `ActionResult.SUCCESS`: the action was carried out successfully
109+
- `ActionResult.FINISHED`: the action was carried out successfully, and the robot is now finished its traversal through the scene (only used in `passive` actuation mode)
110+
- `ActionResult.COLLISION`: the action crashed the robot into an obstacle, and as a result it will not respond to any further actuation commands (at this point you should quit)
111+
107112
### Default Communication Channel List
108113

109114
#### Action Channels:

0 commit comments

Comments
 (0)