47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
|
# Point Brightness
|
||
|
|
|
||
|
|
Read the brightness of a LED on the [LED screen](/device/screen).
|
||
|
|
|
||
|
|
```sig
|
||
|
|
led.pointBrightness(0,0);
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
* ``x`` is a [number](/types/number) that means the
|
||
|
|
horizontal spot on the LED screen (from left to right: 0, 1, 2, 3,
|
||
|
|
or 4)
|
||
|
|
* ``y`` is a [number](/types/number) that means the vertical
|
||
|
|
spot on the LED screen (from top to bottom: 0, 1, 2, 3, or 4)
|
||
|
|
|
||
|
|
If a parameter is [out of bounds](/reference/out-of-bounds) (a value
|
||
|
|
other than 0 to 4), this function will return `false`.
|
||
|
|
|
||
|
|
## Returns
|
||
|
|
|
||
|
|
* a [number](/blocks/logic/number). If it is `true`, that means the LED is on. If it is `false`, that means the LED is off.
|
||
|
|
|
||
|
|
## ~hint
|
||
|
|
|
||
|
|
The LED screen is a solid square of LEDs with five LEDs on each side.
|
||
|
|
To learn more about how you number the LEDs with ``x`` and ``y``
|
||
|
|
coordinates, see [LED screen](/device/screen).
|
||
|
|
|
||
|
|
## ~
|
||
|
|
|
||
|
|
## Example: Toggle off
|
||
|
|
|
||
|
|
This program turns the center LED (2, 2) off it is not bright enough. (If
|
||
|
|
it is already off, this program leaves it off.)
|
||
|
|
|
||
|
|
```blocks
|
||
|
|
if (led.pointBrightness(2, 2) < 100) {
|
||
|
|
led.unplot(2, 2)
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[unplot](/reference/led/unplot), [plot](/reference/led/plot), [LED screen](/device/screen)
|
||
|
|
|