com.mosesSupposes.fuse.ZigoEngine

com.mosesSupposes.fuse.ZigoEngine Class Reference

Collaboration diagram for com.mosesSupposes.fuse.ZigoEngine:

Collaboration graph
[legend]
List of all members.

Detailed Description

The Fuse Kit [build1.1z3] Copyright (c) 2006 Moses Gunesch, MosesSupposes.com

Distributed under MIT Open Source License, see Fuse-Kit-License.html (in fuse package directory) Easing Equations (c) 2003 Robert Penner used by permission, see PennerEasing Visit http://www.mosessupposes.com/Fuse

A robust central processing engine for all scripted tweens in a swf published to AS2.

Your project can be prepared to use ZigoEngine in these ways:


Extending prototypes is entirely optional in this version - all Shortcut functionality is excluded from the core engine class.

Events dispatched by ZigoEngine (see addListener for more info): Events dispatched by individual target objects (see com.mosesSupposes.fuse.ZManager for more info):

Author:
Moses Gunesch / MosesSupposes.com / ZigoEngine based on concepts by Ladislav Zigo, Zeh Fernando
Version:
2.0

Definition at line 33 of file ZigoEngine.as.

Static Public Member Functions

static function addListener (handler:Object)
static function removeListener (handler:Object)
static function isPlaying ()
static function simpleSetup (shortcutsClass:Function)
static function register (classReference:Function)
static function initialize (target:Object)
static function deinitialize (target:Object)
static function getUpdateInterval ()
static function setUpdateInterval (time:Number)
static function getControllerDepth ()
static function setControllerDepth (depth:Number)
static function doShortcut (targets:Object, methodName:String)
static function doTween (targets:Object, props:Object, endvals:Object, seconds:Number, ease:Object, delay:Number, callback:Object)
static function removeTween (targs:Object, props:Object)
static function isTweening (targ:Object, prop:String)
static function getTweens (targ:Object)
static function lockTween (targ:Object, setLocked:Boolean)
static function isTweenLocked (targ:Object)
static function ffTween (targs:Object, props:Object)
static function rewTween (targs:Object, props:Object, pauseFlag:Boolean, suppressStartEvents:Boolean)
static function isTweenPaused (targ:Object, prop:String)
static function pauseTween (targs:Object, props:Object)
static function unpauseTween (targs:Object, props:Object)
static function resumeTween (targs:Object, props:Object)
static function setColorByKey (targetObj:Object, type:String, amt:Number, rgb:Object)
static function getColorTransObj (type:String, amt:Number, rgb:Object)
static function getColorKeysObj (targOrTransObj:Object)
static function initializeTargets ()
static function deinitializeTargets ()
static function __mgrRelay (inst:ZManager, method:String, args:Array)

Static Public Attributes

static var VERSION:String = FuseKitCommon.VERSION+'
static var ZigoEngine based
on concepts by Ladislav 		Zigo
static var ZigoEngine based
on concepts by Ladislav laco.wz.cz 		tween
static var EASING:Object = 'easeOutQuint'
static var DURATION:Number = 1
static var ROUND_RESULTS:Boolean = false
static var OUTPUT_LEVEL:Number = 1
static var AUTOSTOP:Boolean = false
static var SKIP_LEVEL:Number = 0

Private Member Functions

function ZigoEngine ()

Static Private Member Functions

static function setup (deinitFlag:Boolean)
static function parseCallback (callback:Object, targets:Array)

Static Private Attributes

static var tweenHolder:MovieClip
static var instance:ZManager
static var updateIntId:Number
static var updateTime:Number
static var _playing:Boolean = false
static var zigoIDs:Number = 0
static var extensions:Object
static var cbTicker:Number = 0

Constructor & Destructor Documentation

function com.mosesSupposes.fuse.ZigoEngine.ZigoEngine (  )  [private]

Do not use constructor. All methods of engine are static.

Definition at line 147 of file ZigoEngine.as.

Member Function Documentation

static function com.mosesSupposes.fuse.ZigoEngine.addListener ( handler:Object   )  [static]

Written by AsBroadcaster (Advanced) Use this method to add a listener for "onTweenInterrupt" event, which is broadcast directly by the engine. The "onTweenInterrupt" event is fired in the following situations:

