https://github.com/Gamua/Starling-Extension-Particle-System

A particle system for the Starling framework, compatible with the "Particle Designer" from 71squared.com
https://github.com/Gamua/Starling-Extension-Particle-System

Last synced: about 2 months ago
JSON representation

A particle system for the Starling framework, compatible with the "Particle Designer" from 71squared.com

• Host: GitHub
• URL: https://github.com/Gamua/Starling-Extension-Particle-System
• Owner: Gamua
• License: other
• Created: 2011-09-02T19:05:16.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2024-07-25T07:28:27.000Z (6 months ago)
• Last Synced: 2024-08-03T05:01:52.042Z (5 months ago)
• Language: ActionScript
• Homepage:
• Size: 140 KB
• Stars: 321
• Watchers: 60
• Forks: 146
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-actionscript-sorted - Starling-Extension-Particle-System - A particle system for the Starling framework, compatible with the "Particle Designer" from 71squared.com (User Interface / Starling)

README

        
Starling Extension: Particle System

===================================

The Starling Particle System classes provide an easy way to display particle systems from within the [Starling Framework][1]. That way, adding special effects like explosions, smoke, snow, fire, etc. is very easy to do.

The extension consists of three classes:

1. `Particle`: stores the state of a particle, like its position and color

2. `ParticleSystem`: the base class for particle systems. Implements a very simple particle movement. To create a custom particle system, extend this class and override the methods `createParticle`, `initParticle`, and `advanceParticle`.

3. `PDParticleSystem`: a particle system subclass that can display particle systems created with the  [Particle Designer][2] from 71squared.

Installation

------------

Which version to download depends on the Starling version you are using:

* If you work with a release version of Starling, download the Particle System with the equivalent tag (Starling 1.1 -> Particle System 1.1).

* If you work with the latest development version of Starling, download the head revision of the Particle System. 

After downloading, you will find the three classes described above in the `src`-directory. You can either copy them directly to your Starling-powered application, or you add the source path to your FlexBuilder project.

Demo-Project

------------

The `demo`-directory contains a sample project. To compile it, add a reference to the Starling library and add the source directory that contains the particle system classes.

The project contains 4 sample configurations. Switch between configurations in `Demo.as` by 

hitting the space bar.

Sample Code

-----------

The class `ParticleSystem` extends `DisplayObject` and behaves accordingly. You can add it as a child to the stage or any other container. As usual, you have to add it to a juggler (or call its `advanceTime` method once per frame) to animate it.

    // create particle system

    _particleSystem = new PDParticleSystem(psConfig, psTexture);

    _particleSystem.emitterX = 320;

    _particleSystem.emitterY = 240;

    

    // add it to the stage and the juggler

    addChild(_particleSystem);

    Starling.juggler.add(_particleSystem);

    // start emitting particles

    _particleSystem.start();

    // stop emitting particles

    _particleSystem.stop();

More information

----------------

You can find more information in the [Starling Wiki](http://wiki.starling-framework.org/extensions/particlesystem).

[1]: http://www.starling-framework.org

[2]: http://particledesigner.71squared.com