Skip to content

ProgressBar

Anthony Ma edited this page May 26, 2015 · 1 revision

A component that shows progress #Fields

  • x default: 1 - x value of the component
  • y default: 1 - y value of the component
  • h default: 1 - height of the component
  • w default: 16 - width of the component
  • z default: 0 - z value of the component
  • val default: 0 - percentage of progress (0-100)
  • parent - parent window object of the component
  • removed - whether the component has been queued for removal - should only be modified by the library itself
  • visible default: true - whether the component is visible
  • bgColor default: colors.white - the background color
  • textColor default: colors.black - the color of the text if in front of the background
  • barColor default: colors.lime - the color of the progress bar
  • textAlign default: "center" - alignment of the progress text
  • vertCenter default: true - whether to vertically center the text
  • barTextColor default: colors.white - color of text if in front of the progress bar
  • textMask default: "{val}%" - masks the text that will be displayed - "{val}" is replaced with self.val

#Functions

  • function draw(self) - draws the label - should only be called by the library itself
  • function update(self) - called every update cycle
  • function termX(self) - returns the x position on the terminal
  • function termY(self) - returns the y position on the terminal
  • function setPos(self, x, y) - sets the position of the component
  • function setSize(self, w, h) - sets the size of the component