More fixes from the Lancaster doc review. (#453)

This commit is contained in:
Galen Nickel
2017-07-17 23:47:27 -07:00
committed by Peli de Halleux
parent 1031a1262f
commit 8e730f619c
6 changed files with 124 additions and 4 deletions

View File

@ -0,0 +1,41 @@
# arrow Image
Create an arrow shaped [image](/reference/images/image) for the [LED screen](/device/screen).
```sig
images.arrowImage(ArrowNames.North)
```
The arrow points in the direction of the arrow name you choose, like `North`.
## Parameters
* **i**: the arrow name to make an arrow [image](/reference/images/image) for. You can make an arrow image that points in one of these directions:
>* `North`
* `NorthEast`
* `East`
* `SouthEast`
* `South`
* `SouthWest`
* `West`
* `NorthWest`
## Example
Display a left arrow when button A is pressed or a right arrow when button B is pressed.
```blocks
let arrowLeft = images.arrowImage(ArrowNames.West)
let arrowRight = images.arrowImage(ArrowNames.East)
input.onButtonPressed(Button.A, () => {
arrowLeft.showImage(0);
});
input.onButtonPressed(Button.B, () => {
arrowRight.showImage(0);
});
```
## See also
[arrow number](/reference/images/arrow-number)

View File

@ -0,0 +1,33 @@
# arrow Number
Get the number that matches an arrow image name.
```sig
images.arrowNumber(ArrowNames.North)
```
Each arrow image name has a number for it. You can find the number for any arrow name with ``||arrow number||``.
## Parameters
* **arrow**: the arrow name to get an arrow number for. These are the arrow names:
>* `North`
* `NorthEast`
* `East`
* `SouthEast`
* `South`
* `SouthWest`
* `West`
* `NorthWest`
## Example
Get the arrow number for `ArrowNames.South`.
```blocks
let arrowSouthNumber = images.arrowNumber(ArrowNames.South)
```
## See also
[arrow image](/reference/images/arrow-image)

View File

@ -0,0 +1,33 @@
# icon Image
Create an icon [image](/reference/images/image) for the [LED screen](/device/screen).
```sig
images.iconImage(IconNames.Heart);
```
There are lots of pre-made icon images you can use to display on the [LED screen](/device/screen) of the @boardname@. You choose an icon by its name.
## Parameters
* **i**: the icon name of the image you want to show on the [LED screen](/device/screen). You pick an icon image such as: `IconNames.Heart`.
## Example
Show a happy face when button A is pressed or a sad face when button B is pressed.
```blocks
let iamHappy = images.iconImage(IconNames.Happy)
let iamSad = images.iconImage(IconNames.Sad)
input.onButtonPressed(Button.A, () => {
iamHappy.showImage(0);
});
input.onButtonPressed(Button.B, () => {
iamSad.showImage(0);
});
```
## See also
[arrow image](/reference/images/arrow-image)