Fix gameplay tests (#1041)

Author: 4ian

.gitignore

@@ -6,3 +6,5 @@
 # Artefacts written next to a game by the gameplay test runner.
 gameplay-test-results.json
 gameplay-test-screenshots/
+/gameplay-tests-artifacts
+/gameplay-tests-results

__tests__/post-build/__snapshots__/exampleShortHeaders.json.spec.js.snap

@@ -209,6 +209,7 @@ Object {
     "Mathematical tools",
     "Objects",
     "Scene",
+    "Timers and time",
     "Variables",
     "Debugger Tools",
     "Objects with effects",

examples/starting-platformer-pixel/starting-platformer-pixel.json

@@ -1259,12 +1259,13 @@
       ]
     },
     {
-      "description": "The player runs to the ledge holding the coins, jumps onto it, and collects every coin it touches.",
+      "description": "The player drops off its starting platform onto the row of coins on the ground, then runs right and jumps onto the ledge to collect the rest.",
       "name": "Collecting the coins by running into them",
       "type": "gameplay",
       "source": [
-        "// Coins are picked up by touching them. They sit on a ledge above the ground",
-        "// the player starts on: it has to run there and jump onto it.",
+        "// Coins are picked up by touching them. They come in two rows: one on the",
+        "// ground below the platform the player starts on, and one on a ledge above",
+        "// the ground, further right.",
         "await harness.goToScene('Game Scene');",
         "harness.watch('Coins');",
         "",
@@ -1290,34 +1291,102 @@
         "  'Standing still collects no coin.'",
         ");",
         "",
-        "// Run right, jumping while the coins ahead are out of reach above.",
+        "// The two rows are told apart by their height: the ground row is well below",
+        "// the player's starting platform, the ledge row only a little (the ledge is",
+        "// lower than the platform).",
+        "const groundCoinIds = harness",
+        "  .getObjects('Coins')",
+        "  .filter((coin) => coin.centerY > startY + 60)",
+        "  .map((coin) => coin.id);",
+        "const groundRowIsCollected = () => {",
+        "  const remaining = coinIds();",
+        "  return groundCoinIds.every((id) => !remaining.includes(id));",
+        "};",
+        "harness.assert(",
+        "  groundCoinIds.length > 0,",
+        "  'There is a row of coins on the ground below the starting platform.'",
+        ");",
+        "",
+        "// The player cannot reach the ground row from up there: it first drops off",
+        "// the right edge of the platform and runs back left over the coins.",
+        "harness.setKeyPressed('Right', true);",
+        "const fell = await harness.stepUntil(() => !isOnFloor(), { maxFrames: 120 });",
+        "harness.assert(fell, 'Running right takes the player off the edge of the platform.');",
+        "const landedBelow = await harness.stepUntil(isOnFloor, { maxFrames: 120 });",
+        "harness.releaseAllInputs();",
+        "await harness.stepFrames(5);",
+        "harness.assert(landedBelow, 'The player lands on the ground below.');",
+        "",
+        "// Run back left, over the row of coins on the ground. Leaving the floor",
+        "// would mean the player missed them and ran off the level, so stop there.",
+        "harness.setKeyPressed('Left', true);",
+        "await harness.stepUntil(() => groundRowIsCollected() || !isOnFloor(), {",
+        "  maxFrames: 240,",
+        "});",
+        "// Brake with the opposite key: the level ends right after the last coin of",
+        "// the row, and just letting go would let the player slide off it.",
+        "harness.setKeyPressed('Left', false);",
+        "harness.setKeyPressed('Right', true);",
+        "await harness.stepFrames(10);",
+        "harness.releaseAllInputs();",
+        "",
+        "const playerAfterGroundRow = getPlayer();",
+        "console.log(",
+        "  'afterGroundRow playerX=' + Math.round(playerAfterGroundRow.centerX) +",
+        "    ' playerY=' + Math.round(playerAfterGroundRow.centerY) +",
+        "    ' coinsLeft=' + coinIds().length",
+        ");",
+        "harness.assert(",
+        "  groundRowIsCollected(),",
+        "  'Running over the row of coins on the ground collects every one of them (' +",
+        "    coinIds().filter((id) => groundCoinIds.includes(id)).length +",
+        "    ' were left behind, the player ended at x=' +",
+        "    Math.round(playerAfterGroundRow.centerX) + ').'",
+        ");",
+        "",
+        "// Run right toward the remaining coins. They sit on a ledge overhanging the",
+        "// end of the ground, so the player jumps while running well before reaching",
+        "// it, rises above it, and stops moving forward once past the start of the",
+        "// row of coins: it comes down onto the first coin of the row instead of",
+        "// flying over the whole ledge. Falling well below the ground would mean the",
+        "// player ran out of the level, so stop there.",
+        "const rowStartX = Math.min(",
+        "  ...harness.getObjects('Coins').map((coin) => coin.centerX)",
+        ");",
         "let jumpFramesLeft = 0;",
+        "let hasJumped = false;",
         "harness.setKeyPressed('Right', true);",
         "const collectedThemAll = await harness.stepUntil(",
-        "  () => coinIds().length === 0,",
+        "  () => coinIds().length === 0 || getPlayer().centerY > startY + 300,",
         "  {",
         "    maxFrames: 400,",
         "    onFrame: () => {",
         "      const player = getPlayer();",
         "      const onFloor =",
         "        player.behaviors.PlatformerObject.state.IsOnFloor === true;",
-        "      const nextCoin = harness.getNearby('Coins', 'Player', 5000)[0];",
         "",
         "      if (jumpFramesLeft > 0) {",
         "        jumpFramesLeft--;",
         "        if (jumpFramesLeft === 0) harness.setKeyPressed('Space', false);",
-        "        return;",
         "      }",
-        "      if (!onFloor || !nextCoin) return;",
-        "      const isAhead = nextCoin.centerX > player.centerX;",
-        "      const isAbove = player.centerY - nextCoin.centerY > 30;",
-        "      if (isAhead && isAbove) {",
-        "        harness.setKeyPressed('Space', true);",
-        "        jumpFramesLeft = 14;",
+        "      if (onFloor) {",
+        "        harness.setKeyPressed('Right', true);",
+        "        if (!hasJumped && rowStartX - player.centerX <= 100) {",
+        "          harness.setKeyPressed('Space', true);",
+        "          jumpFramesLeft = 20;",
+        "          hasJumped = true;",
+        "        }",
+        "      } else if (player.centerX >= rowStartX - 16) {",
+        "        harness.setKeyPressed('Right', false);",
         "      }",
         "    },",
         "  }",
         ");",
+        "// Brake with the opposite key here too: the ledge ends right after the last",
+        "// coin of its row.",
+        "harness.setKeyPressed('Right', false);",
+        "harness.setKeyPressed('Left', true);",
+        "await harness.stepFrames(10);",
         "harness.releaseAllInputs();",
         "await harness.stepFrames(5);",
         "",
@@ -1334,11 +1403,15 @@
         "    Math.round(player.centerY) + ', it started at y=' + Math.round(startY) + ').'",
         ");",
         "harness.assert(",
-        "  collectedThemAll,",
+        "  collectedThemAll && coinIds().length === 0,",
         "  'Running and jumping to the coins collects every one of them (' +",
         "    coinIds().length + ' were left behind, the player ended at x=' +",
         "    Math.round(player.centerX) + ').'",
-        ");"
+        ");",
+        "",
+        "// A picture of what the game looks like once this has happened, kept with",
+        "// the test results.",
+        "await harness.takeScreenshot('the level once every coin has been collected');"
       ]
     }
   ],

