pxt-common-packages 9.5.7 → 9.5.10

package/built/common-sim.d.ts

@@ -728,6 +728,50 @@ declare namespace pxsim {
 }
 declare namespace pxsim.info {
 }
+declare namespace pxsim.keymap {
+    enum Key {
+        None = 0,
+        Left = 1,
+        Up = 2,
+        Right = 3,
+        Down = 4,
+        A = 5,
+        B = 6,
+        Menu = 7,
+        Screenshot = -1,
+        Gif = -2,
+        Reset = -3,
+        TogglePause = -4
+    }
+    function _setPlayerKeys(player: number, // player number is 1-based
+    up: number, down: number, left: number, right: number, A: number, B: number): void;
+    function _setSystemKeys(screenshot: number, gif: number, menu: number, reset: number): void;
+}
+declare namespace pxsim {
+    import Key = pxsim.keymap.Key;
+    interface KeymapBoard extends EventBusBoard {
+        keymapState: KeymapState;
+    }
+    function getKeymapState(): KeymapState;
+    class KeymapState {
+        keymap: {
+            [keyCode: number]: Key;
+        };
+        altmap: {
+            [keyCode: number]: Key;
+        };
+        mappings: {
+            [name: string]: number[];
+        };
+        constructor();
+        setPlayerKeys(player: number, // player number is 1-based
+        up: number, down: number, left: number, right: number, A: number, B: number): void;
+        setSystemKeys(screenshot: number, gif: number, menu: number, reset: number): void;
+        getKey(keyCode: number): Key;
+        private saveMap;
+        private clearMap;
+    }
+}
 declare namespace pxsim.multiplayer {
     function postImage(im: pxsim.RefImage, goal: string): void;
     function getCurrentImage(): pxsim.RefImage;

package/built/common-sim.js

@@ -2395,6 +2395,145 @@ var pxsim;
     pxsim.ToggleState = ToggleState;
 })(pxsim || (pxsim = {}));
 var pxsim;
