Dump (handle)

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

説明

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

引数

  • handle:
    light_userdata 型のハンドルです。
    オブジェクト指向の呼び出しにコロン表記を用いる場合は省略できます。詳細については、Lua 関数 - Object API を参照してください。

戻り値

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

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

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

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

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

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