GetVar(handle, string)

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

説明

GetVar 関数は、変数セット内の特定の変数の値を返します。プラグインにおける変数の詳細については、変数関数 を参照してください。

引数

  • handle:
    変数セットへのハンドルです。
  • string:
    変数の名前です。引用符で囲む必要があります。

戻り値

  • Value:
    変数の値を返します。

変数が存在しない場合、nil が返されます。

例

ユーザ変数セットに "myUserVar" という変数が存在する場合、その値を取得します。

Copy Code
Lua
return function()
    -- Get the value from a user variable called "myUserVar" - assuming it already exists
    local varValue = GetVar(UserVars(), "myUserVar")
    -- Print en error feedback or the value of the variable
    if varValue == nil then
        Printf("Variable returns nothing!")
    else
        Printf("Variable value is: " .. varValue)
    end
end