Merge pull request #1627 from pau-tomas/feat/wait-event-variables

Add support for value field to Wait event

Author: chrismaltby

CHANGELOG.md

@@ -34,6 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Improved collision handling for ladders and one-way platforms in the Platformer scene type. Ladders now use the player's bottom edge for anchoring, and one-way platforms no longer snap the player to the platform when colliding from below [@Steinbeuge](https://github.com/Steinbeuge)
 - Ladder collision tile now only visible on Platform scenes by default, edit `engine.json` to add per scene collision tile types
 - New instances of prefabs use prefab's name by default
+- Update "Wait" event to support using variable values for wait time [@pau-tomas](https://github.com/pau-tomas))
 - Updated Polish localisation. [@ReptiIe](https://github.com/ReptiIe)
 - Updated Japanese localisation. [@tomo666](https://github.com/tomo666)
 

src/components/forms/ValueSelect.tsx

@@ -45,6 +45,7 @@ import ScriptEventFormMathArea from "components/script/ScriptEventFormMatharea";
 import { ActorDirection } from "shared/lib/entities/entitiesTypes";
 import {
   castEventToBool,
+  castEventToFloat,
   castEventToInt,
 } from "renderer/lib/helpers/castEventValue";
 import l10n, { L10NKey } from "shared/lib/lang/l10n";
@@ -944,7 +945,10 @@ const ValueSelect = ({
                 onChange={(e) => {
                   onChange({
                     type: "number",
-                    value: castEventToInt(e, 0),
+                    value:
+                      (step ?? 1) % 1 === 0
+                        ? castEventToInt(e, 0)
+                        : castEventToFloat(e, 0),
                   });
                 }}
                 onKeyDown={onKeyDown}

src/lib/compiler/scriptBuilder.ts

@@ -16,6 +16,7 @@ import type {
   ScriptEvent,
   CustomEvent,
   SoundData,
+  TimeUnitType,
 } from "shared/lib/entities/entitiesTypes";
 import type { EngineFieldSchema } from "store/features/engine/engineState";
 import type { SettingsState } from "store/features/settings/settingsState";
@@ -3952,6 +3953,40 @@ extern void __mute_mask_${symbol};
     this._addNL();
   };
 
+  waitScriptValue = (duration: ScriptValue, units: TimeUnitType) => {
+    const waitArgsRef = this._declareLocal("wait_args", 1, true);
+    const stackPtr = this.stackPtr;
+    const [rpnOps, fetchOps] = precompileScriptValue(
+      optimiseScriptValue(duration)
+    );
+    if (rpnOps.length === 1 && rpnOps[0].type === "number") {
+      const frames =
+        units === "time" ? Math.ceil(rpnOps[0].value * 60) : rpnOps[0].value;
+      this._addComment(`Wait ${frames} frames`);
+      if (frames < 5) {
+        for (let i = 0; i < frames; i++) {
+          this._idle();
+        }
+      } else {
+        this._setConst(waitArgsRef, Math.round(frames));
+        this._invoke("wait_frames", 0, waitArgsRef);
+      }
+    } else {
+      this._addComment(`Wait frames ${units}`);
+      const localsLookup = this._performFetchOperations(fetchOps);
+      const rpn = this._rpn();
+      this._performValueRPN(rpn, rpnOps, localsLookup);
+      if (units === "time") {
+        rpn.int16(60);
+        rpn.operator(".MUL");
+      }
+      rpn.refSetVariable(waitArgsRef).stop();
+      this._invoke("wait_frames", 0, waitArgsRef);
+    }
+    this._assertStackNeutral(stackPtr);
+    this._addNL();
+  };
+
   // --------------------------------------------------------------------------
   // UI
 

src/lib/events/eventWait.js

@@ -18,62 +18,56 @@ const autoLabel = (fetchArg, input) => {
 
 const fields = [
   {
-    type: "group",
-    fields: [
+    key: "time",
+    label: l10n("FIELD_DURATION"),
+    description: l10n("FIELD_DURATION_WAIT_DESC"),
+    type: "value",
+    min: 0,
+    max: 60,
+    step: 0.1,
+    unitsField: "units",
+    unitsDefault: "time",
+    unitsAllowed: ["time", "frames"],
+    defaultValue: {
+      type: "number",
+      value: 0.5,
+    },
+    conditions: [
       {
-        key: "time",
-        type: "number",
-        label: l10n("FIELD_DURATION"),
-        description: l10n("FIELD_DURATION_WAIT_DESC"),
-        min: 0,
-        max: 60,
-        step: 0.1,
-        defaultValue: 0.5,
-        unitsField: "units",
-        unitsDefault: "time",
-        unitsAllowed: ["time", "frames"],
-        conditions: [
-          {
-            key: "units",
-            ne: "frames",
-          },
-        ],
+        key: "units",
+        ne: "frames",
       },
+    ],
+  },
+  {
+    key: "frames",
+    label: l10n("FIELD_DURATION"),
+    description: l10n("FIELD_DURATION_WAIT_DESC"),
+    type: "value",
+    min: 0,
+    max: 3600,
+    width: "50%",
+    unitsField: "units",
+    unitsDefault: "time",
+    unitsAllowed: ["time", "frames"],
+    defaultValue: {
+      type: "number",
+      value: 1,
+    },
+    conditions: [
       {
-        key: "frames",
-        label: l10n("FIELD_DURATION"),
-        description: l10n("FIELD_DURATION_WAIT_DESC"),
-        type: "number",
-        min: 0,
-        max: 3600,
-        width: "50%",
-        defaultValue: 30,
-        unitsField: "units",
-        unitsDefault: "time",
-        unitsAllowed: ["time", "frames"],
-        conditions: [
-          {
-            key: "units",
-            eq: "frames",
-          },
-        ],
+        key: "units",
+        eq: "frames",
       },
     ],
   },
 ];
 
 const compile = (input, helpers) => {
-  const { wait } = helpers;
-  let frames = 0;
-  if (input.units === "frames") {
-    frames = typeof input.frames === "number" ? input.frames : 30;
-  } else {
-    const seconds = typeof input.time === "number" ? input.time : 0.5;
-    frames = Math.ceil(seconds * 60);
-  }
-  if (frames > 0) {
-    wait(frames);
-  }
+  const { waitScriptValue } = helpers;
+  const duration =
+    input.units === "frames" ? input.frames ?? 1 : input.time ?? 0.5;
+  waitScriptValue(duration, input.units ?? "time");
 };
 
 module.exports = {

src/lib/project/migration/migrateProjectResources.ts

@@ -3,11 +3,12 @@ import {
   ProjectResourcesMigration,
   applyProjectResourcesMigration,
 } from "./helpers";
-import { migrate410r1To420r1 } from "./versions/410to420";
+import { migrate410r1To420r1, migrate420r1To420r2 } from "./versions/410to420";
 
 const migrations: ProjectResourcesMigration[] = [
   // 4.1.0 to 4.2.0
   migrate410r1To420r1,
+  migrate420r1To420r2,
 ];
 
 const lastMigration = migrations[migrations.length - 1];

src/lib/project/migration/versions/410to420.ts

@@ -34,3 +34,32 @@ export const migrate410r1To420r1: ProjectResourcesMigration = {
   to: { version: "4.2.0", release: "1" },
   migrationFn: createScriptEventsMigrator(migrateFrom410r1To420r1Event),
 };
+
+export const migrateFrom420r1To420r2Event: ScriptEventMigrationFn = (
+  scriptEvent
+) => {
+  if (scriptEvent.args && scriptEvent.command === "EVENT_WAIT") {
+    const args: Record<string, unknown> = { ...scriptEvent.args };
+    // Convert to constvalue
+    args["frames"] = {
+      type: "number",
+      value: typeof args["frames"] === "number" ? args["frames"] : 30,
+    };
+    args["time"] = {
+      type: "number",
+      value: typeof args["time"] === "number" ? args["time"] : 0.5,
+    };
+
+    return {
+      ...scriptEvent,
+      args,
+    };
+  }
+  return scriptEvent;
+};
+
+export const migrate420r1To420r2: ProjectResourcesMigration = {
+  from: { version: "4.2.0", release: "1" },
+  to: { version: "4.2.0", release: "2" },
+  migrationFn: createScriptEventsMigrator(migrateFrom420r1To420r2Event),
+};

test/events/eventWait.test.js

@@ -1,38 +1,52 @@
 import { compile } from "../../src/lib/events/eventWait";
 
 test("Should be able to wait for a second", () => {
-  const mockWait = jest.fn();
+  const mockWaitScriptValues = jest.fn();
   compile(
     {
       time: 1,
     },
     {
-      wait: mockWait,
+      waitScriptValue: mockWaitScriptValues,
     }
   );
-  expect(mockWait).toBeCalledWith(60);
+  expect(mockWaitScriptValues).toBeCalledWith(1, "time");
 });
 
 test("Should wait for half a second if time not set", () => {
-  const mockWait = jest.fn();
+  const mockWaitScriptValues = jest.fn();
   compile(
     {},
     {
-      wait: mockWait,
+      waitScriptValue: mockWaitScriptValues,
     }
   );
-  expect(mockWait).toBeCalledWith(30);
+  expect(mockWaitScriptValues).toBeCalledWith(0.5, "time");
 });
 
 test("Should be able to wait for one and a half seconds", () => {
-  const mockWait = jest.fn();
+  const mockWaitScriptValues = jest.fn();
   compile(
     {
       time: 1.5,
     },
     {
-      wait: mockWait,
+      waitScriptValue: mockWaitScriptValues,
     }
   );
-  expect(mockWait).toBeCalledWith(90);
+  expect(mockWaitScriptValues).toBeCalledWith(1.5, "time");
+});
+
+test("Should be able to wait for one frame", () => {
+  const mockWaitScriptValues = jest.fn();
+  compile(
+    {
+      frames: 1,
+      units: "frames",
+    },
+    {
+      waitScriptValue: mockWaitScriptValues,
+    }
+  );
+  expect(mockWaitScriptValues).toBeCalledWith(1, "frames");
 });