CreateMultiPatch({handles}, integer[, string])

grandMA3 ユーザマニュアル » プラグイン » Lua 関数 - Object-Free API » CreateMultiPatch({handles}, integer[, string])

Version 2.1

説明

The CreateMultiPatch Lua function creates a series of multi patch fixtures to a table of fixtures.

引数

table:
The table must contain handles to the fixtures who should have the multi patch fixtures.
integer:
The number of multi patch fixtures to create.
string (オプション):
The string is an optional undo text. It needs to be in quotation marks.

戻り値

integer | nil:
The returned integer indicates the amount of multi patch fixtures created.

例

This example creates two multi patch fixtures to the first fixture (excluding the "Universal" fixture) in the patch.

Copy Code

Lua

return function()
    -- Enter Patch.
    Cmd("ChangeDestination Root");
    -- Enter the SetupPatch.
    Cmd("ChangeDestination 'ShowData'.'Patch'");

    -- Get the handle for the first fixture in the patch.
    local myFixture = Patch().Stages[1].Fixtures[2]
    -- Add the handle a list element in an table.
    local myFixtureTable = {myFixture}
    -- Add a variable with the amount of multipatch fixtures needed.
    local multiPatchAmount = 2

    -- Count the number of elements in the fixture table and store in a variable.
    local count = 0
    for _ in pairs(myFixtureTable) do
         count = count + 1
    end
    -- Create an unto text string.
    local undoText = string.format("Create %d multipatch fixtures for up to %d fixtures", multiPatchAmount, count)

    -- Create the multipatch fixtures to the each fixture handle in the table and store the returned value.
    local multiPatchAmount = CreateMultiPatch(myFixtureTable, multiPatchAmount, undoText)
    if multiPatchAmount ~= nil then
        Printf(multiPatchAmount .. " multi patch objects was created")
    else
        Printf("An error occured")
    end

    -- Return the command line destination to the root.
    Cmd("ChangeDestination Root")
end