pxt-common-packages 10.3.14 → 10.3.16

package/libs/multiplayer/docs/reference/multiplayer/change-player-state-by.md

@@ -0,0 +1,121 @@
+# change Player State By
+
+Change a player state value by some amount.
+
+```sig
+mp.changePlayerStateBy(mp.playerSelector(mp.PlayerNumber.One), MultiplayerState.score, 0)
+```
+A [Player](/types/player) state value is changed by adding or subtracting some amount from the current value. The change amount is in the **delta** parameter. If the player's ``||mp:score||`` value is `20` and you want to add `1` to the score, set **delta** to `1`. Similarly, if you want to reduce ``||mp:score||`` to `15`, set **delta** to `-5`.
+
+## Parameters
+
+* **player**: the player to change the a **state** value for.
+* **state**: the [state item](/reference/multiplayer/multiplayer-state) to change, such as `score` or `life`.
+* **delta**: the amount to change the **state** value by.
+
+## Example #example
+
+Set `player 1` score state to `0`. Send the player's shark sprite across the screen to eat a goldfish on the opposite side. When the shark overlaps the goldfish, add `1` to `player 1` score state.
+
+```blocks
+namespace MultiplayerState {
+    export const gems = MultiplayerState.create()
+}
+sprites.onOverlap(SpriteKind.Player, SpriteKind.Food, function (sprite, otherSprite) {
+    goldfish.destroy(effects.warmRadial, 200)
+    mp.changePlayerStateBy(mp.playerSelector(mp.PlayerNumber.One), MultiplayerState.score, 1)
+})
+let chomp = false
+let goldfish: Sprite = null
+mp.setPlayerState(mp.playerSelector(mp.PlayerNumber.One), MultiplayerState.score, 0)
+goldfish = sprites.create(img`
+    . . . . . . . . . . . . . . . . 
+    . . . . . . . . c c c c . . . . 
+    . . . . . . c c d d d d c . . . 
+    . . . . . c c c c c c d c . . . 
+    . . . . c c 4 4 4 4 d c c . . . 
+    . . . c 4 d 4 4 4 4 4 1 c . c c 
+    . . c 4 4 4 1 4 4 4 4 d 1 c 4 c 
+    . c 4 4 4 4 1 4 4 4 4 4 1 c 4 c 
+    f 4 4 4 4 4 1 4 4 4 4 4 1 4 4 f 
+    f 4 4 4 f 4 1 c c 4 4 4 1 f 4 f 
+    f 4 4 4 4 4 1 4 4 f 4 4 d f 4 f 
+    . f 4 4 4 4 1 c 4 f 4 d f f f f 
+    . . f f 4 d 4 4 f f 4 c f c . . 
+    . . . . f f 4 4 4 4 c d b c . . 
+    . . . . . . f f f f d d d c . . 
+    . . . . . . . . . . c c c . . . 
+    `, SpriteKind.Food)
+goldfish.left = 0
+mp.setPlayerSprite(mp.playerSelector(mp.PlayerNumber.One), sprites.create(img`
+    .................ccfff..............
+    ................cddbbf..............
+    ...............cddbbf...............
+    ..............fccbbcf............ccc
+    ........ffffffccccccff.........ccbbc
+    ......ffbbbbbbbbbbbbbcfff.....cdbbc.
+    ....ffbbbbbbbbbcbcbbbbcccff..cddbbf.
+    ....fbcbbbbbffbbcbcbbbcccccfffdbbf..
+    ....fbbb1111ff1bcbcbbbcccccccbbbcf..
+    .....fb11111111bbbbbbcccccccccbccf..
+    ......fccc33cc11bbbbccccccccfffbbcf.
+    .......fc131c111bbbcccccbdbc...fbbf.
+    ........f33c111cbbbfdddddcc.....fbbf
+    .........ff1111fbdbbfddcc........fff
+    ...........cccccfbdbbfc.............
+    .................fffff..............
+    `, SpriteKind.Player))
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).right = scene.screenWidth()
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).vx = -30
+game.onUpdateInterval(500, function () {
+    if (chomp == true) {
+        mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).setImage(img`
+            ....................ccfff...........
+            ..........fffffffffcbbbbf...........
+            .........fbbbbbbbbbfffbf............
+            .........fbb111bffbbbbff............
+            .........fb11111ffbbbbbcff..........
+            .........f1cccc11bbcbcbcccf.........
+            ..........fc1c1c1bbbcbcbcccf...ccccc
+            ............c3331bbbcbcbccccfccddbbc
+            ...........c333c1bbbbbbbcccccbddbcc.
+            ...........c331c11bbbbbcccccccbbcc..
+            ..........cc13c111bbbbccccccffbccf..
+            ..........c111111cbbbcccccbbc.fccf..
+            ...........cc1111cbbbfdddddc..fbbcf.
+            .............cccffbdbbfdddc....fbbf.
+            ..................fbdbbfcc......fbbf
+            ...................fffff.........fff
+            `)
+    } else {
+        mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).setImage(img`
+            .................ccfff..............
+            ................cddbbf..............
+            ...............cddbbf...............
+            ..............fccbbcf............ccc
+            ........ffffffccccccff.........ccbbc
+            ......ffbbbbbbbbbbbbbcfff.....cdbbc.
+            ....ffbbbbbbbbbcbcbbbbcccff..cddbbf.
+            ....fbcbbbbbffbbcbcbbbcccccfffdbbf..
+            ....fbbb1111ff1bcbcbbbcccccccbbbcf..
+            .....fb11111111bbbbbbcccccccccbccf..
+            ......fccc33cc11bbbbccccccccfffbbcf.
+            .......fc131c111bbbcccccbdbc...fbbf.
+            ........f33c111cbbbfdddddcc.....fbbf
+            .........ff1111fbdbbfddcc........fff
+            ...........cccccfbdbbfc.............
+            .................fffff..............
+            `)
+    }
+    chomp = !(chomp)
+})
+```
+
+## See also #seealso
+
+[set player state](/reference/multiplayer/set-player-state),
+[get player state](/reference/multiplayer/get-player-state)
+
+```package
+multiplayer
+```

