Name
UndoFX -- undo a graphics operation with transition fx
Synopsis
[handle] = UndoFX(type, id[, table])
Function
This function is like the Undo() command but it uses a transition effect to undo the operation. See Undo for details.

Remember to have layers turned on when using this command!

Starting with Hollywood 4.0 this function uses a new syntax with just a single table as an optional argument. The old syntax is still supported for compatibility reasons. The optional table argument can be used to configure the transition effect. The following options are possible:

Type
Specifies the desired effect for the transition. See DisplayTransitionFX for a list of all supported transition effects. (defaults to #RANDOMEFFECT)

Speed
Specifies the desired speed for the transition. The higher the value you specify here, the faster the effect will be displayed. (defaults to #NORMALSPEED)

Parameter
Some transition effects accept an additional parameter. This can be specified here. (defaults to #RANDOMPARAMETER)

Async
You can use this field to create an asynchronous draw object for this transition. If you pass True here UndoFX() will exit immediately, returning a handle to an asynchronous draw object which you can then draw using AsyncDrawFrame(). See AsyncDrawFrame for more information on asynchronous draw objects.

UndoLevel
Specifies the undo level for this operation. See Undo for information on the undo level.

NoBorderFade
If the layer to be removed has a border, do not gradually fade out the border but remove it in one go at the end of the transition effect. (V5.0)

Inputs
type
one of the type constants (See Undo for details.)
id
identifier of the object
table
optional: transition effect configuration
Results
handle
optional: handle to an asynchronous draw object; will only be returned if Async has been set to True (see above)

Show TOC