+Show TOC
×Hide TOC

FrameDelay

Kind of class:	public class
Package:	org.casalib.time
Inherits from:	none
Implements:	IRunnable
Version:	09/06/09
Author:	Aaron Clinger
Classpath:	org.casalib.time.FrameDelay
File last modified:	Sunday, 06 September 2009, 08:46:07

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2009, Aaron Clinger & Contributors of CASA Lib
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    
    - Neither the name of the CASA Lib nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/
package org.casalib.time {
    import flash.events.Event;
    import org.casalib.time.EnterFrame;
    import org.casalib.control.IRunnable;
    
    /**
        Creates a callback after one or more frames. The class helps prevent race conditions by allowing recently created MovieClips, Classes, etc. a frame to initialize before proceeding.
        
        @author Aaron Clinger
        @version 09/06/09
        @example
            <code>
                package {
                    import org.casalib.display.CasaMovieClip;
                    import org.casalib.time.FrameDelay;
                    
                    
                    public class MyExample extends CasaMovieClip {
                        protected var _frameDelay:FrameDelay;
                        
                        
                        public function MyExample() {
                            super();
                            
                            this._frameDelay = new FrameDelay(this._onInitComplete);
                            this._frameDelay.start();
                        }
                        
                        protected function _onInitComplete():void{
                            trace("Ready!");
                        }
                    }
                }
            </code>
    */
    public class FrameDelay implements IRunnable {
        protected var _arguments:Array;
        protected var _callBack:Function;
        protected var _count:uint;
        protected var _frames:uint;
        protected var _enterFrameInstance:EnterFrame;
        
        
        /**
            Runs a function at a specified periodic interval.
            
            @param closure: The function to execute.
            @param frames: The amount of frames to delay.
            @param arguments: Arguments to be passed to the function when executed.
        */
        public function FrameDelay(closure:Function, frames:uint = 1, ...arguments) {
            super();
            
            this._callBack           = closure;
            this._frames             = frames;
            this._arguments          = arguments;
            this._enterFrameInstance = EnterFrame.getInstance();
        }
        
        /**
            Starts or restarts the delay.
        */
        public function start():void {
            this._count = 0;
            this._enterFrameInstance.addEventListener(Event.ENTER_FRAME, this._onEnterFrame, false, 0, true);
        }
        
        /**
            Stops the delay from completing.
        */
        public function stop():void {
            this._enterFrameInstance.removeEventListener(Event.ENTER_FRAME, this._onEnterFrame);
        }
        
        protected function _onEnterFrame(e:Event):void {
            if (++this._count >= this._frames) {
                this.stop();
                this._callBack.apply(null, this._arguments);
            }
        }
    }
}

Creates a callback after one or more frames. The class helps prevent race conditions by allowing recently created MovieClips, Classes, etc. a frame to initialize before proceeding.

Example:

package {
    import org.casalib.display.CasaMovieClip;
    import org.casalib.time.FrameDelay;


    public class MyExample extends CasaMovieClip {
        protected var _frameDelay:FrameDelay;


        public function MyExample() {
            super();

            this._frameDelay = new FrameDelay(this._onInitComplete);
            this._frameDelay.start();
        }

        protected function _onInitComplete():void{
            trace("Ready!");
        }
    }
}

Summary

Constructor

FrameDelay (closure:Function, frames:uint = 1, arguments)
- Runs a function at a specified periodic interval.

Instance methods

start : void
- Starts or restarts the delay.
stop : void
- Stops the delay from completing.

Constructor

FrameDelay

public function FrameDelay (

closure:Function, frames:uint = 1, arguments)

Runs a function at a specified periodic interval.

Parameters:

closure :

The function to execute.

frames :

The amount of frames to delay.

arguments:

Arguments to be passed to the function when executed.

Instance methods

start

public function start (

) : void

Starts or restarts the delay.

Specified by:

IRunnable.start

stop

public function stop (

) : void

Stops the delay from completing.

Specified by:

IRunnable.stop