joshtynjala/starling-preloader

An example preloader for Starling Framework running in Adobe Flash Player in a web browser

Preloader for Starling

SWFs running in a web browser should have preloaders. A preloader allows you to quickly display graphics and animation so that visitors to your webpage have something to look at while the rest of the SWF file loads.

How do you create a preloader for a Starling app? It's not really any different than creating a preloader for any other SWF. Here's a summary of how I do it. Be sure to look at the included source code for complete details.

1. Extend flash.display.MovieClip when creating the startup class. Call stop() in the constructor.

2. Use the following command line argument to compile your Starling root class on frame 2 instead of frame 1. It's the class that you will pass to the Starling constructor. It usually extends starling.display.Sprite.

   -frame two,com.example.StarlingRoot
   

3. Wait for the SWF to be completely loaded. Listen for Event.COMPLETE on the loaderInfo object.

4. In the Event.COMPLETE listener, call gotoAndStop(2) to switch to frame 2.

5. Get a reference to the Starling root class by calling getDefinitionByName(). Do not import this class. If you import it, it will be compiled on frame 1 instead of frame 2, and then the preloader won't work.

   var RootType:Class = getDefinitionByName("com.example.StarlingRoot") as Class;

6. Call getDefinitionByName() again to get a reference to starling.core.Starling. Again, do not import this class.

7. Initialize Starling using the classes returned by getDefinitionByName().

Please see the comments in the example code for more detailed explanations.

This project is not designed to create a preloader with Flash Professional. It is meant as an example for Flash Builder or any other development environment that uses the command line compiler.

starling-preloader's Issues

tiny problem

The "=" sign in Readme is forgotten in this line:

Use this compiler argument to put a class on frame 2.
-frame two,com.example.Main

(i.e. frame=2)

Was a problem when I copy pasted from there, no biggie but would help noobies out a bit :)

Mention that classes have to be in two separated packages

It could be nice if you mention somewhere that is really important to have both classes in two separated packages.

I say that because I got stock a moment because of this ;)

getDefinitionByName is not working for a class in the same package without using 'dummy' variable and if you create a 'dummy' variable, you include all the stuff you don't want.