pxt-common-packages 9.5.4 → 9.5.7

package/libs/game/sim/multiplayer.ts

@@ -0,0 +1,132 @@
+namespace pxsim.multiplayer {
+    export function postImage(im: pxsim.RefImage, goal: string) {
+        const asBuf = pxsim.image.toBuffer(im);
+        getMultiplayerState().send(<MultiplayerImageMessage>{
+            content: "Image",
+            image: asBuf,
+            goal
+        });
+    }
+
+    export function getCurrentImage(): pxsim.RefImage {
+        return getMultiplayerState().backgroundImage;
+    }
+
+    export function setOrigin(origin: "client" | "server" | undefined) {
+        getMultiplayerState().origin = origin;
+    }
+
+    export function getOrigin(): string {
+        return getMultiplayerState().origin;
+    }
+}
+
+namespace pxsim {
+    export interface MultiplayerBoard extends EventBusBoard {
+        multiplayerState: MultiplayerState;
+    }
+
+    export function getMultiplayerState() {
+        return (board() as EventBusBoard as MultiplayerBoard).multiplayerState;
+    }
+
+    export interface SimulatorMultiplayerMessage extends SimulatorBroadcastMessage {
+        broadcast: true
+        type: "multiplayer";
+        content: string;
+        origin?: "server" | "client";
+        clientNumber?: number;
+        id?: number;
+    }
+
+    export interface MultiplayerImageMessage extends SimulatorMultiplayerMessage {
+        content: "Image";
+        goal: string; // goal of message; e.g. "broadcast-screen"
+        image: RefImage;
+    }
+
+    export interface MultiplayerButtonEvent extends SimulatorMultiplayerMessage {
+        content: "Button";
+        button: number; // pxsim.Key.A, ...
+        state: "Pressed" | "Released" | "Held";
+    }
+
+    export class MultiplayerState {
+        lastMessageId: number;
+        origin: string;
+        backgroundImage: RefImage;
+
+        constructor() {
+            this.lastMessageId = 0;
+        }
+
+        send(msg: SimulatorMultiplayerMessage) {
+            Runtime.postMessage(<SimulatorMultiplayerMessage>{
+                ...msg,
+                broadcast: true,
+                toParentIFrameOnly: true,
+                type: "multiplayer",
+                origin: this.origin,
+                id: this.lastMessageId++
+            });
+        }
+
+        init(origin: string) {
+            this.origin = origin;
+            runtime.board.addMessageListener(msg => this.messageHandler(msg));
+            setInterval(() => {
+                if (this.origin === "server") {
+                    const b = board() as ScreenBoard;
+                    const screenState = b && b.screenState;
+                    const lastImage = screenState && screenState.lastImage;
+                    lastImage && pxsim.multiplayer.postImage(lastImage, "broadcast-screen");
+                }
+            }, 50);
+        }
+
+        setButton(key: number, isPressed: boolean) {
+            if (this.origin === "client") {
+                this.send(<pxsim.MultiplayerButtonEvent>{
+                    content: "Button",
+                    button: key,
+                    state: isPressed ? "Pressed" : "Released"
+                })
+            }
+        }
+
+        protected messageHandler(msg: SimulatorMessage) {
+            if (!isMultiplayerMessage(msg)) {
+                return;
+            }
+
+            if (isImageMessage(msg)) {
+                if (this.origin === "client") {
+                    // HACK: peer js can convert Uint8Array into ArrayBuffer when transmitting; fix this.
+                    if (!ArrayBuffer.isView(msg.image.data)) {
+                        msg.image.data = new Uint8Array(msg.image.data);
+                    }
+                    this.backgroundImage = pxsim.image.ofBuffer(msg.image);
+                }
+            } else if (isButtonMessage(msg)) {
+                if (this.origin === "server") {
+                    (board() as any).setButton(
+                        msg.button + (7 * (msg.clientNumber || 1)), // + 7 to make it player 2 controls,
+                        msg.state === "Pressed" || msg.state === "Held"
+                    );
+                }
+            }
+        }
+    }
+
+    function isMultiplayerMessage(msg: SimulatorMessage): msg is SimulatorMultiplayerMessage {
+        return msg && msg.type === "multiplayer";
+    }
+
+    function isImageMessage(msg: SimulatorMultiplayerMessage): msg is MultiplayerImageMessage {
+        return msg && msg.content === "Image";
+    }
+
+    function isButtonMessage(msg: SimulatorMultiplayerMessage): msg is MultiplayerButtonEvent {
+        return msg && msg.content === "Button";
+    }
+}

