matrx.actions.object_actions.RemoveObjectResult¶
-
class
RemoveObjectResult
(result, succeeded)¶ ActionResult for a RemoveObjectAction
The results uniquely for RemoveObjectAction are (as class constants):
OBJECT_REMOVED: If the object was successfully removed.
REMOVAL_FAILED: If the object could not be removed by the
matrx.grid_world.GridWorld
.OBJECT_ID_NOT_WITHIN_RANGE: If the object is not within specified range.
NO_OBJECTS_IN_RANGE: If no objects are within range.
- Parameters
- result: str
A string representing the reason for the (expected) success or fail of a
matrx.actions.object_actions.RemoveObjectAction
.- succeeded: bool
A boolean representing the (expected) success or fail of a
matrx.actions.object_actions.RemoveObjectAction
.
See also
matrx.actions.object_actions.RemoveObjectAction
-
__init__
(self, result, succeeded)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
(self, result, succeeded)Initialize self.
Attributes
NO_ACTION_GIVEN
Result when the specified object is not within the specified range.
Result when the world could not remove the object for some reason.
Result when no objects were within the specified range.
REMOVAL_FAILED