StartProgress(string)

説明

StartProgress 関数は、すべての画面にプログレスバーを作成して表示します。入力引数の文字列は、プログレスバーのタイトルになります。この関数は、プログレスバーとやり取りするために必要なハンドルを返します。

関数を実行すると、画面上にプログレスバーが表示されます。プログレスバーは、ハンドルを必要とする StopProgress 関数によってのみ削除できます。そのため、StartProgress 関数から返されたハンドルを保存しておいてください。

プログレスバーの詳細や、関連する他の関数へのリンクについては、プログレスバー を参照してください。

引数

• string:
  プログレスバーのタイトルとして用いられる文字列です。

戻り値

• handle:
  プログレスバーの識別子となるハンドルを返します。

例

すべての画面にプログレスバーを作成・表示します。この例ではプログレスバーは消えません。削除するには、StopProgress 関数を用いてください。

return function()
    -- Create and display a progress bar with a title
    -- IMPORTANT: The Lua variable 'progressHandle' is needed to remove the progressbar again - StopProgress()
    progressHandle = StartProgress("ProgressBar Title")
end