matrx.actions.object_actions.DropObjectResult

class DropObjectResult(result, succeeded, obj_id=None)

ActionResult for a DropObjectAction.

The results uniquely for GrabObjectAction are (as class constants):

  • RESULT_SUCCESS: When the object is successfully dropped.

  • RESULT_NO_OBJECT: When there is no object in the agent’s inventory.

  • RESULT_NONE_GIVEN: When the given obj_id is not being carried by the agent.

  • RESULT_OBJECT: When the object was intended to drop on the agent’s location and this was not possible or when no suitable drop location could be found.

  • RESULT_UNKNOWN_OBJECT_TYPE: When the object id does not exist (anymore).

  • RESULT_NO_OBJECT_CARRIED: When no objects are carried by the agent.

Parameters
resultstr

A string representing the reason for the (expected) success or fail of an matrx.actions.object_actions.DropObjectAction.

succeededbool

A boolean representing the (expected) success or fail of a matrx.actions.object_actions.DropObjectAction.

See also

GrabObjectAction
__init__(self, result, succeeded, obj_id=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, result, succeeded[, obj_id])

Initialize self.

Attributes

ACTION_NOT_POSSIBLE

ACTION_SUCCEEDED

AGENT_NOT_CAPABLE

AGENT_WAS_REMOVED

IDLE_ACTION

NO_ACTION_GIVEN

RESULT_AGENT

Result when the specified object should be dropped on an intraversable object.

RESULT_NONE_GIVEN

Result when the specified object should be dropped on an agent.

RESULT_NO_OBJECT

Result when the specified object is not in the agent’s inventory.

RESULT_NO_OBJECT_CARRIED

RESULT_OBJECT

Result when the specified object does not exist (anymore).

RESULT_SUCCESS

Result when there is not object in the agent’s inventory.

RESULT_UNKNOWN_OBJECT_TYPE

Result when the agent is not carrying anything.

UNKNOWN_ACTION