This event is special in that it is dispatched directly by the ZigoEngine class, unlike target-events such as onTweenEnd (see: com.mosesSupposes.fuse.ZManager for more info). This ensures the event is fired even when targets go missing and are thus unable to dispatch the event. To aid in tracking targets in that situation, the internal __zigoID__ property for each target is also passed in the event object. Any initialized/tweening target contains this read-only property, making it possible to advance-query then later identify targets after they're removed. 
var myListener:Object = {
 	onTweenInterrupt:function(o:Object):Void {
 		trace("Interruption detected:");
 		trace(" -target (may not exist if removed):"+o.target);
 		trace(" -target id:"+o.__zigoID__);
 		trace(" -properties interrupted:"+(o.props).toString());
 	}
 };
 ZigoEngine.addListener(myListener);
 ZigoEngine.doTween(my_mc,"_alpha",0,2);
 // click the mouse during the tween to receive the event.
 function onMouseDown():Void {
 	my_mc.removeMovieClip();
 }
Parameters:
the function or object that should be called

Definition at line 175 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.removeListener ( handler:Object   )  [static]

Written by AsBroadcaster Remove a listener for onTweenInterrupt event

Parameters:
the function or object that should be called

Definition at line 187 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.isPlaying (  )  [static]

Returns true if the engine contains tweens and is running updates on a pulse

Definition at line 192 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.simpleSetup ( shortcutsClass:Function   )  [static]

An alternative setup command that extends prototypes with shortcuts like alphaTo. This setup command should only be called once at the beginning of your program. Use either this or register, not both. The difference is that simpleSetup alters base prototypes so that you may call tween methods directly on targets, such as my_mc.alphaTo(0);.

Example: 

import com.mosesSupposes.fuse.*;
 ZigoEngine.simpleSetup(Shortcuts,PennerEasing);
Note that to keep filesize to a minimum you should only register the features you intend to use. Use publish settings to "omit trace actions" to further reduce filesize.
Parameters:
shortcutsClass It is madadory to pass the Shortcuts class during this call! You may additionally pass any of the following classes (all are optional), as in the way PennerEasing is added above. PennerEasing Enables shortcut strings like "easeOutQuad" to be used with the engine. See com.mosesSupposes.fuse.PennerEasing Fuse Enables Fuse for animation sequencing. Note that if animation won't be sequenced you do may simply import and use Fuse without ZigoEngine. See com.mosesSupposes.fuse.Fuse FuseFMP Enables shortcut strings like DropShadow_distance to be tweened in the engine. See com.mosesSupposes.fuse.FuseFMP FuseItem Enables Fuse-style Object Syntax to be used with the ZigoEngine.doTween. Note that Fuse does not need to be registered to use this feature. See com.mosesSupposes.fuse.FuseItem

Definition at line 212 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.register ( classReference:Function   )  [static]

An optional setup command that registers additional classes for use with the ZigoEngine. This setup command should only be called once at the beginning of your program. Use either this or simpleSetup, not both. The difference is that register links additional classes to the engine without altering base prototypes. 

import com.mosesSupposes.fuse.*;
 ZigoEngine.register(PennerEasing, Fuse, FuseFMP);
Note that to keep filesize to a minimum you should only register the features you intend to use. Use publish settings to "omit trace actions" to further reduce filesize.
Parameters:
classReference Pass any of the following classes (all are optional):

Definition at line 239 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.initialize ( target:Object   )  [static]

(Advanced) Prepares targets for use with engine. This method is never needed when extending prototypes with simpleSetup. It can be used to initialize specific targets to accept listeners prior to tweening - see com.mosesSupposes.fuse.ZManager for an example. If the Shortcuts class was passed to register, this method also copies all tweening shortcuts to targets.

Parameters:
One or more targets to initialize.

Definition at line 260 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.deinitialize ( target:Object   )  [static]

(Advanced) Clears targets from being used with the engine. Removes AsBroadcaster functionality (and tweening shortcuts if the Shortcuts class was registered) from any object previously initialized using initialize.

Parameters:
One or more targets to initialize, or nothing/null to deinitialize base prototypes (for example to undo simpleSetup)
See also:
initialize

Definition at line 277 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.getUpdateInterval (  )  [static]

