pxt-calliope/docs/reference/input/on-button-event.md
Juri Wolf 2457725e0c
V4updates (#185)
* update 32KB

* reorder buttonEvents to have clicked as default

* update event block documentation file path

* remove on pin released documentation

* update shims, enums and package-lock
2022-05-09 10:10:17 -07:00

1.7 KiB

On Button Event

Start an event handler (part of the program that will run when something happens, like when a button is pressed). This handler works when button A or B is pressed, or A and B together. When you are using this function in a web browser, click the buttons on the screen instead of the ones on the @boardname@.

  • For button A or B: This handler works when the button is pushed down and released within 1 second.
  • For A and B together: This handler works when A and B are both pushed down, then one of them is released within 1.5 seconds of pushing down the second button.
input.onButtonEvent(Button.A, ButtonEvent.Click, () => {})

Find out how buttons provide input to the @boardname@ in this video:

https://www.youtube.com/watch?v=t_Qujjd_38o

Example: count button clicks

This example counts how many times you press the A button. Each time you press the button, the LED screen shows the count variable getting bigger.

let count = 0
basic.showNumber(count)
input.onButtonEvent(Button.A, ButtonEvent.Click, () => {
    count++;
    basic.showNumber(count);
})

Example: roll dice

This example shows a number from 1 to 6 when you press the B button.

input.onButtonEvent(Button.B, ButtonEvent.Click, () => {
    let dice = randint(0, 5) + 1
    basic.showNumber(dice)
})

~hint

This program adds a 1 to random(5) so the numbers on the dice will come out right. Otherwise, sometimes they would show a 0.

~

See also

button is pressed, forever, random