TurnTo

from tdw.replicant.actions.turn_to import TurnTo

Turn to a target object or position.

This is a non-animated action, meaning that the Replicant will immediately snap to the angle.

Fields

status The current status of the action. By default, this is ongoing (the action isn't done).
initialized If True, the action has initialized. If False, the action will try to send get_initialization_commands(resp) on this frame.
done If True, this action is done and won't send any more commands.

TurnTo(target)

Parameter	Type	Default	Description
target	TARGET		The target. If int: An object ID. If dict: A position as an x, y, z dictionary. If numpy array: A position as an [x, y, z] numpy array.

self.get_initialization_commands(resp, static, dynamic, image_frequency)

Parameter	Type	Description
resp	List[bytes]	The response from the build.
static	ReplicantStatic	The `ReplicantStatic` data that doesn't change after the Replicant is initialized.
dynamic	ReplicantDynamic	The `ReplicantDynamic` data that changes per `communicate()` call.
image_frequency	ImageFrequency	An `ImageFrequency` value describing how often image data will be captured.

Returns: A list of commands to initialize this action.

self.get_ongoing_commands(resp, static, dynamic)

Evaluate an action per-frame to determine whether it's done.

Parameter	Type	Description
resp	List[bytes]	The response from the build.
static	ReplicantStatic	The `ReplicantStatic` data that doesn't change after the Replicant is initialized.
dynamic	ReplicantDynamic	The `ReplicantDynamic` data that changes per `communicate()` call.

Returns: A list of commands to send to the build to continue the action.

self.get_end_commands(resp, static, dynamic, image_frequency)

Parameter	Type	Description
resp	List[bytes]	The response from the build.
static	ReplicantStatic	The `ReplicantStatic` data that doesn't change after the Replicant is initialized.
dynamic	ReplicantDynamic	The `ReplicantDynamic` data that changes per `communicate()` call.
image_frequency	ImageFrequency	An `ImageFrequency` value describing how often image data will be captured.

Returns: A list of commands that must be sent to end any action.