Returns:
Number set using setUpdateInterval, or undefined if unset.
See also:
setUpdateInterval

Definition at line 292 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.setUpdateInterval ( time:Number   )  [static]

When set, the engine will run on a setInterval pulse instead of a frame pulse.

Parameters:
time Pulse duration in milliseconds, or null/undefined to return to an frame-based pulse. In most cases it is best to leave the engine in its default state since a frame-based pulse usually renders more smoothly. The engine always uses seconds for tween duration so using a longer interval will only reduce animation quality, not slow tweens down. This may be desirable in some cases, for instance to reduce CPU usage in banners.

Definition at line 303 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.getControllerDepth (  )  [static]

Depth of the ZigoEnginePulse clip.

Returns:
numeric depth in _root

Definition at line 317 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.setControllerDepth ( depth:Number   )  [static]

Creates a clip in the _root timeline called "ZigoEnginePulse" or sets its depth

Parameters:
If null or nothing passed the beacon clip is placed at depth 6789, but a depth of 0 will be more convenient if you'll be using depth management in _root.

Definition at line 325 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.doShortcut ( targets:Object  ,
methodName:String   
) [static]

An alternative to doTween that accepts Shortcut syntax. Requires registration of the Shortcuts class. This idea thanks to Yotam Laufer. Example: 

ZigoEngine.doShortcut(my_mc, 'scaleTo', 200, 1, 'easeOutQuad');
See com.mosesSupposes.fuse.ZigoEngine introduction for instructions on registering Shortcuts to enable this feature.
Parameters:
targets Tween target object or array of target objects
methodName The shorcut as a string, such as "alphaTo", followed by parameters that follow that shortcut's format.
Returns:
A comma-delimited string of props successfully added. When multipe targets were passed, a pipe-delimited series is returned to enable verification of individual properties per target.

Definition at line 346 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.doTween ( targets:Object  ,
props:Object  ,
endvals:Object  ,
seconds:Number  ,
ease:Object  ,
delay:Number  ,
callback:Object   
) [static]

Generates and immediately begins one or more property-tweens running on one or more targets. 

ZigoEngine.doTween(my_mc, '_x,_y', [100,150], 1, Strong.easeInOut);
com.mosesSupposes.fuse.Fuse-style Object Syntax may also be used if the com.mosesSupposes.fuse.FuseItem class is registered: 
ZigoEngine.doTween({ target:my_mc, start_alpha:0, y:150, ease:Strong.easeInOut });
Parameters:
targets Tween target object or array of target objects
props String like "_x", comma-delimited list of properties like "_x,_y", or Array of properties like ["_x","_y"].
The engine accepts any existing property in the target including custom variables, and the following special properties:
  • _scale Sets _xscale and _yscale to the same value.
  • _size Sets _width and _height to the same value.
  • _frame Tweens a MovieClip's timeline to a frame using easing specified.
  • _tint Accepts 0x000000 and "#000000" formats, null (full reset), or object {tint:Number/null/hexString, percent:Number/String}.
  • _tintPercent Value range 0-100
  • _brightness Value range 0-100
  • _brightOffset Burn effect. -100=black, 0=normal, 100=white
  • _invertColor Value range 0-100
  • _colorReset Value range is current tint - 100. Acts like the opposite of tintPercent where 100 is a full reset.
  • _contrast 0=gray, 100=normal, 200=high-contrast, higher=posterized
  • _colorTransform Generic object in Flash7 transform format {ra:,rb:,etc.}
  • _bezier_ Generic object with some or all of the properties {x:,y:,controlX:,controlY:}. Relative (string) values are okay. Note that only one control param is necessary to generate a curved motion path, simply omit other values.
    Example - swoop up then down while sliding right:
    ZigoEngine.doTween(clip1, "_bezier_", {x:"100",controlY:"-25"});
When com.mosesSupposes.fuse.FuseFMP is registered, a large number of BitmapFilter properties are tweenable:
  • Blur_blurX, etc. Format follows the convention short-filtername+"_"+filter property.
