CheckFIDCollision(integer[, integer[, integer]])

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

Version 2.0

説明

CheckFIDCollision 関数は、特定(範囲)のIDが利用可能か、またはすでに利用されているかどうかを確認します。オプションの integer 型引数を追加することで、FID および任意のタイプの CID を確認できます。

引数

integer:
最初の整数値は、チェックすべき ID です。
integer (オプション):
このオプションの整数値は、チェックすべき後続のIDの数です。デフォルト値は 1 です。例えば、FID 21～25 をチェックしたい場合、カウントを 5 にしてください。
integer (オプション):
このオプションの整数値は、IDType を示します。デフォルト値は 0 で、"Fixture" になります。他の有効な値については、以下の例を参照してください。

戻り値

boolean:
以下の boolean 値を返します。
- true:
  ID は利用可能です。
- false:
  ID はすでに利用されています。

例

この例では、FID のチェック結果を出力しています。

Copy Code

Lua

return function()
    -- Create a variable with the FID you want to check.
    local myFID = 2001
    -- Create a variable with the number of subsequent ID's to also check.
    local myCount = 10
    -- Create a variable with the IDType you want to check.
    -- Default value is 0. This is the "Fixture" type.
    -- Valid integers are:
    --- 0 = Fixture
    --- 1 = Channel
    --- 2 = Universal
    --- 3 = Houseligths (default name)
    --- 4 = NonDim (default name)
    --- 5 = Media (default name)
    --- 6 = Fog (default name)
    --- 7 = Effect (default name)
    --- 8 = Pyro (default name)
    --- 9 = MArker
    --- 10 = Multipatch
    local myType = 0

    -- Check if the count is more than one.
    if myCount > 1 then
        -- Check if there is a collision and print valid feedback.
        if CheckFIDCollision(myFID, myCount, myType) then
            Printf("The FID " .. myFID .. " to " .. (myFID + myCount) .. " is available.")
            return
        else
            Printf("The FID " .. myFID .. " to " .. (myFID + myCount) .. " gives an FID collision.")
            return
        end
    else
        if CheckFIDCollision(myFID, nil, myType) then
            Printf("The FID " .. myFID .. " is available.")
            return
        else
            Printf("The FID " .. myFID .. " gives an FID collision.")
            return
        end
    end
end