Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProgressBar

Progress bar UI element

Hierarchy

Index

Methods

getOwningObject

getParent

  • getParent(): Widget | undefined
  • Return the widget that contains this widget, for example a border that wraps a check box. Returns undefined if this object has no parent.

    Returns Widget | undefined

getProgress

  • getProgress(): number
  • Return the currently displayed progress (0 to 1)

    Returns number

getText

  • getText(): string
  • Return the currently displayed text

    Returns string

isEnabled

  • isEnabled(): boolean

setEnabled

  • setEnabled(enabled: boolean): Widget
  • Set whether the widget is enabled. When a widget is disabled, users can't interact with it and it is greyed out. When a widget that contains other widgets (like VerticalBox) is disabled, all its children behave as if disabled, too. By default, widgets are enabled.

    Parameters

    • enabled: boolean

      Whether to enable the widget.

    Returns Widget

setFontSize

setProgress

  • Set the displayed progressed.

    Parameters

    • progress: number

      Progress to show. 0 is not progress, 1 shows the full bar.

    Returns ProgressBar

setText

  • Set the displayed text. Can include "\n" to indicate new lines.

    Parameters

    • text: string

      The new text

    Returns ProgressBar