endvals tween end-value or Array of corresponding end-values
Relative values: Passing a string instead of a number like "-10" vs. <code.-10 will treat the endvalue as relative to the start position of the tween.
seconds tween duration. If nothing is passed, defaults to ZigoEngine.DURATION.
ease function, shortcut-string, or custom-easing-panel object. If nothing is passed, defaults to ZigoEngine.EASING.
delay seconds to wait before performing the tween. Start callback and onTweenStart event are fired at end of delay.
callback function, string, or object
1. Function
  • myfunc
  • function(){ ... }
  • Delegate.create(....) - adds scope
ZigoEngine.doTween(clip1,"_x","100",1,"easeOutQuad",0, myCallback);

2. String (also known as easyfunc in Fuse) - Note that you need to register Shortcuts to use this feature.
  • "myscope.callback();"
  • "myscope.myscope.myfunc(someexpression,'somestring',{someparam:someval});" - Scope can be complex, plus various param formats including object and array are parsed.
ZigoEngine.doTween(clip1,"_x","100",1,"easeOutQuad",0, "myCallback();");

3. Callback Object - a generic object with the parseable params:
  • func Function or string name of function
  • scope The this Object where the callback should execute
  • args One argument or an array of arguments to pass to the callback
  • startfunc
  • startscope
  • startargs
  • updfunc
  • updscope
  • updargs
ZigoEngine.doTween(clip1,"_x","100",1,"easeOutQuad",0, {scope:this, func:"myCallback"});

Additional engine parameters - Include any of these in a callback object:
  • cycles Tweens back and forth between start and end.
    0 or "LOOP" = infinite cycles, default = 1, 2 or more to specify cycles.
  • skipLevel 0,1, or 2. See SKIP_LEVEL for details.
    Including this paramter in a callback object overrides the engine default on a per-tween basis.
  • extra1 Elastic easing amplitude or Back easing overshoot
  • extra2 Elastic easing period
  • easyfunc String like "myClip.doSomething(true);" as in option 1 above.
Returns:
A formatted string:
The engine reports which properties have been added to its active tween list by returning a comma-delimited string of just the properties that were successfully added, such as "_x" or "_x,_y". These may occasionally differ from what was tweened, such as "_width,_height" when "_size" was tweened.

If multiple targets are passed to the engine, a pipe-delimited series of properties is returned in target order, which enables granular review of whether specific properties for each target.
var results:String = ZigoEngine.doTween([clip1,clip2,clip3],"_scale",100,null,0,{skipLevel:1});
 // results: "_xscale,_yscale||_xscale,_yscale"
 // because clip2's scale was already set to 100 and the skipLevel is set to skip no-change tweens.

Definition at line 432 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.removeTween ( targs:Object  ,
props:Object   
) [static]

Remove specific or all tweening properties from specific or all tweening targets in engine.

Parameters:
targs a single target object, array of targets, or for every active target
props a property string, array of property strings, null or nothing for all props, com.mosesSupposes.fuse.FuseKitCommon#ALLCOLOR for any active color transform

Definition at line 516 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.isTweening ( targ:Object  ,
prop:String   
) [static]

Test if a target and optionally a specific property is being handled by the engine.

Parameters:
targ a single target object to test
props a property string, null or nothing for any property, com.mosesSupposes.fuse.FuseKitCommon#ALLCOLOR for any active color transform
Returns:
true if a matching active tween is found, which may be paused or playing

Definition at line 526 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.getTweens ( targ:Object   )  [static]

Returns the number of tweens active in a target object.

Parameters:
targ target tween passed to determine if active, or com.mosesSupposes.fuse.FuseKitCommon#ALL for every active target
Returns:
number of active tweens, which may be paused or playing

Definition at line 535 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.lockTween ( targ:Object  ,
setLocked:Boolean   
) [static]

Locks a target to prevent tweens from running until target is unlocked.

Parameters:
targ Object to lock
setLocked locked value

Definition at line 544 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.isTweenLocked ( targ:Object   )  [static]

Locks tweens and prevents from running until tween is unlocked.

Parameters:
targ Object to lock
Returns:
locked value

Definition at line 553 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.ffTween ( targs:Object  ,
props:Object   
) [static]

Fast-forwarding a tween ends it and removes it from the engine, and triggers the onTweenEnd broadcast and end callbacks.