examples/starting-point-and-click-adventure/starting-point-and-click-adventure.json

@@ -1894,12 +1894,12 @@
       ]
     },
     {
-      "description": "Clicking an NPC next to the player opens the dialog, and saying yes makes that NPC leave.",
+      "description": "Clicking an NPC sends the player walking to it, reaching it opens the dialog, and saying yes makes the NPC leave.",
       "name": "Talking to an NPC and saying yes",
       "type": "gameplay",
       "source": [
-        "// Talking to an NPC: clicking one picks it, walking into it opens the",
-        "// dialog, and saying yes makes it leave.",
+        "// Talking to an NPC: clicking one picks it and sends the player walking",
+        "// there, walking into it opens the dialog, and saying yes makes it leave.",
         "await harness.goToScene('Game Scene');",
         "harness.watch('NPC');",
         "",
@@ -1926,30 +1926,28 @@
         "const npcsBefore = harness.getObjects('NPC').length;",
         "harness.assert(npcsBefore > 0, 'There are NPCs to talk to.');",
         "",
-        "// Click on an NPC the player is standing next to: clicking is what picks the",
-        "// NPC to talk to, and being next to it is what opens the dialog. The player",
-        "// is wide enough to touch two of the NPCs from where it spawns, so one of",
-        "// those is used and the dialog depends on the click alone.",
-        "const player = getPlayer();",
-        "const isWithinReach = (npc) =>",
-        "  Math.abs(npc.centerX - player.centerX) < (npc.width + player.width) / 2 &&",
-        "  Math.abs(npc.centerY - player.centerY) < (npc.height + player.height) / 2;",
-        "const npc = harness",
-        "  .getNearby('NPC', 'Player', 9000)",
-        "  .find((one) => isWithinReach(one));",
-        "harness.assert(!!npc, 'There is an NPC within reach to talk to.');",
+        "// Click on the nearest NPC. The characters' origins sit at their feet, so the",
+        "// NPC's own position is both a point on it (clicking there picks it as the",
+        "// one to talk to) and a walkable spot on the floor (where the same click",
+        "// sends the player).",
+        "const npc = harness.getNearby('NPC', 'Player', 9000)[0];",
+        "harness.assert(!!npc, 'There is an NPC to walk to.');",
         "console.log(",
-        "  'npc=' + npc.id + ' at ' + Math.round(npc.centerX) + ',' + Math.round(npc.centerY) +",
+        "  'npc=' + npc.id + ' feet at ' + Math.round(npc.x) + ',' + Math.round(npc.y) +",
         "    ' npcsBefore=' + npcsBefore",
         ");",
-        "await clickAt(npc.centerX, npc.centerY, npc.layer);",
+        "await clickAt(npc.x, npc.y, npc.layer);",
         "",
-        "const opened = await harness.stepUntil(isDialogOpen, { maxFrames: 60 });",
+        "// The dialog only opens once the player has walked all the way to the NPC.",
+        "const opened = await harness.stepUntil(isDialogOpen, { maxFrames: 300 });",
         "console.log(",
         "  'dialogOpened=' + opened +",
-        "    ' playerAt=' + Math.round(getPlayer().centerX) + ',' + Math.round(getPlayer().centerY)",
+        "    ' playerAt=' + Math.round(getPlayer().x) + ',' + Math.round(getPlayer().y)",
+        ");",
+        "harness.assert(",
+        "  opened,",
+        "  'Clicking an NPC sends the player to it, and the dialog opens when it gets there.'",
         ");",
-        "harness.assert(opened, 'Clicking the NPC the player stands next to opens the dialog.');",
         "harness.assert(",
         "  harness.getObjects('NPC').length === npcsBefore,",
         "  'Opening the dialog does not make the NPC leave on its own.'",