Editor API Reference - v1.1.4
    Preparing search index...

    Type Alias ButtonComponent

    Button Component Properties.

    type ButtonComponent = {
        active: boolean;
        enabled: boolean;
        fadeDuration: number;
        hitPadding: number[];
        hoverSpriteAsset: number;
        hoverSpriteFrame: number;
        hoverTint: number[];
        imageEntity: string;
        inactiveSpriteAsset: number;
        inactiveSpriteFrame: number;
        inactiveTint: number[];
        pressedSpriteAsset: number;
        pressedSpriteFrame: number;
        pressedTint: number[];
        transitionMode: number;
    }
    Index

    Properties

    active enabled fadeDuration hitPadding hoverSpriteAsset hoverSpriteFrame hoverTint imageEntity inactiveSpriteAsset inactiveSpriteFrame inactiveTint pressedSpriteAsset pressedSpriteFrame pressedTint transitionMode

    Properties

    active: boolean

    If false, the button will be visible but will not respond to hover or touch interactions.

    true
    enabled: boolean

    Whether the component is enabled.

    true
    fadeDuration: number

    Duration to be used when fading between tints, in milliseconds.

    0
    hitPadding: number[]

    An array of 4 numbers controlling the padding to be used in hit-test calculations.

    [0,0,0,0]
    hoverSpriteAsset: number

    The id of the sprite asset to be used as the button image when the user hovers over it.

    null
    hoverSpriteFrame: number

    Frame to be used from the hover sprite.

    0
    hoverTint: number[]

    Array of 4 numbers controlling the color to be used on the button image when the user hovers over it.

    [1,1,1,1]
    imageEntity: string

    The resource_id of the entity to be used as the button background. Must have an element component of type image.

    null
    inactiveSpriteAsset: number

    The id of the sprite asset to be used as the button image when the button is not interactive.

    null
    inactiveSpriteFrame: number

    Frame to be used from the inactive sprite.

    0
    inactiveTint: number[]

    Array of 4 numbers controlling the color to be used on the button image when the button is not interactive.

    [1,1,1,1]
    pressedSpriteAsset: number

    The id of the sprite asset to be used as the button image when the user presses it.

    null
    pressedSpriteFrame: number

    Frame to be used from the pressed sprite.

    0
    pressedTint: number[]

    Array of 4 numbers controlling the color to be used on the button image when the user presses it.

    [1,1,1,1]
    transitionMode: number

    Controls how the button responds when the user hovers over it/presses it.

    0

    Settings

    Member Visibility

    On This Page

    Properties