Addr(handle[, handle[, boolean]])

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

Version 2.0

説明

Addr 関数は、ハンドルをコマンドで使用できるアドレス文字列に変換します。

ハンドルの詳細や関連関数については、ハンドルを参照してください。

引数

handle:
アドレス文字列を取得したいオブジェクトに対する light_userdata 型のハンドルです。オブジェクトでコロン記法を用いる場合は省略できます(以下の例を参照)。
handle (オプション):
デフォルトでは、ルート位置からのアドレスが返されますが、このオプションのハンドルを用いると別のベース位置を指定できます。ルートからオブジェクトへのアドレスパスのベース位置である必要があります。
boolean (オプション):
これは、ToAddr() と Addr() で違いがある場合に役立ちます。これを true に設定すると、Addr() の代わりに ToAddr() によるインデックス番号が用いられます(後述の例を参照)。

戻り値

string:
ドットで区切られた親-子名形式のアドレス文字列を返します。

例

シーケンスのキューに対するアドレスを、さまざまな形で出力します。

Copy Code

Lua

return function()
    -- Creates a cue in sequence 1
    Cmd("Store Sequence 1 Cue 100 /Merge /NoConfirmation")
    --Store a handle to the created cue
    local cueObject = ObjectList("Sequence 1 Cue 100")[1]
    --Print different version of the handle address
    Printf("ToAddr:              " .. cueObject:ToAddr())
    Printf("Addr:                " .. cueObject:Addr())
    Printf("Addr(Parent, false): " .. cueObject:Addr(cueObject:Parent(), false))
    Printf("Addr(Parent, true):  " .. cueObject:Addr(cueObject:Parent(), true))
end