Main Page | Packages | Class Tree | Index | Help

com.mosesSupposes.fusefx

class FXProperty

Object
  |
  +--com.mosesSupposes.fusefx.FXProperty


class FXProperty
extends Object

FuseFXProperty: Data object used in registering a new extension property.

Usage:
You'll use this class in authoring extensions. For more information see IFuseFX.



Field Summary

public
conflictLookup: Object
Provides FuseFX speedier access to each conflict string

public
conflicts: String
Stores the full conflict string passed in the constructor

public
fxclass: Function
Stores the IFuseFX extension class reference passed in the constructor

public
key: String
Stores the key passed in the constructor

Constructor

public
FXProperty ( FXClass: Function, key: String, conflicts: String)
Defines a single tweenable property string, associates it with an IFuseFX extension, and identifies conflicts with other tweenable properties.

Method Summary

public
removeConflicts ( target: Object ): Void
Strips conflicting properties defined in the constructor from a target using ZigoEngine.removeTween.



Field Documentation

conflictLookup

public var conflictLookup: Object
Provides FuseFX speedier access to each conflict string

conflicts

public var conflicts: String
Stores the full conflict string passed in the constructor

fxclass

public var fxclass: Function
Stores the IFuseFX extension class reference passed in the constructor

key

public var key: String
Stores the key passed in the constructor


Constructor Documentation

FXProperty

public function FXProperty(FXClass: Function,
 key: String,
 conflicts: String)
Defines a single tweenable property string, associates it with an IFuseFX extension, and identifies conflicts with other tweenable properties.

Parameters:
FXClass
A reference to the IFuseFX extension class (not an instance, the class itself)
key
The tweenable property string being defined
conflicts
Null or a comma-delimited string listing any other properties that conflict or overlap with the property being defined.

Method Documentation

removeConflicts

public function removeConflicts(target: Object): Void
Strips conflicting properties defined in the constructor from a target using ZigoEngine.removeTween.

Parameters:
target
The tween target to be affected

The documentation was generated from the following file: