Type Alias ButtonComponent

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;
}

Button Component Properties.

Type declaration

  • active: boolean

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

    Default

    true
  • enabled: boolean

    Whether the component is enabled.

    Default

    true
  • fadeDuration: number

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

    Default

    0
  • hitPadding: number[]

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

    Default

    [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.

    Default

    null
  • hoverSpriteFrame: number

    Frame to be used from the hover sprite.

    Default

    0
  • hoverTint: number[]

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

    Default

    [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.

    Default

    null
  • inactiveSpriteAsset: number

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

    Default

    null
  • inactiveSpriteFrame: number

    Frame to be used from the inactive sprite.

    Default

    0
  • inactiveTint: number[]

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

    Default

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

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

    Default

    null
  • pressedSpriteFrame: number

    Frame to be used from the pressed sprite.

    Default

    0
  • pressedTint: number[]

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

    Default

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

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

    Default

    0

Settings

Member Visibility