cv.orion.output.TimedOutput

Package	cv.orion.output
Class	public class TimedOutput
Inheritance	TimedOutput SteadyOutput
Implements	IOutput

The TimedOutput class outputs particles for a specified amount of time. It extends the SteadyOutput class, so the rate it outputs can also be adjusted.

Example
There are two ways to control output. The first way it so set it in the constructor. The second way is to add it via the output property.

  import cv.Orion;
  import cv.orion.output.TimedOutput;
  
  // First method
  var e:Orion = new Orion(linkageClass, new TimedOutput(1000, 40));
  
  // Second method
  var e2:Orion = new Orion(linkageClass);
  e2.output = new TimedOutput(1000, 40);

	Property	Defined by
		duration : uint Gets or sets the duration that the particles are outputted.	TimedOutput
		particlesPerSecond : Number The current rate assigned to SteadyOutput, in particles per second.	SteadyOutput
		paused : Boolean Gets or sets the paused property	SteadyOutput

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		TimedOutput(duration:uint = 5000, particlesPerSecond:Number = 20) Controls the duration that the particles are emitted.	TimedOutput
		pause():void Pauses the output class.	SteadyOutput
		play():void Resumes or plays the output class.	SteadyOutput
		reset():void After the timer has stopped, you can start the timer again by resetting it with this method.	TimedOutput
		update(emitter:Orion):void This is called everytime the particles are called to update and be redrawn.	TimedOutput

	Method	Defined by
		checkEmit(emitter:Orion):void Checks if it's time to emit particles and how many.	SteadyOutput
		updateTimes(emitter:Orion):void Updates the previous and difference in times.	SteadyOutput

Property detail

duration

property

public var duration:uint

Gets or sets the duration that the particles are outputted.

Constructor detail

TimedOutput

()

constructor

public function TimedOutput(duration:uint = 5000, particlesPerSecond:Number = 20)

Controls the duration that the particles are emitted.

Parameters

	`duration:uint` (default = `5000`) — How long the particles will be emitted, in milliseconds.

	`particlesPerSecond:Number` (default = `20`) — The rate at which to output particles

Method detail

reset

()

method

public function reset():void

After the timer has stopped, you can start the timer again by resetting it with this method.

update

()

method

public override function update(emitter:Orion):void

This is called everytime the particles are called to update and be redrawn. Depending on the output class, this can determine the output of the particles.

Parameters

emitter:Orion — The emitter to be used.

Orion API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class TimedOutput	Properties \| Methods