grandMA3 User Manual Publication

SetProgressRange(handle, integer, integer)

grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » SetProgressRange(handle, integer, integer)
Version 2.1

Description

The SetProgressRange Lua function defines a range for a progress bar.

A handle input argument defines which progress bar it defines a range for. The progress bar must exist to have a handle. Progress bars can be created using the StartProgress function.

See the ProgressBar topic for more info regarding progress bars and links to other related functions.

Arguments

  • Handle:
    The handle for the progress bar.
  • Integer:
    The start value for the range.
  • Integer:
    The end value for the range.

Return

This function does not return anything.

Example

This example sets a range for the progress bar created using the example in the StartProgress topic (link above):

Lua
return function()
-- Sets the range of a progress bar with the matching handle
SetProgressRange(progressHandle, 1, 10)
end