ags3/ags4-auto-test: add character direct move tests

Author: ivan-mogilko

ags3/auto-test/test-characters.asc

@@ -1,14 +1,65 @@
 // Test Characters Module Script
 int GetTestCharactersCount()
 {
-  return 8 + 8
-  + 24 * 3 // turn on spot animating
-  + 8 * 3  // idle start time
+  return 0
   + 1 // graphic pos
   + 4 // view frames
+  + 8 + 8  // direction loops and instant turning
+  + 24 * 3 // turn on spot animating
+  + 8 * 3  // idle start time
+  + 12 * 3 // direct move
+  + 7 // waypoints move
   ;
 }
 
+//int test_render_num;
+void _TestCharRenderF(Character *testChar, int sprite_num, eFlipDirection flip, const string test_name)
+{
+  Wait(1); // let engine redraw
+  // IMPORTANT: AGS 3.* has a historical mistake where the object's sprite is drawn 1 pixel higher than necessary
+  int sprite_w = Game.SpriteWidth[sprite_num];
+  int sprite_h = Game.SpriteHeight[sprite_num];
+  int sprite_x = testChar.x - sprite_w / 2;
+  int sprite_y = testChar.y - sprite_h;
+  //tap.Comment(String.Format("sprite_x = %d, sprite_y = %d, sprite_w = %d, sprite_h = %d", sprite_x, sprite_y, sprite_w, sprite_h));
+  //SaveScreenShot(String.Format("_%d.bmp", test_render_num));
+  //test_render_num++;
+  tap.ok(GfxComparer.TakeScreenshotAndMatchSprite(sprite_x, sprite_y, sprite_w, sprite_h, sprite_num, flip), test_name);
+}
+
+void _TestCharRender(Character *testChar, int sprite_num, const string test_name)
+{
+  _TestCharRenderF(testChar, sprite_num, -1, test_name);
+}
+
+void _TestCharViewFrame(Character *testChar, int view, int loop, int frame, const string test_name)
+{
+  testChar.LockViewFrame(view, loop, frame);
+  ViewFrame* vf = Game.GetViewFrame(view, loop, frame);
+  eFlipDirection flip = -1;
+  if (vf.Flipped)
+    flip = eFlipLeftToRight;
+  _TestCharRenderF(testChar, vf.Graphic, flip, test_name);
+  testChar.UnlockView();
+}
+
+#define SPRITE_DEFAULT 9
+
+void TestGraphicPosition()
+{
+  cWalker1.LockViewFrame(VFLIP, 0, 0);
+  _TestCharRender(cWalker1, SPRITE_DEFAULT, "Character: graphic position");
+  cWalker1.UnlockView();
+}
+
+void TestViewRender()
+{
+  _TestCharViewFrame(cWalker1, VFLIP, 0, 0, "Character: view frame 0, normal");
+  _TestCharViewFrame(cWalker1, VFLIP, 0, 1, "Character: view frame 1, normal");
+  _TestCharViewFrame(cWalker1, VFLIP, 0, 2, "Character: view frame 2, h-flip");
+  _TestCharViewFrame(cWalker1, VFLIP, 0, 3, "Character: view frame 3, h-flip");
+}
+
 void TestChangingDirectionLoop()
 {
   Character* turner = cWalker2;
@@ -234,52 +285,107 @@ void TestIdleViewStart()
   TestIdleStartsInTime(idler, idle_start_delay, "after custom animate", 0, true);
 }
 
