pxt-common-packages 9.5.1 → 9.5.2

package/libs/game/docs/reference/sprites/sprite/sx.md

@@ -0,0 +1,80 @@
+# sx (property)
+
+Get or set the scaling factor for the width of a sprite.
+
+## Get
+
+Get the width scale for the sprite.
+
+```block
+let mySprite: Sprite = null
+
+let xScale = mySprite.sx
+```
+
+```typescript-ignorelet
+xScale = mySprite.sx
+```
+
+### Returns
+
+* a [number](/types/number) that is the current scale for the width of the sprite.
+
+## Set
+
+Set the width scale for the sprite.
+
+```block
+let mySprite: Sprite = null
+
+mySprite.sx = 2
+```
+
+```typescript-ignore
+mySprite.sx = 2
+```
+
+### Parameter
+
+* **value**: the new width scale factor for the size of the sprite.
+
+## Examples #example
+
+### Stretch and shrink width #ex1
+
+Scale a sprite's width by `1` more size every second. Expand while it's small and contract when it's large.
+
+```blocks
+let expand = 0
+let mySprite = sprites.create(img`
+    2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 
+    `, SpriteKind.Player)
+game.onUpdateInterval(1000, function () {
+    if (mySprite.sx == 1) {
+        expand = 1
+    } else if (mySprite.sx == 6) {
+        expand = -1
+    }
+    mySprite.sx += expand
+})
+```
+
+## See also #seealso
+
+[sy](/reference/sprites/sprite/sy),
+[scale](/reference/sprites/sprite/scale)

package/libs/game/docs/reference/sprites/sprite/sy.md

@@ -0,0 +1,80 @@
+# sy (property)
+
+Get or set the scaling factor for the height of a sprite.
+
+## Get
+
+Get the height scale for the sprite.
+
+```block
+let mySprite: Sprite = null
+
+let xScale = mySprite.sy
+```
+
+```typescript-ignorelet
+xScale = mySprite.sy
+```
+
+### Returns
+
+* a [number](/types/number) that is the current scale for the height of the sprite.
+
+## Set
+
+Set the height scale for the sprite.
+
+```block
+let mySprite: Sprite = null
+
+mySprite.sy = 2
+```
+
+```typescript-ignore
+mySprite.sy = 2
+```
+
+### Parameter
+
+* **value**: the new height scale factor for the size of the sprite.
+
+## Examples #example
+
+### Stretch and shrink height #ex1
+
+Scale a sprite's height by `1` more size every second. Expand while it's small and contract when it's large.
+
+```blocks
+let expand = 0
+let mySprite = sprites.create(img`
+    2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 7 7 7 7 7 7 7 7 7 7 7 7 7 7 2 
+    2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 
+    `, SpriteKind.Player)
+game.onUpdateInterval(1000, function () {
+    if (mySprite.sy == 1) {
+        expand = 1
+    } else if (mySprite.sy == 6) {
+        expand = -1
+    }
+    mySprite.sy += expand
+})
+```
+
+## See also #seealso
+
+[sx](/reference/sprites/sprite/sx),
+[scale](/reference/sprites/sprite/scale)

package/libs/game/docs/reference/sprites.md

@@ -23,6 +23,8 @@ sprites.create(null).setKind(0)
 sprites.create(null).kind()
 sprites.create(null).setBounceOnWall(false)
 sprites.create(null).setStayInScreen(false)
