matrx.actions.door_actions.OpenDoorActionResult

class OpenDoorActionResult(result, succeeded)

ActionResult for the OpenDoorAction.

The results uniquely for matrx.actions.door_actions.OpenDoorAction are (as class constants):

  • RESULT_SUCCESS: When the action is a success.

  • NO_DOORS_IN_RANGE: When no door objects are within the specified range.

  • NOT_IN_RANGE: When the given object_id is not within the specified range.

  • NOT_A_DOOR: When the given object_id does not exist.

  • DOOR_ALREADY_OPEN: When the door is already open.

  • NO_OBJECT_SPECIFIED: When object_id is not given.

Parameters
resultstr

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

succeededbool

A boolean representing the (expected) success or fail of an matrx.actions.door_actions.OpenDoorAction.

See also

OpenDoorAction
__init__(self, result, succeeded)

ActionResult for the OpenDoorAction.

The results uniquely for matrx.actions.door_actions.OpenDoorAction are (as class constants):

  • RESULT_SUCCESS: When the action is a success.

  • NO_DOORS_IN_RANGE: When no door objects are within the specified range.

  • NOT_IN_RANGE: When the given object_id is not within the specified range.

  • NOT_A_DOOR: When the given object_id does not exist.

  • DOOR_ALREADY_OPEN: When the door is already open.

  • NO_OBJECT_SPECIFIED: When object_id is not given.

Parameters
resultstr

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

succeededbool

A boolean representing the (expected) success or fail of an matrx.actions.door_actions.OpenDoorAction.

See also

OpenDoorAction

Methods

__init__(self, result, succeeded)

ActionResult for the OpenDoorAction.

Attributes

ACTION_NOT_POSSIBLE

ACTION_SUCCEEDED

AGENT_NOT_CAPABLE

AGENT_WAS_REMOVED

DOOR_ALREADY_OPEN

DOOR_BLOCKED

IDLE_ACTION

NOT_A_DOOR

NOT_IN_RANGE

NO_ACTION_GIVEN

NO_DOORS_IN_RANGE

NO_OBJECT_SPECIFIED

RESULT_SUCCESS

RESULT_UNKNOWN_OBJECT_TYPE

UNKNOWN_ACTION