dot big bang

Developer API
Menu

Class UIElement

All
  • Public
  • Public/Protected
  • All

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

getPosition

  • Returns the position in UI-position units of the element.

    Parameters

    • Optional optionalTarget: Vector2

      If provided, return the position in this object rather than allocating a new one.

    Returns Vector2

getSize

  • getSize(): number

  • Gets the size of the element in UI-size units. Note that it is not recommended to use this in combination with setSize2D.

    Returns number

isVisible

  • isVisible(): boolean

  • Indicates whether this element is visible or not.

    Returns boolean

setPosition

  • setPosition(position: Vector2): void

  • Sets the position of this element, in UI-position units.

    Parameters

    • position: Vector2

      The position, in UI-position units.

    Returns void

setSize

  • setSize(size: number): void

  • Sets the size of the element in UI-size units. This will make the element uniformly scaled on both the X and Y axis.

    Parameters

    • size: number

    Returns void

setVisible

  • setVisible(visible: boolean): void

  • Sets the visibility of the element (i.e. hide or show) in the UI.

    Parameters

    • visible: boolean

      Use true to show the element or false to hide it.

    Returns void