SetProgress(handle, integer)

Description

The SetProgress Lua function defines a value on the range for a progress bar. A handle input argument defines the progress bar. The progress bar needs have been 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 desired value indicating the current status or position of the progress bar.

Return

This function does not return anything.

Example

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

return function()
    -- Sets the current value to 5 for a progress bar with the matching handle
    SetProgress(progressHandle, 5)
end