Dump (handle)

grandMA3 ユーザマニュアル » プラグイン » Lua 関数 - Object API » Dump (handle)

Version 2.0

説明

Dump 関数は、オブジェクトに関する情報(名前、クラス、オブジェクトのパス、そのプロパティ、子など)を含む文字列を返します。

引数

Handle:
"light_userdata" 型のハンドル。

多くの場合、引数を指定せずに、オブジェクト指向のコロン記法で呼び出されます(後述の例を参照)。

戻り値

この関数は何も返しませんが、オブジェクトに関する情報を Command Line History ウィンドウに出力します。

例

以下の例はすべて、選択されているシーケンスについての情報を Command Line History に出力しています。

コロン記法による例です。

Copy Code

Lua

return function ()
    -- Dump() is called on a function
    Printf("=============== START OF DUMP ===============")
    SelectedSequence():Dump()
    Printf("================ END OF DUMP ================")
end

引数を指定しても同じ結果になります。

Copy Code

Lua

return function ()
    -- Dump() is called with function as an argument
    Printf("=============== START OF DUMP ===============")
    SelectedSequence().Dump(SelectedSequence())
    Printf("================ END OF DUMP ================")
end

同じことを、変数を介して行います。

Copy Code

Lua

return function ()
    --Stores the handle for the selected sequence in a local variable.
    local mySeqHandle = SelectedSequence()
    -- Dump() is called on the variable.
    Printf("=============== START OF DUMP ===============")
    mySeqHandle:Dump()
    Printf("================ END OF DUMP ================")
end