package/libs/multiplayer/docs/reference/multiplayer/game-over-player-win.md

@@ -0,0 +1,88 @@
+# game Over Player Win
+
+End the game and set a player to win.
+
+```sig
+mp.gameOverPlayerWin(mp.playerSelector(mp.PlayerNumber.One))
+```
+
+## Parameters
+
+* **player**: the [player](/types/player) set to win the game.
+
+## Example #example
+
+Send two player sprites moving around the screen. Place a food (donut) sprite at the left side of the screen. When a player sprite reaches the donut, that player wins the game.
+
+```blocks
+sprites.onOverlap(SpriteKind.Player, SpriteKind.Food, function (sprite, otherSprite) {
+    mp.gameOverPlayerWin(mp.getPlayerBySprite(sprite))
+})
+let mySprite = sprites.create(img`
+    . . . . . . b b b b a a . . . . 
+    . . . . b b d d d 3 3 3 a a . . 
+    . . . b d d d 3 3 3 3 3 3 a a . 
+    . . b d d 3 3 3 3 3 3 3 3 3 a . 
+    . b 3 d 3 3 3 3 3 b 3 3 3 3 a b 
+    . b 3 3 3 3 3 a a 3 3 3 3 3 a b 
+    b 3 3 3 3 3 a a 3 3 3 3 d a 4 b 
+    b 3 3 3 3 b a 3 3 3 3 3 d a 4 b 
+    b 3 3 3 3 3 3 3 3 3 3 d a 4 4 e 
+    a 3 3 3 3 3 3 3 3 3 d a 4 4 4 e 
+    a 3 3 3 3 3 3 3 d d a 4 4 4 e . 
+    a a 3 3 3 d d d a a 4 4 4 e e . 
+    . e a a a a a a 4 4 4 4 e e . . 
+    . . e e b b 4 4 4 4 b e e . . . 
+    . . . e e e e e e e e . . . . . 
+    . . . . . . . . . . . . . . . . 
+    `, SpriteKind.Food)
+mySprite.left = 0
+mp.setPlayerSprite(mp.playerSelector(mp.PlayerNumber.One), sprites.create(img`
+    . . . . . f f f f f . . . . . . 
+    . . . . f e e e e e f . . . . . 
+    . . . f d d d d d d e f . . . . 
+    . . f d f f d d f f d f f . . . 
+    . c d d d e e d d d d e d f . . 
+    . c d c d d d d c d d e f f . . 
+    . c d d c c c c d d d e f f f f 
+    . . c d d d d d d d e f f b d f 
+    . . . c d d d d e e f f f d d f 
+    . . . . f f f e e f e e e f f f 
+    . . . . f e e e e e e e f f f . 
+    . . . f e e e e e e f f f e f . 
+    . . f f e e e e f f f f f e f . 
+    . f b d f e e f b b f f f e f . 
+    . f d d f f f f d d b f f f f . 
+    . f f f f f f f f f f f f f . . 
+    `, SpriteKind.Player))
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).setBounceOnWall(true)
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).setVelocity(40, -30)
+mp.setPlayerSprite(mp.playerSelector(mp.PlayerNumber.Two), sprites.create(img`
+    . . . . . . . . . . . . . . . . 
+    . . . . c c c c . . . . . . . . 
+    . . c c 5 5 5 5 c c . . . . . . 
+    . c 5 5 5 5 5 5 5 5 c . . . . . 
+    c 5 5 5 5 5 1 f 5 5 5 c . . . . 
+    c 5 5 5 5 5 f f 5 5 5 5 c . . . 
+    c 5 5 5 5 5 5 5 5 5 5 5 c . . . 
+    c c b b 1 b 5 5 5 5 5 5 d c . . 
+    c 5 3 3 3 5 5 5 5 5 d d d c . . 
+    . b 5 5 5 5 5 5 5 5 d d d c . . 
+    . . c b b c 5 5 b d d d d c . . 
+    . c b b c 5 5 b b d d d d c c c 
+    . c c c c c c d d d d d d d d c 
+    . . . c c c c d 5 5 b d d c c . 
+    . . c b b c c c 5 5 b c c . . . 
+    . . c c c c c d 5 5 c . . . . . 
+    `, SpriteKind.Player))
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.Two)).setBounceOnWall(true)
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.Two)).setVelocity(50, 40)
+```
+
+## See also #seealso
+
+[get player by sprite](/reference/multiplayer/get-player-by-sprite)
+
+```package
+multiplayer
+```

