ParticleData Class Reference
[Special Effects]

Contains information for how specific particles should look and react including particle colors, particle imagemap, acceleration value for individual particles and spin information. More...

Inheritance diagram for ParticleData:

[legend]

List of all members.

Public Member Functions
void	reload ()
	Reloads this particle.
Public Attributes
bool	animateTexture
	If true, allow the particle texture to be an animated sprite.
string	animTexFrames
	A list of frames and / or frame ranges to use for particle animation if animateTexture is true. Example: "0-16 20 19 18 17 31-21".
string	animTexName
	Texture file to use for this particle if animateTexture is true.
Point2I	animTexTiling
	The number of frames, in the rows and columns, stored in animTexName. Maximum of 256 frames can be stored in a single animTexName when using animTexTiling. Entered as "Columns / Rows". eg. "4 4".
ColorF	colors [4]
	Color values to set the particles, rgba. Up to 4 allowed. Will transition through colors based on values set in the times value. Example: colors[0] = "0.6 1.0 1.0 0.5".
float	constantAcceleration
	Amount to continously accelerate this particle by.
float	dragCoefficient
	Particle physics drag amount.
int	framesPerSec
	If animateTexture is true, this defines the frames per second of the sprite animation.
float	gravityCoefficient
	Strength of gravity on the particles.
float	inheritedVelFactor
	Amount to allow the velocity inherited from the emitter to effect the velocity of these particles.
int	lifetimeMS
	Time in milliseconds before this particle is destroyed.
int	lifetimeVarianceMS
	Variance in lifetime of particle between 0 milliseconds and n.
float	sizes [4]
	Sizes to set the particles. Up to 4 allowed. Will transition through sizes based on values set in the times value.
float	spinRandomMax
	Maximum allowed spin speed of this particle, between spinRandomMin and n.
float	spinRandomMin
	Minimum allowed spin speed of this particle, between n and spinRandomMax.
float	spinSpeed
	Speed at which to spin the particle.
Point2F	textureCoords [4]
	4 dimensional array defining the 4 locational points, in F32 (where 0.0 is top / left and 1.0 is bottom / right) of the textureName to use for this particle.
string	textureName
	Texture file to use for this particle.
float	times [4]
	Times to transition between colors and sizes. Up to 4 allowed. Values are 0.0 - 1.0, and corrispond to the life of the particle where 0 is first created and 1 is end of lifespace.
bool	useInvAlpha
	If true, will invert the colors of this particle.
float	windCoefficient
	Strength of wind on the particles.

---

Detailed Description

Contains information for how specific particles should look and react including particle colors, particle imagemap, acceleration value for individual particles and spin information.

---

Member Function Documentation

void ParticleData::reload

(

)

Reloads this particle.

Example:

// Get the editor's current particle
%particle = PE_ParticleEditor.currParticle

// Change a particle value
%particle.setFieldValue(%propertyField,%value);

// Reload it
%particle.reload();

---

Member Data Documentation

bool ParticleData::animateTexture

If true, allow the particle texture to be an animated sprite.

string ParticleData::animTexFrames

A list of frames and / or frame ranges to use for particle animation if animateTexture is true. Example: "0-16 20 19 18 17 31-21".

string ParticleData::animTexName

Texture file to use for this particle if animateTexture is true.

Point2I ParticleData::animTexTiling

The number of frames, in the rows and columns, stored in animTexName. Maximum of 256 frames can be stored in a single animTexName when using animTexTiling. Entered as "Columns / Rows". eg. "4 4".

ColorF ParticleData::colors[4]

Color values to set the particles, rgba. Up to 4 allowed. Will transition through colors based on values set in the times value. Example: colors[0] = "0.6 1.0 1.0 0.5".

float ParticleData::constantAcceleration

Amount to continously accelerate this particle by.

float ParticleData::dragCoefficient

Particle physics drag amount.

int ParticleData::framesPerSec

If animateTexture is true, this defines the frames per second of the sprite animation.

float ParticleData::gravityCoefficient

Strength of gravity on the particles.

float ParticleData::inheritedVelFactor

Amount to allow the velocity inherited from the emitter to effect the velocity of these particles.

int ParticleData::lifetimeMS

Time in milliseconds before this particle is destroyed.

int ParticleData::lifetimeVarianceMS

Variance in lifetime of particle between 0 milliseconds and n.

float ParticleData::sizes[4]

Sizes to set the particles. Up to 4 allowed. Will transition through sizes based on values set in the times value.

float ParticleData::spinRandomMax

Maximum allowed spin speed of this particle, between spinRandomMin and n.

float ParticleData::spinRandomMin

Minimum allowed spin speed of this particle, between n and spinRandomMax.

float ParticleData::spinSpeed

Speed at which to spin the particle.

Point2F ParticleData::textureCoords[4]

4 dimensional array defining the 4 locational points, in F32 (where 0.0 is top / left and 1.0 is bottom / right) of the textureName to use for this particle.

string ParticleData::textureName

Texture file to use for this particle.

float ParticleData::times[4]

Times to transition between colors and sizes. Up to 4 allowed. Values are 0.0 - 1.0, and corrispond to the life of the particle where 0 is first created and 1 is end of lifespace.

bool ParticleData::useInvAlpha

If true, will invert the colors of this particle.

float ParticleData::windCoefficient

Strength of wind on the particles.