matrx.actions.door_actions.CloseDoorActionResult¶
-
class
CloseDoorActionResult
(result, succeeded)¶ ActionResult for the CloseDoorAction.
The results uniquely for
matrx.actions.action.door_actions.CloseDoorAction
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_CLOSED: When the door is already closed.
DOOR_BLOCKED: When another object is at the door’s location.
NO_OBJECT_SPECIFIED: When object_id is not given.
- Parameters
- resultstr
A string representing the reason for the (expected) success or fail of a
matrx.actions.door_actions.CloseDoorAction
.- succeededbool
A boolean representing the (expected) success or fail of a
matrx.actions.door_actions.CloseDoorAction
.
See also
-
__init__
(self, result, succeeded)¶ ActionResult for the CloseDoorAction.
The results uniquely for
matrx.actions.action.door_actions.CloseDoorAction
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_CLOSED: When the door is already closed.
DOOR_BLOCKED: When another object is at the door’s location.
NO_OBJECT_SPECIFIED: When object_id is not given.
- Parameters
- resultstr
A string representing the reason for the (expected) success or fail of a
matrx.actions.door_actions.CloseDoorAction
.- succeededbool
A boolean representing the (expected) success or fail of a
matrx.actions.door_actions.CloseDoorAction
.
See also
Methods
__init__
(self, result, succeeded)ActionResult for the CloseDoorAction.
Attributes
DOOR_ALREADY_CLOSED
DOOR_BLOCKED
NOT_A_DOOR
NOT_IN_RANGE
NO_ACTION_GIVEN
NO_DOORS_IN_RANGE
NO_OBJECT_SPECIFIED
RESULT_SUCCESS
RESULT_UNKNOWN_OBJECT_TYPE