asdoc/mx/effects/IEffectInstance.js.json

{ "type": "interface",
  "qname": "mx.effects.IEffectInstance",
    "description": "The IEffectInstance interface represents an instance of an effect playing on a target. Each target has a separate effect instance associated with it. An effect instance's lifetime is transitory. An instance is created when the effect is played on a target and is destroyed when the effect has finished playing. If there are multiple effects playing on a target at the same time (for example, a Parallel effect), there is a separate effect instance for each effect.  <p>Effect developers must create an instance class for their custom effects.</p>",
  "tags": [
  {  "tagName": "see",
         "values": ["mx.effects.Effect"]},
      {  "tagName": "royalesuppresspublicvarwarning",
         "values": []},
      {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.9.3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "accessor",
    "access": "read-write",
    "return": "Number",
    "qname": "duration",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The duration of the effect, in milliseconds.",
    "tags": [
    {  "tagName": "default",
           "values": ["500"]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Object",
    "qname": "target",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The UIComponent object to which this effect is applied.",
    "tags": [
    {  "tagName": "see",
           "values": ["mx.effects.Effect#target"]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "method",
    "qname": "play",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Plays the effect instance on the target. Call the <code>startEffect()</code> method instead to make an effect start playing on an EffectInstance.  <p>In a subclass of EffectInstance, you must override this method. The override must call the <code>super.play()</code> method so that an <code>effectStart</code> event is dispatched from the target.</p>",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.9.3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ]
  }