Method new_path

terminaltexteffects/engine/motion.py:365–406

Create a new Path and add it to the Motion.paths dictionary with the path_id as key. Args: speed (float, optional): speed > 0. Defaults to 1. ease (easing.EasingFunction | None, optional): easing function for character movement. Defaults to None. layer (i

(
        self,
        *,
        speed: float = 1,
        ease: easing.EasingFunction | None = None,
        layer: int | None = None,
        hold_time: int = 0,
        loop: bool = False,
        path_id: str = "",
    )

        self.current_coord = coord

    def new_path(
        self,
        *,
        speed: float = 1,
        ease: easing.EasingFunction | None = None,
        layer: int | None = None,
        hold_time: int = 0,
        loop: bool = False,
        path_id: str = "",
    ) -> Path:
        """Create a new Path and add it to the Motion.paths dictionary with the path_id as key.

        Args:
            speed (float, optional): speed > 0. Defaults to 1.
            ease (easing.EasingFunction | None, optional): easing function for character movement. Defaults to None.
            layer (int | None, optional): layer to move the character to, if None, layer is unchanged. Defaults to None.
            hold_time (int, optional): number of frames to hold the character at the end of the path. Defaults to 0.
            loop (bool, optional): Whether the path should loop back to the beginning. Default is False.
            path_id (str, optional): Unique identifier for the path. Used to query for the path. Defaults to "".

        Raises:
            DuplicatePathIDError: If a path with the provided id already exists.
            PathInvalidSpeedError: If `speed` is less than or equal to 0.

        Returns:
            Path: The new path.

        """
        if not path_id:
            found_unique = False
            current_id = len(self.paths)
            while not found_unique:
                path_id = f"{current_id}"
                if path_id not in self.paths:
                    found_unique = True
                else:
                    current_id += 1
        if path_id in self.paths:
            raise DuplicatePathIDError(path_id)
        new_path = Path(path_id, speed, ease, layer, hold_time, loop)
        self.paths[path_id] = new_path
        return new_path

    @typing.overload
    def query_path(self, path_id: str) -> Path: ...