Name
FinishAsyncDraw -- finish asynchronous drawing object (V4.5)
Synopsis
FinishAsyncDraw(id)
Library
async

Function
This function can be used to finish an asynchronous drawing object. When calling this function, Hollywood will skip to the last frame of the asynchronous drawing object and finish it. "Finishing" an asynchronous drawing object means drawing its last frame, running the finishing code (for example, removing the layer if the asynchronous drawing object belongs to a RemoveLayerFX() call), and then freeing the asynchronous drawing object.

There is a difference between FinishAsyncDraw() and CancelAsyncDraw(). See CancelAsyncDraw for details.. An exception is when layers are enabled. In that case there is no difference between CancelAsyncDraw() and FinishAsyncDraw(). In case layers are off, you should always use CancelAsyncDraw().

Note that typically you only have to call FinishAsyncDraw() when passing specific frame numbers to AsyncDrawFrame(). If you keep calling AsyncDrawFrame() until it returns True, it will automatically finish and free the asynchronous draw object and you don't have to call FinishAsyncDraw() at all. See AsyncDrawFrame for details.

Inputs
id
identifier of the object to finish

Show TOC