reset.md

Replicants

Reset

The best way to reset a Replicant and the scene it is in is to do the following:

1. c.add_ons.clear() to clear all add-ons.
2. Redeclare every add-on, including the replicant: replicant = Replicant()
3. Append all add-ons, e.g. c.add_ons.append(replicant)
4. Load a new scene.

In this controller, we'll run several "trials" and reset the scene each time. To end the scene, we'll clear the add-ons to prevent them from resetting and then send {"$type": "terminate"}:

from tdw.controller import Controller
from tdw.tdw_utils import TDWUtils
from tdw.add_ons.replicant import Replicant
from tdw.add_ons.third_person_camera import ThirdPersonCamera
from tdw.add_ons.image_capture import ImageCapture
from tdw.replicant.action_status import ActionStatus
from tdw.backend.paths import EXAMPLE_CONTROLLER_OUTPUT_PATH


class Reset(Controller):
    """
    Run a series of trials and reset the scene each time.
    """

    def __init__(self, port: int = 1071, check_version: bool = True, launch_build: bool = True):
        super().__init__(port=port, check_version=check_version, launch_build=launch_build)
        self.replicant = Replicant()
        self.camera = ThirdPersonCamera(position={"x": 2, "y": 3, "z": 2.53},
                                        look_at=self.replicant.replicant_id,
                                        avatar_id="a")
        path = EXAMPLE_CONTROLLER_OUTPUT_PATH.joinpath("replicant_reset")
        print(f"Images will be saved to: {path}")
        self.capture = ImageCapture(avatar_ids=[self.camera.avatar_id], path=path)
        self.add_ons.extend([self.replicant, self.camera, self.capture])

    def trial(self, distance: float, index: int):
        # Reset all add-ons.
        self.add_ons.clear()
        self.replicant = Replicant()
        self.camera = ThirdPersonCamera(position={"x": 2, "y": 3, "z": 2.53},
                                        look_at=self.replicant.replicant_id,
                                        avatar_id="a")
        path = EXAMPLE_CONTROLLER_OUTPUT_PATH.joinpath(f"replicant_reset_{index}")
        print(f"Images will be saved to: {path}")
        self.capture = ImageCapture(avatar_ids=[self.camera.avatar_id], path=path)
        self.add_ons.extend([self.replicant, self.camera, self.capture])
        # Load a new scene.
        self.communicate([{"$type": "load_scene",
                           "scene_name": "ProcGenScene"},
                          TDWUtils.create_empty_room(12, 12)])
        self.replicant.move_by(distance=distance)
        while self.replicant.action.status == ActionStatus.ongoing:
            self.communicate([])
        self.communicate([])

    def end(self) -> None:
        # Clear the add-ons so that nothing tries to initialize when we terminate.
        self.add_ons.clear()
        self.communicate({"$type": "terminate"})


if __name__ == "__main__":
    c = Reset()
    for d, i in zip([1, 2, 3], [0, 1, 2]):
        c.trial(distance=d, index=i)
    c.end()

Result:

---

This is the last document in the "Replicants" tutorial.

Return to the README

---

Example controllers:

• reset.py Run a series of trials and reset the scene each time.

Python API:

• Replicant