StartProgress(string)

説明

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

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

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

引数

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

戻り値

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

例

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

return function ()
    -- Create and display a progress bar with a title
    progressHandle = StartProgress("ProgressBar Title")
end