Module .druidprogress

Basic progress bar component

Functions

progress:init(self, node, key, init_value) Component init function
progress:empty(self) Fill a progress bar and stop progress animation
progress:empty(self) Empty a progress bar
progress:set_to(self, to) Instant fill progress bar to value
progress:get(self) Return current progress bar value
progress:set_steps(self, steps, callback) Set points on progress bar to fire the callback
progress:to(self, to[, callback]) Start animation of a progress bar


Functions

progress:init(self, node, key, init_value)
Component init function

Parameters:

  • self table Component instance
  • node string or node Progress bar fill node or node name
  • key string Progress bar direction (x or y)
  • init_value number Initial value of progress bar
progress:empty(self)
Fill a progress bar and stop progress animation

Parameters:

  • self table Component instance
progress:empty(self)
Empty a progress bar

Parameters:

  • self table Component instance
progress:set_to(self, to)
Instant fill progress bar to value

Parameters:

  • self table Component instance
  • to number Progress bar value, from 0 to 1
progress:get(self)
Return current progress bar value

Parameters:

  • self table Component instance
progress:set_steps(self, steps, callback)
Set points on progress bar to fire the callback

Parameters:

  • self table Component instance
  • steps table Array of progress bar values
  • callback function Callback on intersect step value
progress:to(self, to[, callback])
Start animation of a progress bar

Parameters:

  • self table Component instance
  • to number value between 0..1
  • callback function Callback on animation ends (optional)
generated by LDoc 1.4.6 Last updated 2020-02-04 23:48:07