-//int test_render_num;
-void _TestCharRenderF(Character *testChar, int sprite_num, eFlipDirection flip, const string test_name)
-{
-  Wait(1); // let engine redraw
-  // IMPORTANT: AGS 3.* has a historical mistake where the object's sprite is drawn 1 pixel higher than necessary
-  int sprite_w = Game.SpriteWidth[sprite_num];
-  int sprite_h = Game.SpriteHeight[sprite_num];
-  int sprite_x = testChar.x - sprite_w / 2;
-  int sprite_y = testChar.y - sprite_h;
-  //tap.Comment(String.Format("sprite_x = %d, sprite_y = %d, sprite_w = %d, sprite_h = %d", sprite_x, sprite_y, sprite_w, sprite_h));
-  //SaveScreenShot(String.Format("_%d.bmp", test_render_num));
-  //test_render_num++;
-  tap.ok(GfxComparer.TakeScreenshotAndMatchSprite(sprite_x, sprite_y, sprite_w, sprite_h, sprite_num, flip), test_name);
-}
-
-void _TestCharRender(Character *testChar, int sprite_num, const string test_name)
-{
-  _TestCharRenderF(testChar, sprite_num, -1, test_name);
-}
-
-void _TestCharViewFrame(Character *testChar, int view, int loop, int frame, const string test_name)
+void TestMoveDirect(Character* walker, String test_name, int sx, int sy, int dx, int dy, bool use_walk, BlockingStyle style)
 {
-  testChar.LockViewFrame(view, loop, frame);
-  ViewFrame* vf = Game.GetViewFrame(view, loop, frame);
-  eFlipDirection flip = -1;
-  if (vf.Flipped)
-    flip = eFlipLeftToRight;
-  _TestCharRenderF(testChar, vf.Graphic, flip, test_name);
-  testChar.UnlockView();
+  walker.x = sx;
+  walker.y = sy;
+  if (use_walk)
+  {
+    walker.Walk(dx, dy, style, eAnywhere);
+  }
+  else
+  {
+    walker.Move(dx, dy, style, eAnywhere);
+  }
+  if (style == eNoBlock)
+  {
+    while (walker.Moving) Wait(1);
+  }
+  tap.ok(!walker.Moving, String.Format("%s: finished move", test_name));
+  tap.is_int(walker.x, dx, String.Format("%s: destination x", test_name));
+  tap.is_int(walker.y, dy, String.Format("%s: destination y", test_name));
 }
 
-#define SPRITE_DEFAULT 9
-
-void TestGraphicPosition()
+void TestMoveDirectToWaypoint(Character* walker, String test_name, int p_start, int p_end, int t_const, bool x_axis)
 {
-  cWalker1.LockViewFrame(VFLIP, 0, 0);
-  _TestCharRender(cWalker1, SPRITE_DEFAULT, "Character: graphic position");
-  cWalker1.UnlockView();
+  int p_range1, p_range2;
+  if (p_start <= p_end)
+  {
+    p_range1 = p_start;
+    p_range2 = p_end;
+  }
+  else
+  {
+    p_range1 = p_end;
+    p_range2 = p_start;
+  }
+  
+  bool p_coords_in_range = true;
+  bool t_coords_const = true;
+  while (walker.Moving && (x_axis && walker.x != p_end) || (!x_axis && walker.y != p_end))
+  {
+    if (x_axis)
+    {
+      if (!(walker.x >= p_range1 && walker.x <= p_range2))
+      {
+        p_coords_in_range = false;
+      }
+      if (walker.x != p_end && walker.y != t_const)
+      {
+        t_coords_const = false;
+      }
+    }
+    else
+    {
+      if (!(walker.y >= p_range1 && walker.y <= p_range2))
+      {
+        p_coords_in_range = false;
+      }
+      if (walker.y != p_end && walker.x != t_const)
+      {
+        t_coords_const = false;
+      }
+    }
+    
+    Wait(1);
+  }
+  tap.ok(p_coords_in_range && t_coords_const, String.Format("%s: move position stayed in range", test_name));
+  // NOTE: we cannot test exact coords here, because character may already be turned and start moving towards next waypoint
 }
 
