Description

The IncProgress Lua function changes the value on the range for a progress bar using an integer input. A handle input argument defines the progress bar. The progress br needs to be created using the StartProgress() function.

StartProgress()

The StartProgress Lua function creates and displays a progress bar on all screens.

Learn more in the StartProgress() topic.

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 for the range. This can be a negative value to decrease the value.

Return

This function does not return anything.

Examples

These two examples increase and decrease the range value for the progress bar created using the example in the StartProgress topic (link above):

Copy Code

Lua

return function()
    -- Increase the current value for a progress bar with the matching handle.
    IncProgress(progressHandle, 1)
end

Copy Code

Lua

return function()
    -- Decrease the current value for a progress bar with the matching handle.
    IncProgress(progressHandle, -1)
end