Parameters:
targs a single target object, array of targets, or com.mosesSupposes.fuse.FuseKitCommon#ALL for every active target
props a property string, array of property strings, null or nothing for all props, com.mosesSupposes.fuse.FuseKitCommon#ALLCOLOR for any active color transform

Definition at line 562 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.rewTween ( targs:Object  ,
props:Object  ,
pauseFlag:Boolean  ,
suppressStartEvents:Boolean   
) [static]

Rewinds and either pauses or restarts one or more tweens

Parameters:
targs a single target object, array of targets, or com.mosesSupposes.fuse.FuseKitCommon#ALL for every active target
props a property string, array of property strings, null or nothing for all props, com.mosesSupposes.fuse.FuseKitCommon#ALLCOLOR for any active color transform
pauseFlag true to rewind-and-pause
suppressStartEvents if true is not passed, engine will refire 'onTweenStart' event and any start callbacks associated with the tween

Definition at line 573 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.isTweenPaused ( targ:Object  ,
prop:String   
) [static]

Test whether any or a specific property is paused in a target object

Parameters:
targ a single target object to test
props a property string, null or nothing for any property, com.mosesSupposes.fuse.FuseKitCommon#ALLCOLOR for any active color transform
Returns:
paused value

Definition at line 583 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.pauseTween ( targs:Object  ,
props:Object   
) [static]

Pause one or more tweens

Parameters:
targs a single target object, array of targets, or com.mosesSupposes.fuse.FuseKitCommon#ALL for every active target
props a property string, array of property strings, null or nothing for all props, com.mosesSupposes.fuse.FuseKitCommon#ALLCOLOR for any active color transform

Definition at line 592 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.unpauseTween ( targs:Object  ,
props:Object   
) [static]

Legacy - see resumeTween

Definition at line 599 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.resumeTween ( targs:Object  ,
props:Object   
) [static]

Unpause one or more tweens.

Definition at line 606 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.setColorByKey ( targetObj:Object  ,
type:String  ,
amt:Number  ,
rgb:Object   
) [static]

(General) Color-transforms a target by keyword. Example: ZigoEngine.setColorByKey(my_mc, 'tint', 50, 0x33FF00);

Parameters:
targetObj MovieClip or target to alter
type String "brightness", "brightOffset", "contrast", "invertColor", or "tint"
amt Percentage, can be negative in some cases
rgb For "tint", a color value in 0x000000 or "#000000" format

Definition at line 624 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.getColorTransObj ( type:String  ,
amt:Number  ,
rgb:Object   
) [static]

(General) Generates a generic Flash7-style color-transform object with props like ra, etc., by keyword.

Parameters:
type String "brightness", "brightOffset", "contrast", "invertColor", or "tint"
amt Percentage, can be negative in some cases
rgb For "tint", a color value in 0x000000 or "#000000" format

Definition at line 634 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.getColorKeysObj ( targOrTransObj:Object   )  [static]

(General) Provides readings by keyword for a target object or Flash7-style color-transform object. Inherent rounding errors are common! Especially when percentages are below 50. Even .tintString hex values may differ slightly.

Parameters:
targOrTransObj target object or Flash7-style color-transform object with props like ra, etc.
Returns:
object may contain props brightness, brightOffset, contrast, invertColor, tint, tintPercent, and tintString

Definition at line 666 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.initializeTargets (  )  [static]

Internal method that prepares any number of targets with AsBroadcaster functionality and a hidden engine ID.

Definition at line 698 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.deinitializeTargets (  )  [static]

Internal method that strips AsBroadcaster functionality and hidden engine ID from any target.

Definition at line 738 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.__mgrRelay ( inst:ZManager  ,
method:String  ,
args:Array   
) [static]

Internal relay for use by ZManager instance only

Parameters:
inst ZManager instance
deinitFlag true stops engine

Definition at line 764 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.setup ( deinitFlag:Boolean   )  [static, private]

Internal method that initializes the engine to start or stop executing updates on a pulse

Parameters:
deinitFlag true to stop engine

Definition at line 779 of file ZigoEngine.as.

static function com.mosesSupposes.fuse.ZigoEngine.parseCallback ( callback:Object  ,
targets:Array   
) [static, private]

Internal parser for callback parameter which can be various formats. User may pass easyfunc-string if Shortcuts class is registered, loose function as function or string, or callback object.

