GetPath(string[, boolean] | integer)

grandMA3 ユーザマニュアル » プラグイン » Lua 関数 - Object-Free API » GetPath(string[, boolean] | integer)

Version 2.0

説明

GetPath 関数は、grandMA3 フォルダのパスを含む文字列を提供します。

この関数は、以下の2種類の型の引数で呼び出せます。

引数

string:
フォルダ名を表す文字列です。
boolean (string に対するオプション):
true の場合、パスにフォルダが存在しなかったら、それが作成されます。

― または ―
integer:
"Enum.PathType" テーブルのインデックスを表す整数。

	制限
	フォルダの作成は、引数が string の場合にのみ機能します。

戻り値

string:
指定した引数に関連する最初に見つかったフルパス文字列を返します。

例

この例では、shows フォルダのパスを、2つの異なる引数指定で System Monitor に表示しています。

Copy Code

Lua

return function()
    -- This prints a path based on a string input and it creates the folder if it does not exists.
    Printf("Path of show files (string) is: " .. GetPath("shows", true))
    -- This prints the path based on an integer. The integer is looked-up using the 'PathType' enum.
    Printf("Path of show files (integer) is: " .. GetPath(Enums.PathType.Showfiles))
end