+(function (pxsim) {
+    var keymap;
+    (function (keymap) {
+        // Keep in sync with pxt-arcade-sim/api.ts
+        let Key;
+        (function (Key) {
+            Key[Key["None"] = 0] = "None";
+            // Player 1
+            Key[Key["Left"] = 1] = "Left";
+            Key[Key["Up"] = 2] = "Up";
+            Key[Key["Right"] = 3] = "Right";
+            Key[Key["Down"] = 4] = "Down";
+            Key[Key["A"] = 5] = "A";
+            Key[Key["B"] = 6] = "B";
+            Key[Key["Menu"] = 7] = "Menu";
+            // Player 2 = Player 1 + 7
+            // Player 3 = Player 2 + 7
+            // Player 4 = Player 3 + 7
+            // system keys
+            Key[Key["Screenshot"] = -1] = "Screenshot";
+            Key[Key["Gif"] = -2] = "Gif";
+            Key[Key["Reset"] = -3] = "Reset";
+            Key[Key["TogglePause"] = -4] = "TogglePause";
+        })(Key = keymap.Key || (keymap.Key = {}));
+        function _setPlayerKeys(player, // player number is 1-based
+        up, down, left, right, A, B) {
+            pxsim.getKeymapState().setPlayerKeys(player, up, down, left, right, A, B);
+        }
+        keymap._setPlayerKeys = _setPlayerKeys;
+        function _setSystemKeys(screenshot, gif, menu, reset) {
+            pxsim.getKeymapState().setSystemKeys(screenshot, gif, menu, reset);
+        }
+        keymap._setSystemKeys = _setSystemKeys;
+    })(keymap = pxsim.keymap || (pxsim.keymap = {}));
+})(pxsim || (pxsim = {}));
+(function (pxsim) {
+    var Key = pxsim.keymap.Key;
+    function getKeymapState() {
+        return pxsim.board().keymapState;
+    }
+    pxsim.getKeymapState = getKeymapState;
+    const reservedKeyCodes = [
+        27,
+        9 // Tab
+    ];
+    class KeymapState {
+        constructor() {
+            this.keymap = {};
+            this.altmap = {};
+            this.mappings = {};
+            // Player 1 keymap
+            this.setPlayerKeys(1, // Player 1
+            87, // W - Up
+            83, // D - Down
+            65, // A - Left
+            83, // S - Right
+            32, // Space - A
+            13 // Enter - B
+            );
+            // Player 2 keymap
+            this.setPlayerKeys(2, // Player 2
+            73, // I - Up
+            75, // K - Down
+            74, // J - Left
+            75, // K - Right
+            85, // U - A
+            79 // O - B
+            );
+            // Note: Player 3 and 4 have no default keyboard mapping
+            // System keymap
+            this.setSystemKeys(80, // P - Screenshot
+            82, // R - Gif
+            0, // Menu - not mapped
+            0 // Reset - not mapped
+            );
+            // Player 1 alternate mapping. This is cleared when the game sets any player keys explicitly
+            this.altmap[38] = Key.Up; // UpArrow
+            this.altmap[37] = Key.Left; // LeftArrow
+            this.altmap[40] = Key.Down; // DownArrow
+            this.altmap[39] = Key.Right; // RightArrow
+            this.altmap[81] = Key.A; // Q
+            this.altmap[90] = Key.A; // Z
+            this.altmap[88] = Key.B; // X
+            this.altmap[69] = Key.B; // E
+        }
+        setPlayerKeys(player, // player number is 1-based
+        up, down, left, right, A, B) {
+            // We only support four players
+            if (player < 1 || player > 4)
+                return;
+            const keyCodes = [up, down, left, right, A, B];
+            // Check for reserved key codes
+            // TODO: How to surface this runtime error to the user?
+            // TODO: Send message to UI: "Keyboard mapping contains a reserved key code"
+            const filtered = keyCodes.filter(keyCode => reservedKeyCodes.includes(keyCode));
+            if (filtered.length)
+                return;
+            // Clear existing mapped keys for player
+            const mapName = `player-${player}`;
+            this.clearMap(mapName);
+            // Clear altmap When explicitly setting the player keys
+            this.altmap = {};
+            // Map the new keys
+            const offset = (player - 1) * 7; // +7 for player 2's keys
+            this.keymap[up] = Key.Up + offset;
+            this.keymap[down] = Key.Down + offset;
+            this.keymap[left] = Key.Left + offset;
+            this.keymap[right] = Key.Right + offset;
+            this.keymap[A] = Key.A + offset;
+            this.keymap[B] = Key.B + offset;
+            // Remember this mapping
+            this.saveMap(mapName, keyCodes);
+        }
+        setSystemKeys(screenshot, gif, menu, reset) {
+            const mapName = "system";
+            // Clear existing mapped keys for system
+            this.clearMap(mapName);
+            this.keymap[screenshot] = Key.Screenshot;
+            this.keymap[gif] = Key.Gif;
+            this.keymap[menu] = Key.Menu;
+            this.keymap[reset] = Key.Reset;
+            // Remember this mapping
+            this.saveMap(mapName, [screenshot, gif, menu, reset]);
+        }
+        getKey(keyCode) {
+            return keyCode ? this.keymap[keyCode] || this.altmap[keyCode] || Key.None : Key.None;
+        }
+        saveMap(name, keyCodes) {
+            this.mappings[name] = keyCodes;
+        }
+        clearMap(name) {
+            const keyCodes = this.mappings[name];
+            keyCodes === null || keyCodes === void 0 ? void 0 : keyCodes.forEach(keyCode => delete this.keymap[keyCode]);
+            delete this.mappings[name];
+        }
+    }
+    pxsim.KeymapState = KeymapState;
+})(pxsim || (pxsim = {}));
+var pxsim;
 (function (pxsim) {
     var multiplayer;
     (function (multiplayer) {