+sprites.create(null).setScale(1, ScaleAnchor.Middle)
+sprites.create(null).changeScale(1, ScaleAnchor.Middle)
 ```
 
 ## Sprite effects
@@ -55,7 +57,7 @@ sprites.onOverlap(0, 0, function (sprite, otherSprite) {})
 ### Physics
 
 * [**vx - velocity x**](/reference/sprites/sprite/vx)
-* [**vy- velocity y**](/reference/sprites/sprite/vy)
+* [**vy - velocity y**](/reference/sprites/sprite/vy)
 * [**ax - acceleration x**](/reference/sprites/sprite/ax)
 * [**ay - acceleration y**](/reference/sprites/sprite/ay)
 * [**fx - friction x**](/reference/sprites/sprite/fx)
@@ -68,6 +70,12 @@ sprites.onOverlap(0, 0, function (sprite, otherSprite) {})
 * [**height**](/reference/sprites/sprite/height)
 * [**lifespan**](/reference/sprites/sprite/lifespan)
 
+### Scaling
+
+* [**sx - scale x**](/reference/sprites/sprite/sx)
+* [**sy - scale y**](/reference/sprites/sprite/sy)
+* [**scale**](/reference/sprites/sprite/scale)
+
 ## See also
 
 [create](/reference/sprites/create),
@@ -87,4 +95,6 @@ sprites.onOverlap(0, 0, function (sprite, otherSprite) {})
 [clear particles](/reference/sprites/sprite/clear-particles),
 [on created](/reference/sprites/on-created),
 [on destroyed](/reference/sprites/on-destroyed),
-[on overlap](/reference/sprites/on-overlap)
+[on overlap](/reference/sprites/on-overlap),
+[set scale](/reference/sprites/sprite/set-scale),
+[change scale](/reference/sprites/sprite/change-scale)

package/libs/game/scene.ts

@@ -93,6 +93,7 @@ namespace scene {
         particleSources: particles.ParticleSource[];
         controlledSprites: controller.ControlledSprite[][];
         followingSprites: sprites.FollowingSprite[];
+        buttonEventHandlers: controller.ButtonEventHandlerState[];
 
         private _millis: number;
         private _data: any;
@@ -116,6 +117,7 @@ namespace scene {
             this.gameForeverHandlers = [];
             this.spritesByKind = {};
             this.controlledSprites = [];
+            this.buttonEventHandlers = [];
             this._data = {};
             this._millis = 0;
         }

package/libs/game/sprite.ts

@@ -1131,7 +1131,7 @@ class Sprite extends sprites.BaseSprite {
     //% inlineInputMode=inline
     //% value.defl=1
     //% anchor.defl=ScaleAnchor.Middle
-    //% help=sprites/sprite/scale
+    //% help=sprites/sprite/set-scale
     //% group="Scale" weight=90
     setScale(value: number, anchor?: ScaleAnchor): void {
         const direction = ScaleDirection.Uniformly;
@@ -1152,7 +1152,7 @@ class Sprite extends sprites.BaseSprite {
     //% inlineInputMode=inline
     //% value.defl=1
     //% anchor.defl=ScaleAnchor.Middle
-    //% help=sprites/sprite/scale
+    //% help=sprites/sprite/change-scale
     //% group="Scale" weight=90
     changeScale(value: number, anchor?: ScaleAnchor): void {
         const direction = ScaleDirection.Uniformly;

package/libs/game/sprites.ts

@@ -76,7 +76,7 @@ namespace sprites {
      * Destroys all sprites of the given kind.
      */
     //% group="Effects"
-    //% weight=79
+    //% weight=79 help=sprites/destroy-all-sprites-of-kind
     //% blockId=sprites_destroy_all_sprites_of_kind
     //% block="destroy all sprites of kind $kind || with $effect effect for $duration ms"
     //% kind.shadow=spritekind

package/libs/game/tilemap.ts

@@ -281,12 +281,22 @@ namespace tiles {
         }
     }
 
+    export enum TileMapEvent {
+        Loaded,
+        Unloaded
+    }
+
+    export class TileMapEventHandler {
+        constructor(public event: TileMapEvent, public callback: (data: TileMapData) => void) {}
+    }
+
     export class TileMap {
         protected _scale: TileScale;
 
         protected _layer: number;
         protected _map: TileMapData;
         renderable: scene.Renderable;
+        protected handlerState: TileMapEventHandler[];
 
         constructor(scale: TileScale = TileScale.Sixteen) {
             this._layer = 1;
@@ -309,7 +319,7 @@ namespace tiles {
             }
         }
 
-        protected get data(): TileMapData {
+        get data(): TileMapData {
             return this._map;
         }
 
@@ -344,7 +354,27 @@ namespace tiles {
         }
 
         setData(map: TileMapData) {
+            const previous = this._map;
+
+            if (this.handlerState && previous !== map && previous) {
+                if (map) {
+                    for (const eventHandler of this.handlerState) {
+                        if (eventHandler.event === TileMapEvent.Unloaded) {
+                            eventHandler.callback(previous);
+                        }
+                    }
+                }
+            }
+
             this._map = map;
+
+            if (this.handlerState && previous !== map && map) {
+                for (const eventHandler of this.handlerState) {
+                    if (eventHandler.event === TileMapEvent.Loaded) {
+                        eventHandler.callback(map);
+                    }
+                }
+            }
         }
 
         public getTile(col: number, row: number): Location {
@@ -523,6 +553,26 @@ namespace tiles {
         public getTileImage(index: number) {
             return this.data.getTileImage(index);
         }
+
+        public addEventListener(event: TileMapEvent, handler: (data: TileMapData) => void) {
+            if (!this.handlerState) this.handlerState = [];
+
+            for (const eventHandler of this.handlerState) {
+                if (eventHandler.event === event && eventHandler.callback === handler) return;
+            }
+            this.handlerState.push(new TileMapEventHandler(event, handler));
+        }
+
+        public removeEventListener(event: TileMapEvent, handler: (data: TileMapData) => void) {
+            if (!this.handlerState) return;
+
+            for (let i = 0; i < this.handlerState.length; i++) {
+                if (this.handlerState[i].event === event && this.handlerState[i].callback === handler) {
+                    this.handlerState.splice(i, 1)
+                    return;
+                }
+            }
+        }
     }
 
     function mkColorTile(index: number, scale: TileScale): Image {
@@ -662,7 +712,7 @@ namespace tiles {
     //% block="tile at $location is wall"
     //% location.shadow=mapgettile
     //% blockNamespace="scene" group="Locations" blockGap=8
-    //% weight=30
+    //% weight=30 help=scene/tile-at-location-is-wall
     export function tileAtLocationIsWall(location: Location): boolean {
         if (!location || !location.tileMap) return false;
         return location.isWall();
@@ -676,7 +726,7 @@ namespace tiles {
     //% blockId=tiles_image_at_location
     //% block="tile image at $location"
     //% location.shadow=mapgettile
-    //% weight=0
+    //% weight=0 help=scene/tile-image-at-location
     //% blockNamespace="scene" group="Locations"
     export function tileImageAtLocation(location: Location): Image {
         const scene = game.currentScene();
@@ -692,7 +742,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
+    //% help=scene/place-on-tile
     //% weight=100
     export function placeOnTile(sprite: Sprite, loc: Location): void {
         if (!sprite || !loc || !loc.tileMap) return;
@@ -761,4 +811,38 @@ namespace tiles {
     export function _tilemapEditor(tilemap: TileMapData): TileMapData {
         return tilemap;
     }
+
+    /**
+     * Adds an event handler that will fire whenever the specified event
+     * is triggered. Unloaded tilemap events will fire before the new tilemap
+     * is set and loaded events will fire afterwards. The same handler can
+     * not be added for the same event more than once.
+     *
+     * @param event     The event to subscribe to
+     * @param handler   The code to run when the event triggers
+     */
+    export function addEventListener(event: TileMapEvent, callback: (data: TileMapData) => void) {
+        const scene = game.currentScene();
+
+        if (!scene.tileMap) {
+            scene.tileMap = new TileMap();
+        }
+
+        scene.tileMap.addEventListener(event, callback);
+    }
+
+
+    /**
+     * Removes an event handler registered with addEventListener.
+     *
+     * @param event     The event that the handler was registered for
+     * @param handler   The handler to remove
+     */
+    export function removeEventListener(event: TileMapEvent, callback: (data: TileMapData) => void) {
+        const scene = game.currentScene();
+
+        if (!scene.tileMap) return;
+
+        scene.tileMap.removeEventListener(event, callback);
+    }
 }

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

@@ -56,7 +56,7 @@ const pxsim_pxtrt = pxsim.pxtrt;
 const pxsim_numops = pxsim.numops;
 
 
-function _main___P48806(s) {
+function _main___P48928(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___49049 = (undefined);
-    globals._pollEventQueue___49062 = (undefined);
+    globals._intervals___49171 = (undefined);
+    globals._pollEventQueue___49184 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P48806.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"characterlcd.ts","functionName":"<main>","argumentNames":[]}
-_main___P48806.continuations = [  ]
+_main___P48928.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"characterlcd.ts","functionName":"<main>","argumentNames":[]}
+_main___P48928.continuations = [  ]
 
-function _main___P48806_mk(s) {
+function _main___P48928_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P48806, depth: s.depth + 1,
+        parent: s, fn: _main___P48928, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P48806_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P48806
+return _main___P48928
 })

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___P97034(s) {
+function _main___P97400(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___97277 = (undefined);
-    globals._pollEventQueue___97290 = (undefined);
+    globals._intervals___97643 = (undefined);
+    globals._pollEventQueue___97656 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P97034.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"tsl2591.ts","functionName":"<main>","argumentNames":[]}
-_main___P97034.continuations = [  ]
+_main___P97400.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"tsl2591.ts","functionName":"<main>","argumentNames":[]}
+_main___P97400.continuations = [  ]
 
-function _main___P97034_mk(s) {
+function _main___P97400_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P97034, depth: s.depth + 1,
+        parent: s, fn: _main___P97400, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P97034_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P97034
+return _main___P97400
 })

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

@@ -56,7 +56,7 @@ const pxsim_pxtrt = pxsim.pxtrt;
 const pxsim_numops = pxsim.numops;
 
 
-function _main___P60108(s) {
+function _main___P60230(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___60351 = (undefined);
-    globals._pollEventQueue___60364 = (undefined);
+    globals._intervals___60473 = (undefined);
+    globals._pollEventQueue___60486 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P60108.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"lora.ts","functionName":"<main>","argumentNames":[]}
-_main___P60108.continuations = [  ]
+_main___P60230.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"lora.ts","functionName":"<main>","argumentNames":[]}
+_main___P60230.continuations = [  ]
 
-function _main___P60108_mk(s) {
+function _main___P60230_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P60108, depth: s.depth + 1,
+        parent: s, fn: _main___P60230, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P60108_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P60108
+return _main___P60230
 })

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

@@ -56,7 +56,7 @@ const pxsim_pxtrt = pxsim.pxtrt;
 const pxsim_numops = pxsim.numops;
 
 
-function _main___P187868(s) {
+function _main___P188722(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___188111 = (undefined);
-    globals._pollEventQueue___188124 = (undefined);
+    globals._intervals___188965 = (undefined);
+    globals._pollEventQueue___188978 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P187868.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"keypad.ts","functionName":"<main>","argumentNames":[]}
-_main___P187868.continuations = [  ]
+_main___P188722.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"keypad.ts","functionName":"<main>","argumentNames":[]}
+_main___P188722.continuations = [  ]
 
-function _main___P187868_mk(s) {
+function _main___P188722_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P187868, depth: s.depth + 1,
+        parent: s, fn: _main___P188722, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P187868_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P187868
+return _main___P188722
 })