@minecraft/server-gametest 1.0.0-beta.1.21.20-preview.21 → 1.0.0-beta.1.21.3-stable

package/index.d.ts

@@ -17,7 +17,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server-gametest",
- *   "version": "1.0.0-beta"
+ *   "version": "1.0.0-internal.1.21.3-stable"
  * }
  * ```
  *
@@ -1747,7 +1747,7 @@ export class Test {
      * Location of the fluid container block.
      * @param type
      * Type of fluid to set. See {@link
-     * @minecraft/server.FluidType} for a list of values.
+     * @minecraft/server-gametest.FluidType} for a list of values.
      * @throws This function can throw errors.
      *
      * {@link GameTestError}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-gametest",
-  "version": "1.0.0-beta.1.21.20-preview.21",
+  "version": "1.0.0-beta.1.21.3-stable",
   "description": "",
   "contributors": [
     {

package/tests.ts

@@ -0,0 +1,141 @@
+/* eslint-disable  @typescript-eslint/no-unused-vars */
+import * as mc from '@minecraft/server';
+
+export function simpleMobTest(log: (message: string, status?: number) => void, targetLocation: mc.Vector3) {
+    gt.register('StarterTests', 'simpleMobTest', (test: gt.Test) => {
+        const attackerId = 'fox';
+        const victimId = 'chicken';
+
+        test.spawn(attackerId, { x: 5, y: 2, z: 5 });
+        test.spawn(victimId, { x: 2, y: 2, z: 2 });
+
+        test.assertEntityPresentInArea(victimId, true);
+
+        test.succeedWhen(() => {
+            test.assertEntityPresentInArea(victimId, false);
+        });
+    })
+        .maxTicks(400)
+        .structureName('gametests:mediumglass');
+}
+
+export default class SampleManager {
+    tickCount = 0;
+
+    _availableFuncs: {
+        [name: string]: Array<(log: (message: string, status?: number) => void, location: mc.Vector3) => void>;
+    };
+
+    pendingFuncs: Array<{
+        name: string;
+        func: (log: (message: string, status?: number) => void, location: mc.Vector3) => void;
+        location: mc.Vector3;
+    }> = [];
+
+    gameplayLogger(message: string, status?: number) {
+        if (status !== undefined && status > 0) {
+            message = 'SUCCESS: ' + message;
+        } else if (status !== undefined && status < 0) {
+            message = 'FAIL: ' + message;
+        }
+
+        this.say(message);
+    }
+    say(message: string) {
+        mc.world.getDimension('overworld').runCommand('say ' + message);
+    }
+
+    newChatMessage(chatEvent: mc.ChatEvent) {
+        const message = chatEvent.message.toLowerCase();
+
+        if (message.startsWith('howto') && chatEvent.sender) {
+            const nearbyBlock = chatEvent.sender.getBlockFromViewVector();
+            if (!nearbyBlock) {
+                this.gameplayLogger('Please look at the block where you want me to run this.');
+                return;
+            }
+
+            const nearbyBlockLoc = nearbyBlock.location;
+            const nearbyLoc: mc.Vector3 = { x: nearbyBlockLoc.x, y: nearbyBlockLoc.y + 1, z: nearbyBlockLoc.z };
+
+            const sampleId = message.substring(5).trim();
+
+            if (sampleId.length < 2) {
+                let availableFuncStr = 'Here is my list of available samples:';
+
+                for (const sampleFuncKey in this._availableFuncs) {
+                    availableFuncStr += ' ' + sampleFuncKey;
+                }
+
+                this.say(availableFuncStr);
+            } else {
+                for (const sampleFuncKey in this._availableFuncs) {
+                    if (sampleFuncKey.toLowerCase() === sampleId) {
+                        const sampleFunc = this._availableFuncs[sampleFuncKey];
+
+                        this.runSample(sampleFuncKey + this.tickCount, sampleFunc, nearbyLoc);
+
+                        return;
+                    }
+                }
+
+                this.say(`I couldn't find the sample '${sampleId}"'`);
+            }
+        }
+    }
+
+    runSample(
+        sampleId: string,
+        snippetFunctions: Array<(log: (message: string, status?: number) => void, location: mc.Vector3) => void>,
+        targetLocation: mc.Vector3,
+    ) {
+        for (let i = snippetFunctions.length - 1; i >= 0; i--) {
+            this.pendingFuncs.push({ name: sampleId, func: snippetFunctions[i], location: targetLocation });
+        }
+    }
+
+    worldTick() {
+        if (this.tickCount % 10 === 0) {
+            if (this.pendingFuncs.length > 0) {
+                const funcSet = this.pendingFuncs.pop();
+
+                if (funcSet) {
+                    funcSet.func(this.gameplayLogger, funcSet.location);
+                }
+            }
+        }
+
+        this.tickCount++;
+    }
+
+    constructor() {
+        this._availableFuncs = {};
+
+        this.gameplayLogger = this.gameplayLogger.bind(this);
+
+        mc.world.events.tick.subscribe(this.worldTick.bind(this));
+        mc.world.events.chat.subscribe(this.newChatMessage.bind(this));
+    }
+
+    registerSamples(sampleSet: {
+        [name: string]: Array<(log: (message: string, status?: number) => void, location: mc.Vector3) => void>;
+    }) {
+        for (const sampleKey in sampleSet) {
+            if (sampleKey.length > 1 && sampleSet[sampleKey]) {
+                this._availableFuncs[sampleKey] = sampleSet[sampleKey];
+            }
+        }
+    }
+}
+
+import * as gt from '@minecraft/server-gametest'; // keep in for gametest samples
+
+const mojangGameTestFuncs: {
+    [name: string]: Array<(log: (message: string, status?: number) => void, location: mc.Vector3) => void>;
+} = {
+    simpleMobTest: [simpleMobTest],
+};
+
+export function register(sampleManager: SampleManager) {
+    sampleManager.registerSamples(mojangGameTestFuncs);
+}