Parameters:
callback Parameter as passed by user to doTween or doShortcut
targets Tween targets, used in locating functions
Returns:
A formatted object containing properties skipLevel,cycles, and possibly extra1,extra2,start,upd,end

Definition at line 816 of file ZigoEngine.as.

Member Data Documentation

var com.mosesSupposes.fuse.ZigoEngine.VERSION [static]

Enables kit version to be retrieved at runtime or when reviewing a decompiled swf.

Definition at line 38 of file ZigoEngine.as.

var ZigoEngine based on concepts by Ladislav com.mosesSupposes.fuse.ZigoEngine.Zigo [static]

Definition at line 38 of file ZigoEngine.as.

var ZigoEngine based on concepts by Ladislav laco.wz.cz com.mosesSupposes.fuse.ZigoEngine.tween [static]

Definition at line 38 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.EASING [static]

Default easing if unspecified. This default is hardcoded in the engine and doesn't require that com.mosesSupposes.fuse.PennerEasing is registered. However you will need to register that class with the engine if you wish to set this property to a similar string like "easeOutQuad". You may also set this property to any standard easing function (like mx.transitions.easing).

Definition at line 46 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.DURATION [static]

Default tween duration if unspecified.

Definition at line 51 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.ROUND_RESULTS [static]

If set true the engine always rounds its math (helpful with pixelfonts). Degradation in animation and performance is minor with this feature enabled. Hence it was left a global toggle with the assumption that it should only be set true for projects requiring rounding.

Definition at line 57 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.OUTPUT_LEVEL [static]

Controls how much feedback the engine outputs, helpful for debugging.

Definition at line 69 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.AUTOSTOP [static]

(Legacy) Option to stop all tweening props in target as a new tween is added.

Definition at line 74 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.SKIP_LEVEL [static]

(Advanced) Sets default engine behavior for situations where tweens fail to affect a visible change or have no duration. 1. No-duration tweens:
Tweens with a 0-second duration set the property immediately at the time of the tween call, or after any delay.
This behavior has advantages and disadvantages. It is recommended that you purposefully use 0-second tweens to set properties that are handled by the engine at any time in your program, since this will effectively stop any potentially running tweens on that property. (Trying to set a property while it is being tweened usually has no effect.) However in some dynamic programs you may want tweens that end up having no duration to also skip their delay and/or callbacks and events - this can be controlled with SKIP_LEVEL.

2. No-change tweens:
Tweens at times end up being generated that affect no visual change. Normally the ZigoEngine operates under its legacy behavior, which is to run such tweens regardless. This can be good (the program's sequence will continue on a schedule) or bad (the tween is essentially invisible and will fire callbacks and events on update and end, which may cause confusion). In some cases you may want to skip past tweens that don't do anything visually.

The SKIP_LEVEL default, as well as the per-tween skipLevel parameter (see doTween) enable you to control the engine's behavior in these situations more accurately:


To review what property tweens were successfully added, doTween returns a formatted list.

Definition at line 99 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.tweenHolder [static, private]

A movieclip is created in the _root timeline to run the engine on an EnterFrame pulse. Use setControllerDepth to set the clip's level. By default it is set on depth 6789. A depth of 0 will be more convenient if you'll be using depth management in _root.

Definition at line 105 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.instance [static, private]

Zmanager instance Broken out to increase speed in as2

Definition at line 111 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.updateIntId [static, private]

Internal setInterval id memory for ability to clearInterval

Definition at line 116 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.updateTime [static, private]

Internal setting for running the engine on a setInterval pulse.

See also:
setUpdateInterval

Definition at line 122 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine._playing [static, private]

Internal boolean playing switch

Definition at line 127 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.zigoIDs [static, private]

Internal counter for hidden __zigoID__ parameter written into target objects

Definition at line 132 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.extensions [static, private]

Internal table for externally registered classes which are stored via their registryKey string.

Definition at line 137 of file ZigoEngine.as.

var com.mosesSupposes.fuse.ZigoEngine.cbTicker [static, private]

Internal counter used to tag each callback function with a unique id

Definition at line 142 of file ZigoEngine.as.

Generated on Fri May 11 17:13:00 2007 for GuggaFramework by  doxygen 1.5.2