-void TestViewRender()
+// Tests moving and walking WITHOUT pathfinding (eAnywhere), 
+// only for the sake of testing the fact of movement itself.
+void TestSimpleMovement(Character* walker)
 {
-  _TestCharViewFrame(cWalker1, VFLIP, 0, 0, "Character: view frame 0, normal");
-  _TestCharViewFrame(cWalker1, VFLIP, 0, 1, "Character: view frame 1, normal");
-  _TestCharViewFrame(cWalker1, VFLIP, 0, 2, "Character: view frame 2, h-flip");
-  _TestCharViewFrame(cWalker1, VFLIP, 0, 3, "Character: view frame 3, h-flip");
+  // Move
+  TestMoveDirect(walker, "Character.Move eBlock Hor", 0, 0, 100, 0, false, eBlock);
+  TestMoveDirect(walker, "Character.Move eBlock Ver", 0, 0, 0, 100, false, eBlock);
+  TestMoveDirect(walker, "Character.Move eBlock Diag", 0, 0, 100, 100, false, eBlock);
+  TestMoveDirect(walker, "Character.Move eNoBlock Hor", 0, 0, 100, 0, false, eNoBlock);
+  TestMoveDirect(walker, "Character.Move eNoBlock Ver", 0, 0, 0, 100, false, eNoBlock);
+  TestMoveDirect(walker, "Character.Move eNoBlock Diag", 0, 0, 100, 100, false, eNoBlock);
+  // Walk
+  TestMoveDirect(walker, "Character.Walk eBlock Hor", 0, 0, 100, 0, true, eBlock);
+  TestMoveDirect(walker, "Character.Walk eBlock Ver", 0, 0, 0, 100, true, eBlock);
+  TestMoveDirect(walker, "Character.Walk eBlock Diag", 0, 0, 100, 100, true, eBlock);
+  TestMoveDirect(walker, "Character.Walk eNoBlock Hor", 0, 0, 100, 0, true, eNoBlock);
+  TestMoveDirect(walker, "Character.Walk eNoBlock Ver", 0, 0, 0, 100, true, eNoBlock);
+  TestMoveDirect(walker, "Character.Walk eNoBlock Diag", 0, 0, 100, 100, true, eNoBlock);
+  
+  // AddWaypoint
+  walker.x = 0;
+  walker.y = 0;
+  walker.AddWaypoint(100, 0);
+  walker.AddWaypoint(100, 100);
+  walker.AddWaypoint(0, 100);
+  walker.AddWaypoint(0, 0);
+  TestMoveDirectToWaypoint(walker, "Character.AddWaypoint 0,0->1,0", 0, 100, 0, true);
+  TestMoveDirectToWaypoint(walker, "Character.AddWaypoint 1,0->1,1", 0, 100, 100, false);
+  TestMoveDirectToWaypoint(walker, "Character.AddWaypoint 1,1->0,1", 100, 0, 100, true);
+  TestMoveDirectToWaypoint(walker, "Character.AddWaypoint 0,1->0,0", 100, 0, 0, false);
+  tap.ok(!walker.Moving, String.Format("%s: finished move", "Character.AddWaypoint"));
+  tap.is_int(walker.x, 0, String.Format("%s: destination x", "Character.AddWaypoint"));
+  tap.is_int(walker.y, 0, String.Format("%s: destination y", "Character.AddWaypoint"));
 }
 
 void TestCharacters()
@@ -288,14 +394,6 @@ void TestCharacters()
   int old_game_speed = GetGameSpeed();
   SetGameSpeed(1000);
 
-  cWalker1.on = true;
-  cWalker2.on = true;
-  
-  TestChangingDirectionLoop();
-  TestTurnOnSpotInstant();
-  TestTurnOnSpotAnimating();
-  TestIdleViewStart();
-  
   // Disable characters and objects, avoid interfering with our tests
   for (int i = 0; i < Game.CharacterCount; i++)
     character[i].on = false;
@@ -313,6 +411,15 @@ void TestCharacters()
   TestGraphicPosition();
   TestViewRender();
 
+  cWalker1.on = true;
+  cWalker2.on = true;
+  
+  TestChangingDirectionLoop();
+  TestTurnOnSpotInstant();
+  TestTurnOnSpotAnimating();
+  TestIdleViewStart();
+  TestSimpleMovement(cWalker1);
+  
   SetGameSpeed(old_game_speed);
   tap.Comment("end Character tests");
 }