GetTopOverlay()

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

Version 2.2

説明

GetTopOverlay 関数は、指定されたインデックス番号を持つディスプレイの最上部にあるオーバーレイのハンドルを返します。
オーバーレイは、ポップアップやメニューと呼ばれるものの内部的な名称です。

引数

この関数は、引数を受け取りません。

戻り値

handle または nil:
最上位にあるオーバーレイUIオブジェクトへのハンドルを返します(存在する場合)。

例

この例では、Menu キーを押したときに開く MenuSelector ポップアップに関する情報を、Dump() 関数で出力します。

Copy Code

Lua

return function()
    -- Open the MenuSelector overlay.
    Cmd('Menu "MenuSelector')
    -- Add a small delay.
    coroutine.yield(0.5)
    -- Get the handle for the overlay on the display with index 1.
    local overlayHandle = GetTopOverlay(1)
    -- Add a small delay.
    coroutine.yield(0.5)
    -- Close the MenuSelector overlay.
    Cmd('Menu "MenuSelector')
    -- Check if there is a handle and print appropriate feedback.
    if overlayHandle ~= nil then
        Printf("=============== START OF DUMP ===============")
        overlayHandle:Dump()
        Printf("================ END OF DUMP ================")
    else
        ErrPrintf("The Overlay UI object could not be found.")
    end
end