pxt-common-packages/libs/buttons/shims.d.ts

Microsoft MakeCode (PXT) common packages

// Auto-generated. Do not edit.


declare interface DigitalInOutPin {
    /**
     * Get the push button (connected to GND) for given pin
     */
    //% shim=DigitalInOutPinMethods::pushButton
    pushButton(): Button;
}



    //% noRefCounting fixedInstances
declare interface Button {
    /**
     * Do something when a button (`A`, `B` or both `A` + `B`) is clicked, double clicked, etc...
     * @param button the button that needs to be clicked or used
     * @param event the kind of button gesture that needs to be detected
     * @param body code to run when the event is raised
     */
    //% help=input/button/on-event
    //% blockId=buttonEvent block="on %button|%event"
    //% blockNamespace=input
    //% button.fieldEditor="gridpicker"
    //% button.fieldOptions.width=220
    //% button.fieldOptions.columns=3
    //% weight=96 blockGap=12
    //% trackArgs=0 shim=ButtonMethods::onEvent
    onEvent(ev: ButtonEvent, body: () => void): void;

    /**
     * Check if a button is pressed or not.
     * @param button the button to query the request
     */
    //% help=input/button/is-pressed
    //% block="%button|is pressed"
    //% blockId=buttonIsPressed
    //% blockNamespace=input
    //% button.fieldEditor="gridpicker"
    //% button.fieldOptions.width=220
    //% button.fieldOptions.columns=3
    //% weight=50 blockGap=8
    //% trackArgs=0 shim=ButtonMethods::isPressed
    isPressed(): boolean;

    /**
     * See if the button was pressed again since the last time you checked.
     * @param button the button to query the request
     */
    //% help=input/button/was-pressed
    //% block="%button|was pressed"
    //% blockId=buttonWasPressed
    //% blockNamespace=input
    //% button.fieldEditor="gridpicker"
    //% button.fieldOptions.width=220
    //% button.fieldOptions.columns=3
    //% group="More" weight=46 blockGap=8
    //% trackArgs=0 shim=ButtonMethods::wasPressed
    wasPressed(): boolean;

    /**
     * Gets the component identifier for the button
     */
    //% shim=ButtonMethods::id
    id(): int32;
}

// Auto-generated. Do not edit. Really.