SetProgressText(handle, string)

grandMA3 ユーザマニュアル » プラグイン » Lua 関数 - Object-Free API » SetProgressText(handle, string) Version 2.0

説明

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

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

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

引数

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

戻り値

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

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

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