Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface uiElement

jQuery like way to instantiate ui elements.

You can instantiate ui elements with the appropriate id (panel id, widget id etc), then set event listeners on that element.

Example:

const ui = require('./ui');
ui('fireMissileButton').onButtonClicked(() => fireRocket());
ui('aimDirectionPad').onDirectionPadClicked(button => moveRocket(button));
ui('speedSlider', 0, 100).onSliderChanaged(percent => setRocketSpeed(percent));

Note: The library does not check that the id you provide exists, is valid or of the correct type, this is the reponsibility of the user. That also means that you can create your listeners before the element actually exists.

Hierarchy

  • uiElement

Index

Methods

Methods

onButtonClicked

onButtonPressed

onButtonReleased

  • onButtonReleased(callback: Function): XapiResult

onDirectionalPadClicked

  • onDirectionalPadClicked(callback: (buttonId: string) => void): XapiResult

  • Parameters

    • callback: (buttonId: string) => void
        • (buttonId: string): void

        • Parameters

          • buttonId: string

          Returns void

    Returns XapiResult

onDirectionalPadPressed

  • onDirectionalPadPressed(callback: (buttonId: string) => void): XapiResult

  • Parameters

    • callback: (buttonId: string) => void
        • (buttonId: string): void

        • Parameters

          • buttonId: string

          Returns void

    Returns XapiResult

onDirectionalPadReleased

  • onDirectionalPadReleased(callback: (buttonId: string) => void): XapiResult

  • Parameters

    • callback: (buttonId: string) => void
        • (buttonId: string): void

        • Parameters

          • buttonId: string

          Returns void

    Returns XapiResult

onGroupButtonPressed

  • onGroupButtonPressed(callback: (groupButtonId: string) => void): XapiResult

  • Parameters

    • callback: (groupButtonId: string) => void
        • (groupButtonId: string): void

        • Parameters

          • groupButtonId: string

          Returns void

    Returns XapiResult

onGroupButtonReleased

  • onGroupButtonReleased(callback: (groupButtonId: string) => void): XapiResult

  • Parameters

    • callback: (groupButtonId: string) => void
        • (groupButtonId: string): void

        • Parameters

          • groupButtonId: string

          Returns void

    Returns XapiResult

onPageClosed

onPageOpened

onPanelClicked

onPanelClosed

onPanelOpened

onPromptCancel

  • onPromptCancel(callback: () => void): XapiResult

onPromptResponse

  • onPromptResponse(callback: (choiceId: number) => void): XapiResult

  • Parameters

    • callback: (choiceId: number) => void
        • (choiceId: number): void

        • Parameters

          • choiceId: number

          Returns void

    Returns XapiResult

onSliderChanged

  • onSliderChanged(callback: (value: number) => void, min: number, max: number): XapiResult

  • Feedback when a slider changes value <0, 255>. If you specify min/max, the value will be automatically scaled to your chosen range (typically 0-100 or 0-1).

    Parameters

    • callback: (value: number) => void
        • (value: number): void

        • Parameters

          • value: number

          Returns void

    • min: number
    • max: number

    Returns XapiResult

onSliderReleased

  • onSliderReleased(callback: (value: number) => void, min: number, max: number): XapiResult

  • See onSliderChanged

    Parameters

    • callback: (value: number) => void
        • (value: number): void

        • Parameters

          • value: number

          Returns void

    • min: number
    • max: number

    Returns XapiResult

onSpinnerClicked

  • onSpinnerClicked(callback: (increment: boolean) => void): XapiResult

  • Parameters

    • callback: (increment: boolean) => void
        • (increment: boolean): void

        • Parameters

          • increment: boolean

          Returns void

    Returns XapiResult

onSpinnerPressed

  • onSpinnerPressed(callback: (increment: boolean) => void): XapiResult

  • Parameters

    • callback: (increment: boolean) => void
        • (increment: boolean): void

        • Parameters

          • increment: boolean

          Returns void

    Returns XapiResult

onSpinnerReleased

  • onSpinnerReleased(callback: (increment: boolean) => void): XapiResult

  • Parameters

    • callback: (increment: boolean) => void
        • (increment: boolean): void

        • Parameters

          • increment: boolean

          Returns void

    Returns XapiResult

onTextInputCancel

  • onTextInputCancel(callback: () => void): XapiResult

onTextResponse

  • onTextResponse(callback: (text: string) => void): XapiResult

  • Parameters

    • callback: (text: string) => void
        • (text: string): void

        • Parameters

          • text: string

          Returns void

    Returns XapiResult

onToggleButtonChanged

  • onToggleButtonChanged(callback: (isOn: boolean) => void): XapiResult

  • Parameters

    • callback: (isOn: boolean) => void
        • (isOn: boolean): void

        • Parameters

          • isOn: boolean

          Returns void

    Returns XapiResult

setValue

spin

  • spin(props: {}, callback: () => void): void

  • Control the values of a spinner for you.

    It will automatically update the value for youl, limit range (if specified), and callback the currrent value.

    You can either provide min/max values, or a list of options. Using spin() will take ownership of the spinner's release event.

    Usage: ui('temperature').spin( { value: 5, min: 0, max: 10, increment: 0.5, digits: 2 }, console.log); );

    ui('car').spin( { options: ['BMW', 'Mercedes', 'Volvo'] }, console.log); );

    Parameters

    • props: {}
    • callback: () => void
        • (): void

        • Returns void

    Returns void

unsetValue

Generated using TypeDoc