package/libs/game/sprite.ts

@@ -319,7 +319,7 @@ class Sprite extends sprites.BaseSprite {
      */
     //% group="Image"
     //% blockId=spriteimage block="%sprite(mySprite) image"
-    //% weight=8
+    //% weight=8 help=sprites/sprite/image
     get image(): Image {
         return this._image;
     }
@@ -998,6 +998,7 @@ class Sprite extends sprites.BaseSprite {
     //% group="Physics" weight=10
     //% blockId=spriteFollowOtherSprite
     //% block="set %sprite(myEnemy) follow %target=variables_get(mySprite) || with speed %speed"
+    //% help=sprites/sprite/follow
     follow(target: Sprite, speed = 100, turnRate = 400) {
         if (target === this) return;
 

package/libs/game/spritekind.ts

@@ -5,6 +5,7 @@ namespace sprites {
     //% shim=KIND_GET
     //% blockId=spritekind block="$kind"
     //% kindNamespace=SpriteKind kindMemberName=kind kindPromptHint="e.g. Coin, Fireball, Asteroid..."
+    //% help=sprites/sprite-kind
     export function _spriteKind(kind: number): number {
         return kind;
     }

package/libs/game/tilemap.ts

@@ -596,7 +596,7 @@ namespace tiles {
     //% tilemap.fieldOptions.filter="tile"
     //% tilemap.fieldOptions.taggedTemplate="tilemap"
     //% blockNamespace="scene" duplicateShadowOnDrag
-    //% help=scene/set-tilemap
+    //% help=tiles/set-tilemap
     //% deprecated=1
     export function setTilemap(tilemap: TileMapData) {
         setCurrentTilemap(tilemap);
@@ -611,7 +611,7 @@ namespace tiles {
     //% weight=201 blockGap=8
     //% tilemap.shadow=tiles_tilemap_editor
     //% blockNamespace="scene" group="Tilemaps" duplicateShadowOnDrag
-    //% help=tiles/set-tile-map
+    //% help=tiles/set-current-tilemap
     export function setCurrentTilemap(tilemap: TileMapData) {
         scene.setTileMapLevel(tilemap);
     }
@@ -625,7 +625,7 @@ namespace tiles {
     //% tile.shadow=tileset_tile_picker
     //% tile.decompileIndirectFixedInstances=true
     //% blockNamespace="scene" group="Tilemap Operations" blockGap=8
-    //% help=scene/set-tile-at
+    //% help=tiles/set-tile-at
     //% weight=70
     export function setTileAt(loc: Location, tile: Image): void {
         const scene = game.currentScene();
@@ -643,7 +643,7 @@ namespace tiles {
     //% blockId=mapsetwallat block="set wall $on at $loc"
     //% on.shadow=toggleOnOff loc.shadow=mapgettile
     //% blockNamespace="scene" group="Tilemap Operations"
-    //% help=scene/set-wall-at
+    //% help=tiles/set-wall-at
     //% weight=60
     export function setWallAt(loc: Location, on: boolean): void {
         const scene = game.currentScene();
@@ -660,7 +660,7 @@ namespace tiles {
     //% blockId=mapgettile block="tilemap col $col row $row"
     //% blockNamespace="scene" group="Locations"
     //% weight=100 blockGap=8
-    //% help=scene/get-tile-location
+    //% help=tiles/get-tile-location
     export function getTileLocation(col: number, row: number): Location {
         const scene = game.currentScene();
         if (col == undefined || row == undefined || !scene.tileMap) return null;
@@ -697,7 +697,7 @@ namespace tiles {
     //% location.shadow=mapgettile
     //% tile.shadow=tileset_tile_picker tile.decompileIndirectFixedInstances=true
     //% blockNamespace="scene" group="Locations" blockGap=8
-    //% weight=40 help=scene/tile-at-location-equals
+    //% weight=40 help=tiles/tile-at-location-equals
     export function tileAtLocationEquals(location: Location, tile: Image): boolean {
         const scene = game.currentScene();
         if (!location || !tile || !scene.tileMap) return false;
@@ -713,7 +713,7 @@ namespace tiles {
     //% block="tile at $location is wall"
     //% location.shadow=mapgettile
     //% blockNamespace="scene" group="Locations" blockGap=8
-    //% weight=30 help=scene/tile-at-location-is-wall
+    //% weight=30 help=tiles/tile-at-location-is-wall
     export function tileAtLocationIsWall(location: Location): boolean {
         if (!location || !location.tileMap) return false;
         return location.isWall();
@@ -727,7 +727,7 @@ namespace tiles {
     //% blockId=tiles_image_at_location
     //% block="tile image at $location"
     //% location.shadow=mapgettile
-    //% weight=0 help=scene/tile-image-at-location
+    //% weight=0 help=tiles/tile-image-at-location
     //% blockNamespace="scene" group="Locations"
     export function tileImageAtLocation(location: Location): Image {
         const scene = game.currentScene();
@@ -743,7 +743,7 @@ namespace tiles {
     //% blockId=mapplaceontile block="place $sprite=variables_get(mySprite) on top of $loc"
     //% loc.shadow=mapgettile
     //% blockNamespace="scene" group="Tilemap Operations" blockGap=8
-    //% help=scene/place-on-tile
+    //% help=tiles/place-on-tile
     //% weight=100
     export function placeOnTile(sprite: Sprite, loc: Location): void {
         if (!sprite || !loc || !loc.tileMap) return;
@@ -759,7 +759,7 @@ namespace tiles {
     //% tile.shadow=tileset_tile_picker
     //% tile.decompileIndirectFixedInstances=true
     //% blockNamespace="scene" group="Tilemap Operations"
-    //% help=scene/place-on-random-tile
+    //% help=tiles/place-on-random-tile
     //% weight=90
     export function placeOnRandomTile(sprite: Sprite, tile: Image): void {
         if (!sprite || !game.currentScene().tileMap) return;
@@ -776,7 +776,7 @@ namespace tiles {
     //% tile.shadow=tileset_tile_picker
     //% tile.decompileIndirectFixedInstances=true
     //% blockNamespace="scene" group="Locations" blockGap=8
-    //% help=scene/get-tiles-by-type
+    //% help=tiles/get-tiles-by-type
     //% weight=10
     export function getTilesByType(tile: Image): Location[] {
         const scene = game.currentScene();
@@ -809,6 +809,7 @@ namespace tiles {
     //% tilemap.fieldOptions.filter="tile"
     //% tilemap.fieldOptions.taggedTemplate="tilemap"
     //% blockNamespace="scene" group="Tilemaps" duplicateShadowOnDrag
+    //% help=tiles/tilemap
     export function _tilemapEditor(tilemap: TileMapData): TileMapData {
         return tilemap;
     }

package/libs/lcd/built/debug/binary.js

@@ -56,7 +56,7 @@ const pxsim_pxtrt = pxsim.pxtrt;
 const pxsim_numops = pxsim.numops;
 
 
-function _main___P48928(s) {
+function _main___P48098(s) {
 let r0 = s.r0, step = s.pc;
 s.pc = -1;
 
@@ -66,19 +66,19 @@ if (yieldSteps-- < 0 && maybeYield(s, step, r0) || runtime !== pxsim.runtime) re
 switch (step) {
   case 0:
 
-    globals._intervals___49171 = (undefined);
-    globals._pollEventQueue___49184 = (undefined);
+    globals._intervals___48341 = (undefined);
+    globals._pollEventQueue___48354 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P48928.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"characterlcd.ts","functionName":"<main>","argumentNames":[]}
-_main___P48928.continuations = [  ]
+_main___P48098.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"characterlcd.ts","functionName":"<main>","argumentNames":[]}
+_main___P48098.continuations = [  ]
 
-function _main___P48928_mk(s) {
+function _main___P48098_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P48928, depth: s.depth + 1,
+        parent: s, fn: _main___P48098, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P48928_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P48928
+return _main___P48098
 })

package/libs/light-spectrum-sensor/built/debug/binary.js

@@ -56,7 +56,7 @@ const pxsim_pxtrt = pxsim.pxtrt;
 const pxsim_numops = pxsim.numops;
 
 
-function _main___P97400(s) {
+function _main___P96584(s) {
 let r0 = s.r0, step = s.pc;
 s.pc = -1;
 
@@ -66,19 +66,19 @@ if (yieldSteps-- < 0 && maybeYield(s, step, r0) || runtime !== pxsim.runtime) re
 switch (step) {
   case 0:
 
-    globals._intervals___97643 = (undefined);
-    globals._pollEventQueue___97656 = (undefined);
+    globals._intervals___96827 = (undefined);
+    globals._pollEventQueue___96840 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P97400.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"tsl2591.ts","functionName":"<main>","argumentNames":[]}
-_main___P97400.continuations = [  ]
+_main___P96584.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"tsl2591.ts","functionName":"<main>","argumentNames":[]}
+_main___P96584.continuations = [  ]
 
-function _main___P97400_mk(s) {
+function _main___P96584_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P97400, depth: s.depth + 1,
+        parent: s, fn: _main___P96584, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P97400_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P97400
+return _main___P96584
 })

package/libs/lora/built/debug/binary.js

@@ -56,7 +56,7 @@ const pxsim_pxtrt = pxsim.pxtrt;
 const pxsim_numops = pxsim.numops;
 
 
-function _main___P60230(s) {
+function _main___P59400(s) {
 let r0 = s.r0, step = s.pc;
 s.pc = -1;
 
@@ -66,19 +66,19 @@ if (yieldSteps-- < 0 && maybeYield(s, step, r0) || runtime !== pxsim.runtime) re
 switch (step) {
   case 0:
 
-    globals._intervals___60473 = (undefined);
-    globals._pollEventQueue___60486 = (undefined);
+    globals._intervals___59643 = (undefined);
+    globals._pollEventQueue___59656 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P60230.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"lora.ts","functionName":"<main>","argumentNames":[]}
-_main___P60230.continuations = [  ]
+_main___P59400.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"lora.ts","functionName":"<main>","argumentNames":[]}
+_main___P59400.continuations = [  ]
 
-function _main___P60230_mk(s) {
+function _main___P59400_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P60230, depth: s.depth + 1,
+        parent: s, fn: _main___P59400, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P60230_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P60230
+return _main___P59400
 })

package/libs/matrix-keypad/built/debug/binary.js

@@ -56,7 +56,7 @@ const pxsim_pxtrt = pxsim.pxtrt;
 const pxsim_numops = pxsim.numops;
 
 
-function _main___P188726(s) {
+function _main___P187101(s) {
 let r0 = s.r0, step = s.pc;
 s.pc = -1;
 
@@ -66,19 +66,19 @@ if (yieldSteps-- < 0 && maybeYield(s, step, r0) || runtime !== pxsim.runtime) re
 switch (step) {
   case 0:
 
-    globals._intervals___188969 = (undefined);
-    globals._pollEventQueue___188982 = (undefined);
+    globals._intervals___187344 = (undefined);
+    globals._pollEventQueue___187357 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P188726.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"keypad.ts","functionName":"<main>","argumentNames":[]}
-_main___P188726.continuations = [  ]
+_main___P187101.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"keypad.ts","functionName":"<main>","argumentNames":[]}
+_main___P187101.continuations = [  ]
 
-function _main___P188726_mk(s) {
+function _main___P187101_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P188726, depth: s.depth + 1,
+        parent: s, fn: _main___P187101, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P188726_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P188726
+return _main___P187101
 })