SetProgressText(handle, string)

説明

Lua 関数の SetProgressText は、プログレスバーのタイトルの隣に表示されるテキストを指定します。プログレスバー作成後にタイトルは変更できませんが、このテキストは変更可能です。これは、現在の進捗状況を示すために利用できます。

対象となるプログレスバーは、入力引数のハンドルで指定します。プログレスバーは、StartProgress 関数によって作成しておく必要があります。

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

引数

• handle:
  プログレスバーのハンドルです。
• string:
  表示するテキストです。

戻り値

この関数は何も返しません。

例

この例では、StartProgress 関数で作成されたプログレスバーに対してテキストを設定しています。

return function()
    -- Sets the text next to progress title text
    SetProgressText(progressHandle, "- This is text next to the progress title")
end