CreateUndo(string)

説明

Lua 関数の CreateUndo は、同じ Oops アクションにグループ化されたコマンドや機能呼び出しのリストへのハンドルを返します。

アンドゥ・ハンドルへの参照を付けて機能を実行すると、それがアンドゥ・リストに追加されます。

作成したアンドゥ・リストは、CloseUndo 関数によって閉じる必要があります。

引数

• string:
  アンドゥ・リストを識別するためのテキスト文字列。

戻り値

• handle:
  アンドゥ・リストへのハンドルを返します。

例

この例では、アンドゥ・リストを作成し、リストに追加される一連のコマンドを実行してからリストを閉じています。これによって、一連のコマンドを Oops コマンド1つで取り消せるようになります。

local function main()
    local MyNewUndo = CreateUndo("MySelection")   -- Creation of the undo group.
    Cmd("ClearAll", MyNewUndo)
    Cmd("Fixture 1", MyNewUndo)
    Cmd("Fixture 2", MyNewUndo)
    Cmd("Fixture 5", MyNewUndo)
    Cmd("Fixture 7", MyNewUndo)
    local closeSuccess = CloseUndo(MyNewUndo)     -- Closing the undo group and store it's return in a variable.
    
    Printf(closeSuccess)    -- Print the feedback from the closing action - 1 = Success / 0 = Failure.
end

return main