GDevelop/Extensions/PathfindingBehavior/tests/commonpathfindingruntimebehavior.spec.js

// @ts-check
describe('gdjs.PathfindingRuntimeBehavior', function () {
  // tests cases where every collisionMethod has the same behavior.
  let doCommonPathFindingTests = (
    collisionMethod,
    allowDiagonals,
    smoothingMaxCellGap
  ) => {
    const pathFindingName = 'auto1';

    const createScene = (framePerSecond = 60) => {
      const runtimeGame = gdjs.getPixiRuntimeGame();
      const runtimeScene = new gdjs.RuntimeScene(runtimeGame);
      runtimeScene.loadFromScene({
        sceneData: {
          layers: [
            {
              name: '',
              visibility: true,
              effects: [],
              cameras: [],

              ambientLightColorR: 0,
              ambientLightColorG: 0,
              ambientLightColorB: 0,
              isLightingLayer: false,
              followBaseLayerCamera: true,
            },
          ],
          variables: [],
          r: 0,
          v: 0,
          b: 0,
          mangledName: 'Scene1',
          name: 'Scene1',
          stopSoundsOnStartup: false,
          title: '',
          behaviorsSharedData: [],
          objects: [],
          objectsGroups: [],
          instances: [],
          usedResources: [],
          uiSettings: {
            grid: false,
            gridType: 'rectangular',
            gridWidth: 10,
            gridHeight: 10,
            gridDepth: 10,
            gridOffsetX: 0,
            gridOffsetY: 0,
            gridOffsetZ: 0,
            gridColor: 0,
            gridAlpha: 1,
            snap: false,
          },
        },
        usedExtensionsWithVariablesData: [],
      });
      setFramePerSecond(runtimeScene, framePerSecond);
      return runtimeScene;
    };
    const setFramePerSecond = (runtimeScene, framePerSecond) => {
      runtimeScene._timeManager.getElapsedTime = function () {
        return 1000 / framePerSecond;
      };
    };

    const addPlayer = (runtimeScene) => {
      const player = new gdjs.RuntimeObject(
        runtimeScene,
        {
          name: 'player',
          type: '',
          behaviors: [
            {
              type: 'PathfindingBehavior::PathfindingBehavior',
              name: 'auto1',
              // @ts-ignore - properties are not typed
              allowDiagonals: allowDiagonals,
              acceleration: 400,
              maxSpeed: 200,
              angularMaxSpeed: 180,
              rotateObject: false,
              angleOffset: 0,
              cellWidth: 20,
              cellHeight: 20,
              extraBorder: 0,
              smoothingMaxCellGap: smoothingMaxCellGap,
              collisionMethod: collisionMethod,
            },
          ],
          effects: [],
          variables: [],
        },
        undefined
      );
      player.getWidth = function () {
        return 90;
      };
      player.getHeight = function () {
        return 90;
      };
      runtimeScene.addObject(player);
      return player;
    };

    const addObstacle = (runtimeScene) => {
      const obstacle = new gdjs.RuntimeObject(
        runtimeScene,
        {
          name: 'obstacle',
          type: '',
          behaviors: [
            {
              type: 'PathfindingBehavior::PathfindingObstacleBehavior',
              // @ts-ignore - properties are not typed
              impassable: true,
              cost: 2,
            },
          ],
          effects: [],
          variables: [],
        },
        undefined
      );
      obstacle.getWidth = function () {
        return 100;
      };
      obstacle.getHeight = function () {
        return 100;
      };
      runtimeScene.addObject(obstacle);
      return obstacle;
    };

    const getPathLength = (player) => {
      /** @type gdjs.PathfindingRuntimeBehavior */
      const behavior = player.getBehavior(pathFindingName);
      if (behavior.getNodeCount() < 2) {
        return 0;
      }
      let pathLength = 0;
      let previousNodeX = behavior.getNodeX(0);
      let previousNodeY = behavior.getNodeY(0);
      for (let index = 1; index < behavior.getNodeCount(); index++) {
        const nodeX = behavior.getNodeX(index);
        const nodeY = behavior.getNodeY(index);
        pathLength += Math.hypot(nodeX - previousNodeX, nodeY - previousNodeY);
        previousNodeX = nodeX;
        previousNodeY = nodeY;
      }
      return pathLength;
    };

    let runtimeScene;
    let player;
    beforeEach(function () {
      runtimeScene = createScene();
      player = addPlayer(runtimeScene);
    });

    it('can find a path without any obstacle at all', function () {
      player.setPosition(480, 300);
      player.getBehavior(pathFindingName).moveTo(runtimeScene, 720, 300);
      expect(player.getBehavior(pathFindingName).pathFound()).to.be(true);
      expect(getPathLength(player)).to.be(720 - 480);
    });

    it('can find a path without any obstacle in the way', function () {
      const obstacle = addObstacle(runtimeScene);

      obstacle.setPosition(100, 100);
      // To ensure obstacles are registered.
      runtimeScene.renderAndStep(1000 / 60);

      player.setPosition(480, 300);
      player.getBehavior(pathFindingName).moveTo(runtimeScene, 720, 300);
      expect(player.getBehavior(pathFindingName).pathFound()).to.be(true);
      expect(getPathLength(player)).to.be(720 - 480);
    });

    it("mustn't find a path to the obstacle inside", function () {
      const obstacle = addObstacle(runtimeScene);

      obstacle.setPosition(600, 300);
      // To ensure obstacles are registered.
      runtimeScene.renderAndStep(1000 / 60);

      player.setPosition(480, 300);
      player.getBehavior(pathFindingName).moveTo(runtimeScene, 650, 350);
      expect(player.getBehavior(pathFindingName).pathFound()).to.be(false);
    });

    it('can find a path with an obstacle in the way', function () {
      const obstacle = addObstacle(runtimeScene);

      obstacle.setPosition(600, 300);
      // To ensure obstacles are registered.
      runtimeScene.renderAndStep(1000 / 60);

      player.setPosition(480, 300);
      player.getBehavior(pathFindingName).moveTo(runtimeScene, 720, 300);
      expect(player.getBehavior(pathFindingName).pathFound()).to.be(true);
      expect(getPathLength(player)).to.be.above(720 - 480 + 50);
    });

    it('can find a path between 2 obstacles', function () {
      const obstacleTop = addObstacle(runtimeScene);
      const obstacleBottom = addObstacle(runtimeScene);

      obstacleTop.setPosition(600, 180);
      obstacleBottom.setPosition(600, 420);
      // To ensure obstacles are registered.
      runtimeScene.renderAndStep(1000 / 60);

      player.setPosition(480, 300);
      player.getBehavior(pathFindingName).moveTo(runtimeScene, 720, 300);
      expect(player.getBehavior(pathFindingName).pathFound()).to.be(true);
      expect(getPathLength(player)).to.be(720 - 480);
    });

    it("mustn't find a path to a closed room", function () {
      const obstacleTop = addObstacle(runtimeScene);
      const obstacleBottom = addObstacle(runtimeScene);
      const obstacleLeft = addObstacle(runtimeScene);
      const obstacleRight = addObstacle(runtimeScene);

      obstacleTop.setPosition(600, 180);
      obstacleBottom.setPosition(600, 420);
      obstacleLeft.setPosition(480, 300);
      obstacleRight.setPosition(720, 300);
      // To ensure obstacles are registered.
      runtimeScene.renderAndStep(1000 / 60);

      player.setPosition(360, 300);
      player.getBehavior(pathFindingName).moveTo(runtimeScene, 600, 300);
      expect(player.getBehavior(pathFindingName).pathFound()).to.be(false);
    });
  };

  ['Legacy'].forEach((collisionMethod) => {
    describe(`(collisionMethod: ${collisionMethod}, `, function () {
      [false, true].forEach((allowDiagonals) => {
        describe(`(allowDiagonals: ${allowDiagonals})`, function () {
          [0, 1].forEach((smoothingMaxCellGap) => {
            describe(`(smoothingMaxCellGap: ${smoothingMaxCellGap})`, function () {
              doCommonPathFindingTests(
                collisionMethod,
                allowDiagonals,
                smoothingMaxCellGap
              );
            });
          });
        });
      });
    });
  });
});