Name
DisplayTextObjectFX -- display a text object with transition effects
Synopsis
[handle] = DisplayTextObjectFX(id, x, y[, table])
Function
This function is an extended version of the DisplayTextObject() command. It displays the text object specified by id at the position specified by x and y and it uses one of the many Hollywood transition effects to display it. You need also specify the speed for the transition.

If layers are enabled this command will add a new layer of the type #TEXTOBJECT to the layer stack.

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 DisplayTextObjectFX() 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.

Inputs
id
identifier of the text object to display
x
desired x position for the text object
y
desired y position for the text 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)
Example
DisplayTextObjectFX(1, 0, 0, #VLINES, 10)   ; old syntax

OR

DisplayTextObjectFX(1, 0, 0, {Type = #VLINES, Speed = 10})  ; new syntax
The above code displays text object 1 at 0:0 with a #VLINES transition at speed 10.

Show TOC