pxt-common-packages 13.2.2 → 13.2.4

package/libs/light/defaultlightsoverrides.ts

@@ -6,6 +6,7 @@ namespace light {
      */
     //% blockId="lightstrip_range" block="range from %start|with %length|pixels"
     //% weight=1
+    //% help=light/range
     export function range(start: number, length: number): NeoPixelStrip {
         return pixels.range(start, length);
     }
@@ -17,6 +18,7 @@ namespace light {
     //% numleds.defl=30
     //% numleds.shadow=lightLengthPicker
     //% weight=0
+    //% help=light/set-length
     export function setLength(numleds: number) {
         light.pixels.setLength(numleds);
     }
@@ -26,6 +28,7 @@ namespace light {
      */
     //% blockId=lightds_setmode block="set default strip mode to %mode"
     //% weight=0
+    //% help=light/set-mode
     export function setMode(mode: NeoPixelMode) {
         light.pixels.setMode(mode);
     }

package/libs/light/docs/reference/light/create-apa102-strip.md

@@ -0,0 +1,42 @@
+# create APA102 Strip
+
+Create a controller for an addressable APA102 LED strip.
+
+```sig
+light.createAPA102Strip();
+```
+
+When you connect a APA102 pixel strip to your @boardname@, you have to give your program a way
+to work with it. You tell your program that there is a pixel strip you want to use with
+``||create apa102 strip||``.
+
+To use ``||create apa102 strip||``, you need to know which pins the strip is attached to for data and clock signals, and
+how many pixels (LEDs) are on the strip. Also, some pixel strips have different types LEDs.
+If you know the exact type, you can set it in the pixel mode. 
+
+## Parameters
+
+* **dataPin**: [DigitalInOutPin](/reference/pins), the pin where the neopixel strip is connected for data.
+* **clkPin**: [DigitalInOutPin](/reference/pins), the pin where the neopixel strip is connected for the clock signal.
+* **numleds**: the [number](/types/number) of LEDs in the strip, such as: 10, 30, 60, or 64.
+
+## Returns
+
+* a new **NeoPixelStrip** controller for the neopixels on a APA102 strip connected to the board.
+
+## Example
+
+Connect a APA102 pixel strip to pind `A1` and `A2`. Make all pixels light up `green`.
+
+```typescript
+const strip = light.createStrip(pins.A1, pins.A2, 40);
+strip.setAll(0x00ff00)
+```
+
+## See Also
+
+[range](/reference/light/neopixelstrip/range), [set mode](/reference/light/neopixelstrip/set-mode)
+
+```package
+light
+```

package/libs/light/docs/reference/light/default-strip.md

@@ -0,0 +1,32 @@
+# create Strip
+
+Get a controller for the default programmable LED strip.
+
+```sig
+light.defaultStrip();
+```
+
+The default LED strip is either a strip that is onboard or one that is connected to the board but is set as the default.
+
+## Returns
+
+* a new **NeoPixelStrip** controller for the default neopixel strip connected to or existing on the board.
+
+## Example
+
+Get the default pixel strip for the board. Make all pixels light up `green`.
+
+```typescript
+const strip = light.defaultStrip( );
+strip.setAll(0x00ff00)
+```
+
+## See also
+
+[onboard strip](/reference/light/neopixelstrip/onboard-strip),
+[range](/reference/light/neopixelstrip/range),
+[set mode](/reference/light/neopixelstrip/set-mode)
+
+```package
+light
+```

package/libs/light/docs/reference/light/neopixelstrip/set-gradient.md

@@ -0,0 +1,31 @@
+# set Gradient
+
+Set a gradient between two RGB colors.
+
+```sig
+light.createStrip().setGradient(0, 0)
+```
+
+The default color gradient for a LED strip is `black` to `white` which is between `0x000000` and `0xffffff` in RGB values. you change that gradient by selecting two other colors to begin and end the gradient range.
+
+## Parameters
+
+* **startColor**: a [number](/types/number) that is an RGB value for the gradient starting color.
+* **endColor**: a [number](/types/number) that is an RGB value for the gradient ending color.
+
+## Example
+
+Set a strip color gradient between `blue` and `red`.
+
+```blocks
+let strip = light.createStrip()
+strip.setGradient(0x0000cc, 0x880000)
+```
+
+## See Also
+
+[pixel color](/reference/light/neopixelstrip/pixel-color), [rgb](/reference/light/rgb)
+
+```package
+light
+```

package/libs/light/docs/reference/light/neopixelstrip/set-length.md

@@ -0,0 +1,30 @@
+# set Length
+
+Set the number of LEDs to use in a NeoPixel strip.
+
+```sig
+light.createStrip().setLength(1)
+```
+
+The strip will have a maximum length of addressable LEDs. You can set it to have a length less than or equal to the maximum length. Nothing will happen to any LEDs beyond this length if attempt to control is made.
+
+## Parameters
+
+* **numLeds**: a [number](/types/number) that is the current length to set for the LED strip.
+
+## Example
+
+Set the LED strip length to `8`.
+
+```blocks
+let strip = light.createStrip()
+strip.setLength(8)
+```
+
+[length](/reference/light/neopixelstrip/length)
+
+```package
+light
+```
+
+

package/libs/light/docs/reference/light/neopixelstrip/set-mode.md

@@ -13,6 +13,15 @@ Some LED strips also have a white LED (``NeoPixelMode.RGBW``).
 
 * **mode**: the desired mode
 
+## Example
+
+Set the mode of a NeoPixel LED strip to `RGBW`.
+
+```blocks
+let strip = light.createStrip()
+strip.setMode(NeoPixelMode.RGBW)
+```
+
 ```package
 light
 ```

package/libs/light/docs/reference/light/onboard-strip.md

@@ -0,0 +1,32 @@
+# onboard Strip
+
+Get a controller for the onboard programmable LED strip.
+
+```sig
+light.onboardStrip();
+```
+
+The onboard LED strip is a strip exits on the board. It is also usually set as the [default strip](/reference/light/neopixelstrip/default-strip).
+
+## Returns
+
+* a new **NeoPixelStrip** controller for the onboard neopixel strip.
+
+## Example
+
+Get the onboard pixel strip for the board. Make all pixels light up `green`.
+
+```typescript
+const strip = light.onboardStrip( );
+strip.setAll(0x00ff00)
+```
+
+## See also
+
+[default strip](/reference/light/neopixelstrip/default-strip),
+[range](/reference/light/neopixelstrip/range),
+[set mode](/reference/light/neopixelstrip/set-mode)
+
+```package
+light
+```

package/libs/light/docs/reference/light/range.md

@@ -0,0 +1,61 @@
+# range
+
+Create a new, smaller pixel strip from part of the default pixel strip.
+
+```sig
+light.createStrip().range(0, 4)
+```
+The new pixel strip is a smaller, _virtual_, strip with some or all of the pixels
+from the current, or original, strip. You can use **range** to make new mini strips from
+one larger strip for use in more complex light effects.
+
+If you have a pixel strip with 10 pixels, you can make 2 new _virtual_ strips by giving
+the new strips 5 pixels each. An example of this is something like:
+
+```block
+let strip0 = light.createStrip()
+let strip1 = strip0.range(0, 5)
+let strip2 = strip0.range(5, 5)
+```
+You can use these new pixels strips by themselves with their own light actions:
+
+```blocks
+let strip1 = light.range(0, 5)
+let strip2 = light.range(5, 5)
+strip1.setAll(0xffff00)
+strip2.setPixelColor(0, 0xff0000)
+```
+The original strip has a `red` pixel at pixel spot `5` but it's at pixel spot `0` for
+the new virtual strip called `strip2`.
+
+## Parameters
+
+* **start**: the pixel position where the new pixel strip starts at, such as 5
+* **length**: the amount of pixels the new pixel strip will have, like: 10
+
+## Returns
+
+* A new pixel strip created from the current pixel strip, with some or all of its pixels.
+
+## Example
+
+Make a smaller strip from the default pixel strip. Shift an `orange` pixel from the beginning
+of the new pixel strip to its end.
+
+```blocks
+let smallStrip = light.range(0, 4)
+smallStrip.setPixelColor(0, 0xff0000)
+for (let i = 0; i < smallStrip.length() - 1; i++) {
+    pause(500)
+    smallStrip.move(LightMove.Shift, 1)
+}
+```
+## See also
+
+[default strip](/reference/light/default-strip)
+
+```package
+light
+```
+
+

package/libs/light/docs/reference/light/set-length.md

@@ -0,0 +1,29 @@
+# set Length
+
+Set the number of LEDs to use in the default NeoPixel strip.
+
+```sig
+light.defaultStrip().setLength(1)
+```
+
+The default strip will have a maximum length of addressable LEDs. You can set it to have a length less than or equal to the maximum length. Nothing will happen to any LEDs beyond this length if attempt to control is made.
+
+## Parameters
+
+* **numLeds**: a [number](/types/number) that is the current length to set for the default LED strip.
+
+## Example
+
+Set the default LED strip length to `8`.
+
+```blocks
+light.setLength(8)
+```
+
+[length](/reference/light/range)
+
+```package
+light
+```
+
+

package/libs/light/docs/reference/light/set-mode.md

@@ -0,0 +1,28 @@
+# set Mode
+
+Sets the color encoding mode for the default light strip.
+
+```sig
+light.defaultStrip().setMode(NeoPixelMode.RGB)
+```
+
+Most light strips use the Green Red Blue encoding (``NeoPixelMode.RGB``), some use Red Green Blue (``NeoPixelMode.RGB_RGB``).
+Some LED strips also have a white LED (``NeoPixelMode.RGBW``).
+
+## Parameters
+
+* **mode**: the desired mode
+
+## Example
+
+Set the mode of the default LED strip to `RGBW`.
+
+```blocks
+light.setMode(NeoPixelMode.RGBW)
+```
+
+```package
+light
+```
+
+

package/libs/light/neopixel.ts

@@ -163,6 +163,7 @@ namespace light {
         //% blockId=lightsetgradient block="set %strip gradient from %startColor=colorNumberPicker to %endColor=colorNumberPicker"
         //% weight=79 blockGap=8
         //% group="More" advanced=true
+        //% help=light/neopixelstrip/set-gradient
         setGradient(startColor: number, endColor: number) {
             const sr = color.unpackR(startColor);
             const sg = color.unpackG(startColor);
@@ -857,6 +858,7 @@ namespace light {
         //% weight=1 blockGap=8
         //% length.shadow=lightLengthPicker
         //% group="Configuration" advanced=true
+        //% help=light/neopixelstrip/set-length
         setLength(numleds: number): void {
             const n = Math.max(0, numleds | 0);
             // lazy update

package/libs/mixer/sim/music.ts

@@ -1,9 +1,11 @@
 namespace pxsim.music {
     export function playInstructions(b: RefBuffer) {
+        setupOnStopAll();
         return AudioContextManager.playInstructionsAsync(b.data)
     }
 
     export function queuePlayInstructions(when: number, b: RefBuffer) {
+        setupOnStopAll();
         AudioContextManager.queuePlayInstructions(when, b)
     }
 
@@ -32,17 +34,27 @@ namespace pxsim.music {
 
     let sequencers: SequencerWithId[];
     let nextSequencerId = 0;
+    let onStopAllSetup = false;
 
-    export async function _createSequencer(): Promise<number> {
-        if (!sequencers) {
+    function setupOnStopAll() {
+        if (!onStopAllSetup) {
+            onStopAllSetup = true;
             pxsim.AudioContextManager.onStopAll(() => {
-                for (const seq of sequencers) {
-                    seq.sequencer.stop();
-                    seq.sequencer.dispose();
+                AudioContextManager.muteAllChannels();
+                if (sequencers) {
+                    for (const seq of sequencers) {
+                        seq.sequencer.stop();
+                        seq.sequencer.dispose();
+                    }
+                    sequencers = [];
                 }
-                sequencers = [];
             })
+        }
+    }
 
+    export async function _createSequencer(): Promise<number> {
+        setupOnStopAll();
+        if (!sequencers) {
             sequencers = [];
         }
         const res = {

package/libs/mouse/docs/reference/mouse/click.md

@@ -0,0 +1,38 @@
+# click
+
+Emulate a mouse button click.
+
+```sig
+mouse.click(MouseButton.Left)
+```
+
+A mouse button click is a rapid sequence of button `on` and `off` events. Using **click()** will simulate the two as one action.
+
+## ~ hint
+
+The @boardname@ needs a connection to a computer or other host device with a USB cable in order to emulate mouse actions. This function doesn't work in the simulator.
+
+## ~
+
+## Parameters
+
+* **button**: the identifier of the button to emulate a mouse click for: `left`, `right`, or `middle`.
+
+## Example #example
+
+Send a mouse button right-click to a computer that is connected to the @boardname@.
+
+```blocks
+input.buttonB.onEvent(ButtonEvent.Click, function() {
+    mouse.click(MouseButton.Right)
+})
+```
+
+## See also #seealso
+
+[set button](/reference/mouse/set-button),
+[turn wheel](/reference/mouse/turn-wheel)
+
+```package
+mouse
+```

package/libs/multiplayer/docs/reference/multiplayer/all-players.md

@@ -0,0 +1,34 @@
+# all Players
+
+Get all players in the multiplayer game list.
+
+```sig
+mp.allPlayers()
+```
+
+If you want to access the player list for all of the players in the game, you can get the entire list of players in an array.
+
+## Returns
+
+* a [Player](/types/player) list for all of the players in the multiplayer game.
+
+## Example #example
+
+Find all the players that have a score greater than `20` and give them a bonus of `5` points.
+
+```blocks
+for (let player of mp.allPlayers()) {
+    if (mp.getPlayerState(player, MultiplayerState.score) > 20) {
+        mp.changePlayerStateBy(player, MultiplayerState.score, 5)
+    }
+}
+```
+
+## See also #seealso
+
+[player selector](/reference/multiplayer/player-selector),
+[get player by number](/reference/multiplayer/get-player-by-number)
+
+```package
+multiplayer
+```

package/libs/multiplayer/docs/reference/multiplayer/is-connected.md

@@ -0,0 +1,36 @@
+# is Connected
+
+Check a player's connected state in the game.
+
+```sig
+mp.isConnected(mp.playerSelector(mp.PlayerNumber.One))
+```
+
+## Parameters
+
+* **player**: the player to check the connected state for.
+
+## Returns
+
+* a [boolean](/types/boolean) value for the state of the connected state of the player, `true` for connected and `false` for disconnected.
+
+## Example #example
+
+If `player 2` is no longer connected to the game, let `player 1` win by default.
+
+```blocks
+let pressCount = 0
+game.onUpdateInterval(10000, function () {
+    if (mp.isConnected(mp.playerSelector(mp.PlayerNumber.Two))) {
+        mp.gameOverPlayerWin(mp.playerSelector(mp.PlayerNumber.One))
+    }
+})
+```
+
+## See also #seealso
+
+[get player state](/reference/multiplayer/get-player-state)
+
+```package
+multiplayer
+```

package/libs/multiplayer/player.ts

@@ -471,7 +471,7 @@ namespace mp {
     //% group=Player
     //% weight=90
     //% blockGap=8
-    //% help=multiplayer/get-all-players
+    //% help=multiplayer/all-players
     //% parts="multiplayer"
     export function allPlayers(): Player[] {
         return _mpstate().players.slice();

package/libs/music/docs/reference/music/play-tone.md

@@ -7,9 +7,14 @@ music.playTone(Note.C, 10)
 ```
 
 ## #simnote
-#### ~hint
-**Simulator**: ``||music:play tone||`` works on the @boardname@. It might not work in the simulator on every browser.
-#### ~
+
+### ~hint
+
+#### Simulator
+
+``||music:play tone||`` works on the @boardname@. It might not work in the simulator on every browser.
+
+### ~
 
 ## Parameters
 

package/libs/music/docs/reference/music/set-tone.md

@@ -7,9 +7,14 @@ music.setTone(null)
 ```
 
 ## #simnote
-#### ~hint
-**Simulator**: ``||music:set tone||`` works on the @boardname@. It might not work in the simulator on every browser.
-#### ~
+
+### ~hint
+
+#### Simulator
+
+``||music:set tone||`` works on the @boardname@. It might not work in the simulator on every browser.
+
+### ~
 
 ## Parameters
 

package/libs/net-game/built/debug/binary.js

@@ -18043,7 +18043,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-power_checkDeepSleep__P115330.info = {"start":1087,"length":298,"line":36,"column":4,"endLine":46,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"checkDeepSleep","argumentNames":[]}
+power_checkDeepSleep__P115330.info = {"start":1084,"length":298,"line":36,"column":4,"endLine":46,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"checkDeepSleep","argumentNames":[]}
 
 function power_checkDeepSleep__P115330_mk(s) {
     checkStack(s.depth);
@@ -18106,7 +18106,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-power_init__P115332.info = {"start":1610,"length":376,"line":57,"column":4,"endLine":66,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"init","argumentNames":[]}
+power_init__P115332.info = {"start":1606,"length":376,"line":57,"column":4,"endLine":66,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"init","argumentNames":[]}
 
 function power_init__P115332_mk(s) {
     checkStack(s.depth);
@@ -22178,7 +22178,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-power_poke__P115329.info = {"start":795,"length":81,"line":26,"column":4,"endLine":29,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"poke","argumentNames":[]}
+power_poke__P115329.info = {"start":793,"length":81,"line":26,"column":4,"endLine":29,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"poke","argumentNames":[]}
 
 function power_poke__P115329_mk(s) {
     checkStack(s.depth);

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

@@ -7524,7 +7524,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-power_checkDeepSleep__P177795.info = {"start":1087,"length":298,"line":36,"column":4,"endLine":46,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"checkDeepSleep","argumentNames":[]}
+power_checkDeepSleep__P177795.info = {"start":1084,"length":298,"line":36,"column":4,"endLine":46,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"checkDeepSleep","argumentNames":[]}
 
 function power_checkDeepSleep__P177795_mk(s) {
     checkStack(s.depth);
@@ -7587,7 +7587,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-power_init__P177797.info = {"start":1610,"length":376,"line":57,"column":4,"endLine":66,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"init","argumentNames":[]}
+power_init__P177797.info = {"start":1606,"length":376,"line":57,"column":4,"endLine":66,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"init","argumentNames":[]}
 
 function power_init__P177797_mk(s) {
     checkStack(s.depth);
@@ -11999,7 +11999,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-power_poke__P177794.info = {"start":795,"length":81,"line":26,"column":4,"endLine":29,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"poke","argumentNames":[]}
+power_poke__P177794.info = {"start":793,"length":81,"line":26,"column":4,"endLine":29,"endColumn":5,"fileName":"pxt_modules/power/power.ts","functionName":"poke","argumentNames":[]}
 
 function power_poke__P177794_mk(s) {
     checkStack(s.depth);

package/libs/power/power.ts

@@ -13,7 +13,7 @@ namespace power {
      */
     //% blockId=powersetdeepsleeptimout block="power set deep sleep timeout to %seconds s"
     //% seconds.defl=60
-    //% help=/power/set-deep-sleep-timeout
+    //% help=power/set-deep-sleep-timeout
     export function setDeepSleepTimeout(seconds: number) {
         init();
         _timeout = seconds * 1000;
@@ -23,7 +23,7 @@ namespace power {
      * Poke the activity watcher to keep the device awake.
      */
     //% blockId=powerpke block="power poke"
-    //% help=/power/poke
+    //% help=power/poke
     export function poke() {
         init();
         _poked = control.millis();
@@ -33,7 +33,7 @@ namespace power {
      * Check if the device has had any "pokes" and needs to go into deep sleep mode.
      */
     //% blockId=powercheckdeepsleep block="power check deep sleep"
-    //% help=/power/check-deep-sleep
+    //% help=power/check-deep-sleep
     export function checkDeepSleep() {
         init();
         const p = _poked || 0;
@@ -51,7 +51,7 @@ namespace power {
      */
     //% blockId=powerdeepsleep block="power deep sleep"
     //% shim=pxt::deepSleep
-    //% help=/power/deep-sleep
+    //% help=power/deep-sleep
     export function deepSleep() {
     }