Effect object

Availability

Flash MX 2004.

Description

This is a single effect descriptor object. The fl.activeEffect and the fl.effects properties contain this type of object. The Effect object represents an instance of a timeline effect. See fl.activeEffect and fl.effects.

Property summary for the Effect object

In addition to the properties listed in the following table, Effect objects can also have user-defined parameters, which must be specified in the same XML file that specifies the effect.effectName and effect.sourceFile properties. These parameters specify which user interface elements should be created (such as edit fields, check boxes, and list boxes), which is controlled by the type of effect you are creating. You can specify labels that will appear with the control in addition to default values.

Property	Description
effect.effectName	Read-only; a string that appears in the Context menu for effects.
effect.groupName	Read-only; a string that represents the name of the effect group used for the hierarchical Context menu for effects.
effect.sourceFile	Read-only; a string that specifies the name of JSFL source file for the specified effect.
effect.symbolType	Read-only; a string that specifies the type of symbol to create during the initial application of the effect.
effect.useXMLToUI	A Boolean value that lets you override the default behavior of using XMLUI to construct a dialog box that consists of one or more controls.

Flash CS3

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/9.0/main/00004058.html