SetVar(handle, string, value)

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

説明

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

変数が存在する場合、値が上書きされます。存在しない場合は、指定した値で作成されます。

引数

  • handle:
    変数セットへのハンドルです。
  • string:
    変数の名前です。引用符で囲む必要があります。
  • value:
    値には、string, integer, または、double を指定できます。

戻り値

  • boolean:
    • true / 1: 変数が設定された。
    • false / 0: 変数が設定されなかった。

例

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

Copy Code
Lua
return function()
    -- Sets the value of user variable "myUserVar" to "Hello World" and store the returned boolean in a Lua variable
    local success = SetVar(UserVars(), "myUserVar", "Hello World")
    -- Prints the ressult
    if success then
        Printf("Variable is stored.")
    else
        Printf("Variable is NOT stored!")
    end
end