package/libs/multiplayer/docs/reference/multiplayer/get-player-by-index.md

@@ -0,0 +1,40 @@
+# get Player By Index
+
+Get a Player from the multiplayer game list using an index value.
+
+```sig
+mp.getPlayerByIndex(0)
+```
+
+You can get a [Player](/types/player) object from the multiplayer using an index value for a location in the list. Index values start at `0` for the first list location and range to the maximum number of players minus `1` (currently `4` players maximum so, the maximum list index is `4 - 1` = `3`).
+
+## Parameters
+
+* **index**: a [number](/types/number) that is the index of the Player in the multiplayer list.
+
+## Returns
+
+* the [Player](/types/player) in the multiplayer list at location **index**.
+
+## Example #example
+
+Find all the players that have a score greater than `20` and give them a bonus of `5` points.
+
+```blocks
+let player: mp.Player = null
+for (let index = 0; index <= 3; index++) {
+    player = mp.getPlayerByIndex(index)
+    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/get-player-by-number.md

@@ -0,0 +1,34 @@
+# get Player By Number
+
+Get a game Player using a player number value.
+
+```sig
+mp.getPlayerByNumber(0)
+```
+
+Rather than using a [player selector](/reference/multiplayer/player-selector), a [Player](/types/player) is returned for a player **number**. Player numbers start from `1` and range to the maximum number of players (currently `4`).
+
+## Parameters
+
+* **number**: a player [number](/types/number).
+
+## Returns
+
+* the [Player](/types/player) which matches **number**.
+
+## Example #example
+
+Give `player 4` an extra `5` life points.
+
+```blocks
+mp.changePlayerStateBy(mp.getPlayerByNumber(4), MultiplayerState.life, 5)
+```
+
+## See also #seealso
+
+[player selector](/reference/multiplayer/player-selector),
+[get player by index](/reference/multiplayer/get-player-by-index)
+
+```package
+multiplayer
+```

package/libs/multiplayer/docs/reference/multiplayer/get-player-by-sprite.md

@@ -0,0 +1,109 @@
+# get Player By Sprite
+
+Get the Player that has this character sprite.
+
+```sig
+mp.getPlayerBySprite(null)
+```
+
+## Parameters
+
+* **sprite**: the character sprite whose [Player](/types/player) is returned.
+
+## Returns
+
+* the [Player](/types/player) that is assigned this **sprite**.
+
+## Example #example
+
+Send 2 player sprites moving around the screen. When they overlap the hamburger sprite, make one player say that they like the hamburger and they other say that they don't.
+
+```blocks
+sprites.onOverlap(SpriteKind.Player, SpriteKind.Food, function (sprite, otherSprite) {
+    if (mp.getPlayerProperty(mp.getPlayerBySprite(sprite), mp.PlayerProperty.Number) == 1) {
+        sprite.sayText("Yum, burger!", 100, false)
+    } else {
+        sprite.sayText("Hate, burgers!", 100, false)
+    }
+})
+let burger = sprites.create(img`
+    ...........ccccc66666...........
+    ........ccc4444444444666........
+    ......cc444444444bb4444466......
+    .....cb4444bb4444b5b444444b.....
+    ....eb4444b5b44444b44444444b....
+    ...ebb44444b4444444444b444446...
+    ..eb6bb444444444bb444b5b444446..
+    ..e6bb5b44444444b5b444b44bb44e..
+    .e66b4b4444444444b4444444b5b44e.
+    .e6bb444444444444444444444bb44e.
+    eb66b44444bb444444444444444444be
+    eb66bb444b5b44444444bb44444444be
+    fb666b444bb444444444b5b4444444bf
+    fcb666b44444444444444bb444444bcf
+    .fbb6666b44444444444444444444bf.
+    .efbb66666bb4444444444444444bfe.
+    .86fcbb66666bbb44444444444bcc688
+    8772effcbbbbbbbbbbbbbbbbcfc22778
+    87722222cccccccccccccccc22226678
+    f866622222222222222222222276686f
+    fef866677766667777776667777fffef
+    fbff877768f86777777666776fffffbf
+    fbeffeefffeff7766688effeeeefeb6f
+    f6bfffeffeeeeeeeeeeeeefeeeeebb6e
+    f66ddfffffeeeffeffeeeeeffeedb46e
+    .c66ddd4effffffeeeeeffff4ddb46e.
+    .fc6b4dddddddddddddddddddb444ee.
+    ..ff6bb444444444444444444444ee..
+    ....ffbbbb4444444444444444ee....
+    ......ffebbbbbb44444444eee......
+    .........fffffffcccccee.........
+    ................................
+    `, SpriteKind.Food)
+mp.setPlayerSprite(mp.playerSelector(mp.PlayerNumber.One), sprites.create(img`
+    . . 4 4 4 . . . . 4 4 4 . . . . 
+    . 4 5 5 5 e . . e 5 5 5 4 . . . 
+    4 5 5 5 5 5 e e 5 5 5 5 5 4 . . 
+    4 5 5 4 4 5 5 5 5 4 4 5 5 4 . . 
+    e 5 4 4 5 5 5 5 5 5 4 4 5 e . . 
+    . e e 5 5 5 5 5 5 5 5 e e . . . 
+    . . e 5 f 5 5 5 5 f 5 e . . . . 
+    . . f 5 5 5 4 4 5 5 5 f . . f f 
+    . . f 4 5 5 f f 5 5 6 f . f 5 f 
+    . . . f 6 6 6 6 6 6 4 4 f 5 5 f 
+    . . . f 4 5 5 5 5 5 5 4 4 5 f . 
+    . . . f 5 5 5 5 5 4 5 5 f f . . 
+    . . . f 5 f f f 5 f f 5 f . . . 
+    . . . f f . . f f . . f f . . . 
+    `, SpriteKind.Player))
+mp.setPlayerSprite(mp.playerSelector(mp.PlayerNumber.Two), sprites.create(img`
+    . . . . f f f f f . . . . . . . 
+    . . . f e e e e e f f f . . . . 
+    . . f d d d e e e e d d f . . . 
+    . c d d d d d e e e b d c . . . 
+    . c d d d d d d e e b d c . . . 
+    c d d f d d f d e e f c . f f . 
+    c d d f d d f d e e f . . f e f 
+    c d e e d d d d e e f . . f e f 
+    . f d d d c d e e f f . . f e f 
+    . . f f f d e e e e e f . f e f 
+    . . . . f e e e e e e e f f f . 
+    . . . . f f e e e e e b f f . . 
+    . . . f e f f e e c d d f f . . 
+    . . f d d b d d c f f f . . . . 
+    . . f d d c d d d f f . . . . . 
+    . . . f f f f f f f . . . . . . 
+    `, SpriteKind.Player))
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).setVelocity(60, 50)
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).setBounceOnWall(true)
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.Two)).setVelocity(50, -50)
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.Two)).setBounceOnWall(true)
+```
+
+## See also #seealso
+
+[get player sprite](/reference/multiplayer/get-player-sprite)
+
+```package
+multiplayer
+```

package/libs/multiplayer/docs/reference/multiplayer/get-player-property.md

@@ -0,0 +1,55 @@
+# get Player Property
+
+Get the value of a Player property.
+
+```sig
+mp.getPlayerProperty(mp.playerSelector(mp.PlayerNumber.One), PlayerProperty.Index)
+```
+
+Player properties contain identity information. These are set for a [Player](/types/player) object when it's created to uniquely identfy it. Currently, there are two properties: ``||mp:index||`` and ``||mp:number||``.
+
+## Parameters
+
+* **player**: the [Player](/types/player) to get a property for. item value for.
+* **prop**: the property to get a **value** for:
+>* `index`: the zero-based index of the Player in the multiplayer object list.
+>* `number`: the player identity number of the Player object.
+
+## Returns
+
+* a [number](/types/number) which is the value for the property.
+
+## Example #example
+
+Get the player number property for `player 1` and display it with its character sprite. 
+
+```blocks
+scene.setBackgroundColor(10)
+mp.setPlayerSprite(mp.playerSelector(mp.PlayerNumber.One), sprites.create(img`
+    . . . . . f f f f f . . . . . . 
+    . . . . f e e e e e f . . . . . 
+    . . . f d d d d d d e f . . . . 
+    . . f d f f d d f f d f f . . . 
+    . c d d d e e d d d d e d f . . 
+    . c d c d d d d c d d e f f . . 
+    . c d d c c c c d d d e f f f f 
+    . . c d d d d d d d e f f b d f 
+    . . . c d d d d e e f f f d d f 
+    . . . . f f f e e f e e e f f f 
+    . . . . f e e e e e e e f f f . 
+    . . . f e e e e e e f f f e f . 
+    . . f f e e e e f f f f f e f . 
+    . f b d f e e f b b f f f e f . 
+    . f d d f f f f d d b f f f f . 
+    . f f f f f f f f f f f f f . . 
+    `, SpriteKind.Player))
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).sayText("I'm player " + mp.getPlayerProperty(mp.playerSelector(mp.PlayerNumber.One), mp.PlayerProperty.Number))
+```
+
+## See also #seealso
+
+[get player state](/reference/multiplayer/get-player-state)
+
+```package
+multiplayer
+```

package/libs/multiplayer/docs/reference/multiplayer/get-player-sprite.md

@@ -0,0 +1,59 @@
+# get Player Sprite
+
+Get the character sprite assigned to a Player.
+
+```sig
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One))
+```
+
+## Parameters
+
+* **player**: the [Player](/types/player) whose sprite will be returned.
+
+## Returns
+
+* the [sprite](/reference/types/sprite) that is assigned to the **player**.
+
+## Example #example
+
+Make a player sprite move across the screen. When the sprite reaches the edge of the screen, send the sprite back in the opposite direction and flip the image of the sprite.
+
+```blocks
+scene.setBackgroundColor(8)
+mp.setPlayerSprite(mp.playerSelector(mp.PlayerNumber.One), sprites.create(img`
+    .............ccfff..............
+    ...........ccddbcf..............
+    ..........ccddbbf...............
+    ..........fccbbcf...............
+    .....fffffccccccff.........ccc..
+    ...ffbbbbbbbcbbbbcfff....ccbbc..
+    ..fbbbbbbbbcbcbbbbcccff.cdbbc...
+    ffbbbbbbffbbcbcbbbcccccfcdbbf...
+    fbcbbb11ff1bcbbbbbcccccffbbf....
+    fbbb11111111bbbbbcccccccbbcf....
+    .fb11133cc11bbbbcccccccccccf....
+    ..fccc31c111bbbcccccbdbffbbcf...
+    ...fc13c111cbbbfcddddcc..fbbf...
+    ....fccc111fbdbbccdcc.....fbbf..
+    ........ccccfcdbbcc........fff..
+    .............fffff..............
+    `, SpriteKind.Player))
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).vx = -20
+game.onUpdateInterval(500, function () {
+    if (mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).x < 0 || mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).x > scene.screenWidth()) {
+        mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).image.flipX()
+        mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).vx = mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).vx * -1
+    } else {
+        mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).startEffect(effects.bubbles, 100)
+    }
+})
+```
+
+## See also #seealso
+
+[set player sprite](/reference/multiplayer/set-player-sprite),
+[get player by sprite](/reference/multiplayer/get-player-by-sprite)
+
+```package
+multiplayer
+```

package/libs/multiplayer/docs/reference/multiplayer/get-player-state.md

@@ -0,0 +1,55 @@
+# get Player State
+
+Get the value of a Player state item.
+
+```sig
+mp.getPlayerState(mp.playerSelector(mp.PlayerNumber.One), MultiplayerState.score)
+```
+
+Information like the player's score and life count is contained with the [Player](/types/player) game object. The Player object has the ``||mp:score||`` and ``||mp:life||`` state items already added.
+
+## Parameters
+
+* **player**: the [Player](/types/player) to get a state item value for.
+* **state**: the [state item](/reference/multiplayer/multiplayer-state) to get a **value** for, such as `score` or `life`.
+
+## Returns
+
+* **value**: a [number](/types/number) which is the value for **state**.
+
+## Example #example
+
+Get the ``||mp:number||`` property  for `player 3`.
+
+```blocks
+scene.setBackgroundColor(10)
+mp.setPlayerSprite(mp.playerSelector(mp.PlayerNumber.One), sprites.create(img`
+    . . . . . f f f f f . . . . . . 
+    . . . . f e e e e e f . . . . . 
+    . . . f d d d d d d e f . . . . 
+    . . f d f f d d f f d f f . . . 
+    . c d d d e e d d d d e d f . . 
+    . c d c d d d d c d d e f f . . 
+    . c d d c c c c d d d e f f f f 
+    . . c d d d d d d d e f f b d f 
+    . . . c d d d d e e f f f d d f 
+    . . . . f f f e e f e e e f f f 
+    . . . . f e e e e e e e f f f . 
+    . . . f e e e e e e f f f e f . 
+    . . f f e e e e f f f f f e f . 
+    . f b d f e e f b b f f f e f . 
+    . f d d f f f f d d b f f f f . 
+    . f f f f f f f f f f f f f . . 
+    `, SpriteKind.Player))
+mp.getPlayerSprite(mp.playerSelector(mp.PlayerNumber.One)).sayText("I'm player " + mp.getPlayerProperty(mp.playerSelector(mp.PlayerNumber.One), mp.PlayerProperty.Number))
+```
+
+## See also #seealso
+
+[set player state](/refernece/multiplayer/set-player-state),
+[change player state by](/reference/multiplayer/change-player-state-by),
+[get player property](/reference/multiplayer/get-player-property)
+
+```package
+multiplayer
+```

package/libs/multiplayer/docs/reference/multiplayer/is-button-pressed.md

@@ -0,0 +1,44 @@
+# is Button Pressed
+
+Check if a controller button for a player is pressed or not.
+
+```sig
+mp.isButtonPressed(mp.playerSelector(mp.PlayerNumber.One), mp.MultiplayerButton.A)
+```
+
+## Parameters
+
+* **player**: the player to check the controller button state for.
+* **button**: the controller button to check for a pressed condition.
+
+## Returns
+
+* a [boolean](/types/boolean) value for the state of the **button** for the **player**. It is `true` if the button is pressed and `false` if the button is not pressed.
+
+## Example #example
+
+If `player 2` is pressing the up arrow button for too long, then`player 1` wins.
+
+```blocks
+let pressCount = 0
+game.onUpdateInterval(500, function () {
+    if (mp.isButtonPressed(mp.playerSelector(mp.PlayerNumber.Two), mp.MultiplayerButton.Up)) {
+        pressCount += 1
+        if (pressCount > 1) {
+            mp.gameOverPlayerWin(mp.playerSelector(mp.PlayerNumber.One))
+        }
+    } else {
+        pressCount = 0
+    }
+})
+```
+
+## See also #seealso
+
+[on button pressed](/reference/multiplayer/on-button-pressed),
+[move with buttons](/reference/multiplayer/move-with-buttons)
+
+
+```package
+multiplayer
+```

package/libs/multiplayer/docs/reference/multiplayer/move-with-buttons.md

@@ -0,0 +1,50 @@
+# move With Buttons
+
+Add movement control to a player sprite with the controller arrow buttons.
+
+```sig
+mp.moveWithButtons(mp.playerSelector(mp.PlayerNumber.One))
+```
+
+A player's sprite will move vertically or horizontally with the controller's arrow buttons. The horizontal `vx` and vertical `vy` values a speeds (pixels per second) at which the sprite will move when an arrow button is pressed. If no values are set for `vx` and `vy`, the default value of `100` is used.
+
+## Parameters
+
+* **player**: the player to set movement control for.
+* **vx**: an optional velocity (speed) to move the player in the left or right direction. The default value is `100`.
+* **vy**: an optional velocity (speed) to move the player the up or down direction. The default value is `100`.
+
+## Example #example
+
+Set a character sprite for `player 2` and make it move with the controller buttons.
+
+```blocks
+scene.setBackgroundColor(10)
+mp.setPlayerSprite(mp.playerSelector(mp.PlayerNumber.Two), sprites.create(img`
+    . . . . . f f f f f . . . . . . 
+    . . . . f e e e e e f . . . . . 
+    . . . f d d d d d d e f . . . . 
+    . . f d f f d d f f d f f . . . 
+    . c d d d e e d d d d e d f . . 
+    . c d c d d d d c d d e f f . . 
+    . c d d c c c c d d d e f f f f 
+    . . c d d d d d d d e f f b d f 
+    . . . c d d d d e e f f f d d f 
+    . . . . f f f e e f e e e f f f 
+    . . . . f e e e e e e e f f f . 
+    . . . f e e e e e e f f f e f . 
+    . . f f e e e e f f f f f e f . 
+    . f b d f e e f b b f f f e f . 
+    . f d d f f f f d d b f f f f . 
+    . f f f f f f f f f f f f f . . 
+    `, SpriteKind.Player))
+mp.moveWithButtons(mp.playerSelector(mp.PlayerNumber.Two))
+```
+
+## See also #seealso
+
+[is button pressed](/reference/multiplayer/is-button-pressed)
+
+```package
+multiplayer
+```