Added New wait-move Script (JaylyDev#259)

chronoByte4812 · web-flow · commit e42e51450460 · 2023-06-07T19:15:52.000+01:00
* Create index.js

Added New wait-move Script

* Create README.md

* Merge branch 'main' into pr/259

* Update jsconfig.json

* Update index.js
diff --git a/scripts/wait-move/README.md b/scripts/wait-move/README.md
@@ -0,0 +1,33 @@
+# wait-move
+
+## Description
+
+When a wait-move is set, it will run code once the player has moved.
+
+**Parameters:**
+
+- `player` (type: Player or entity): The player or entity for which the function will be executed on.
+
+- `x` (type: number): The X-coordinate of the destination of the player's current location.
+
+- `y` (type: number): The Y-coordinate of the destination of the player's current location.
+
+- `z` (type: number): The Z-coordinate of the destination of the player's current location.
+
+- `callback` (type: function): The callback function to be executed once the player has moved.
+
+**Example:**
+
+```js
+
+waitMove(player, x, y, z, (target) => {
+
+    target.sendMessage('You have moved!');
+
+});
+
+```
+
+## Credits
+
+These scripts were written by [defowler2005](https://github.com/defowler2005).
diff --git a/scripts/wait-move/index.js b/scripts/wait-move/index.js
@@ -0,0 +1,59 @@
+// Script example for ScriptAPI
+// Author: defowler2005 <https://github.com/defowler2005>
+// Project: https://github.com/JaylyDev/ScriptAPI
+/**
+
+ * Minecraft Bedrock ScriptAPI Example
+
+ * @license Do what ever you want
+
+ * @author defowler2005#4812
+
+ * @version 1.0.0
+
+ * ---------------------------------------------------------------------------
+
+ * This is a waitMove function, It logged the players x, y, z coordinates-
+
+ * with the player's current coordinates in aystem.runInterval(() => {});
+
+ * This is ideal for ui forms in chat commands!
+
+ * ---------------------------------------------------------------------------
+
+ */
+
+import { world, system, Entity } from '@minecraft/server';
+
+/**
+ * @param {Entity} target
+ * @param {number} x
+ * @param {number} y
+ * @param {number} z
+ * @param {(arg0: Entity) => void} callback
+ */
+export function waitMove(target, x, y, z, callback) {
+
+  const t = new Map();
+
+  t.set(target, [x, y, z]);
+
+  system.runInterval(() => {
+
+    for (const [target, [xOld, yOld, zOld]] of t) {
+
+      const { x: xc, y: yc, z: zc } = target.location;
+
+      if (xOld !== xc || yOld !== yc || zOld !== zc) {
+
+        t.delete(target);
+
+        callback(target);
+
+      }
+
+    }
+
+  })
+
+};
