Merge branch 'master' into csg

Author: joeng03

modules.json

@@ -86,9 +86,17 @@
   "remote_execution": {
     "tabs": []
   },
+  "wasm": {
+    "tabs": []
+  },
+  "arcade_2d": {
+    "tabs": [
+      "ArcadeTwod"
+    ]
+  },
   "physics_2d": {
     "tabs": [
       "physics_2d"
     ]
   }
-}
+}

package.json

@@ -60,7 +60,7 @@
     "console-table-printer": "^2.11.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
-    "esbuild": "0.17.11",
+    "esbuild": "^0.17.19",
     "eslint": "^8.21.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^17.0.0",

scripts/bin/templates/utilities.js

@@ -1,4 +1,7 @@
-const snakeCaseRegex = /\b[a-z]+(?:_[a-z]+)*\b/u;
+// Snake case regex has been changed from `/\b[a-z]+(?:_[a-z]+)*\b/u` to `/\b[a-z0-9]+(?:_[a-z0-9]+)*\b/u`
+// to be consistent with the naming of the `arcade_2d` and `physics_2d` modules.
+// This change should not affect other modules, since the set of possible names is only expanded.
+const snakeCaseRegex = /\b[a-z0-9]+(?:_[a-z0-9]+)*\b/u;
 const pascalCaseRegex = /^[A-Z][a-z]+(?:[A-Z][a-z]+)*$/u;
 export function isSnakeCase(string) {
     return snakeCaseRegex.test(string);

scripts/src/templates/utilities.ts

@@ -1,4 +1,7 @@
-const snakeCaseRegex = /\b[a-z]+(?:_[a-z]+)*\b/u;
+// Snake case regex has been changed from `/\b[a-z]+(?:_[a-z]+)*\b/u` to `/\b[a-z0-9]+(?:_[a-z0-9]+)*\b/u`
+// to be consistent with the naming of the `arcade_2d` and `physics_2d` modules.
+// This change should not affect other modules, since the set of possible names is only expanded.
+const snakeCaseRegex = /\b[a-z0-9]+(?:_[a-z0-9]+)*\b/u;
 const pascalCaseRegex = /^[A-Z][a-z]+(?:[A-Z][a-z]+)*$/u;
 
 export function isSnakeCase(string: string) {

src/bundles/arcade_2d/audio.ts

@@ -0,0 +1,88 @@
+/**
+ * This file contains Arcade2D's representation of audio clips and sound.
+ */
+
+/**
+ * Encapsulates the representation of AudioClips.
+ * AudioClips are unique - there are no AudioClips with the same URL.
+ */
+export class AudioClip {
+  private static audioClipCount: number = 0;
+  // Stores AudioClip index with the URL as a unique key.
+  private static audioClipsIndexMap: Map<string, number> = new Map<string, number>();
+  // Stores all the created AudioClips
+  private static audioClipsArray: Array<AudioClip> = [];
+  public readonly id: number;
+
+  private isUpdated: boolean = false;
+  private shouldPlay: boolean = false;
+  private shouldLoop: boolean = false;
+
+  private constructor(
+    private url: string,
+    private volumeLevel: number,
+  ) {
+    this.id = AudioClip.audioClipCount++;
+    AudioClip.audioClipsIndexMap.set(url, this.id);
+    AudioClip.audioClipsArray.push(this);
+  }
+
+  /**
+   * Factory method to create new AudioClip if unique URL provided.
+   * Otherwise returns the previously created AudioClip.
+   */
+  public static of(url: string, volumeLevel: number): AudioClip {
+    if (url === '') {
+      throw new Error('AudioClip URL cannot be empty');
+    }
+    if (AudioClip.audioClipsIndexMap.has(url)) {
+      return AudioClip.audioClipsArray[AudioClip.audioClipsIndexMap.get(url) as number];
+    }
+    return new AudioClip(url, volumeLevel);
+  }
+  public getUrl() {
+    return this.url;
+  }
+  public getVolumeLevel() {
+    return this.volumeLevel;
+  }
+  public shouldAudioClipLoop() {
+    return this.shouldLoop;
+  }
+  public shouldAudioClipPlay() {
+    return this.shouldPlay;
+  }
+  public setShouldAudioClipLoop(loop: boolean) {
+    if (this.shouldLoop !== loop) {
+      this.shouldLoop = loop;
+      this.isUpdated = false;
+    }
+  }
+  /**
+   * Updates the play/pause state.
+   * @param play When true, the Audio Clip has a playing state.
+   */
+  public setShouldAudioClipPlay(play: boolean) {
+    this.shouldPlay = play;
+    this.isUpdated = false;
+  }
+  /**
+   * Checks if the Audio Clip needs to update. Updates the flag if true.
+   */
+  public hasAudioClipUpdates() {
+    const prevValue = !this.isUpdated;
+    this.setAudioClipUpdated();
+    return prevValue;
+  }
+  public setAudioClipUpdated() {
+    this.isUpdated = true;
+  }
+  public static getAudioClipsArray() {
+    return AudioClip.audioClipsArray;
+  }
+
+  public toReplString = () => '<AudioClip>';
+
+  /** @override */
+  public toString = () => this.toReplString();
+}

src/bundles/arcade_2d/constants.ts

@@ -0,0 +1,46 @@
+// This file contains the default values of the game canvas and GameObjects.
+
+import { type InteractableProps, type RenderProps, type TransformProps } from './types';
+
+// Default values of game
+export const DEFAULT_WIDTH: number = 600;
+export const DEFAULT_HEIGHT: number = 600;
+export const DEFAULT_SCALE: number = 1;
+export const DEFAULT_FPS: number = 30;
+export const DEFAULT_VOLUME: number = 0.5; // Unused
+
+// Interval of allowed values of game
+export const MAX_HEIGHT: number = 1000;
+export const MIN_HEIGHT: number = 100;
+export const MAX_WIDTH: number = 1000;
+export const MIN_WIDTH: number = 100;
+export const MAX_SCALE: number = 10;
+export const MIN_SCALE: number = 0.1;
+export const MAX_FPS: number = 120;
+export const MIN_FPS: number = 1;
+export const MAX_VOLUME: number = 1;
+export const MIN_VOLUME: number = 0;
+
+// A mode where the hitboxes is shown in the canvas for debugging purposes,
+// and debug log information
+export const DEFAULT_DEBUG_STATE: boolean = false;
+
+// Default values for GameObject properties
+export const DEFAULT_TRANSFORM_PROPS: TransformProps = {
+  position: [0, 0],
+  scale: [1, 1],
+  rotation: 0,
+};
+
+export const DEFAULT_RENDER_PROPS: RenderProps = {
+  color: [255, 255, 255, 255],
+  flip: [false, false],
+  isVisible: true,
+};
+
+export const DEFAULT_INTERACTABLE_PROPS: InteractableProps = {
+  isHitboxActive: true,
+};
+
+// Default values of Phaser scene
+export const DEFAULT_PATH_PREFIX: string = 'https://source-academy-assets.s3-ap-southeast-1.amazonaws.com/';