Particle Playground - Script Reference  3.0.1
Framework for controlling particles in the Unity Engine.
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
ParticlePlayground.PlaygroundSave Class Reference

Holds information for a particle system Snapshot. More...

Public Member Functions

bool IsLoading ()
 Determines whether this PlaygroundSave is loading. More...
 
bool IsSaving ()
 Determines whether this PlaygroundSave is saving. More...
 
void Load (PlaygroundParticlesC loadTo)
 Loads the data from this PlaygroundSave. More...
 
void Save (PlaygroundParticlesC playgroundParticles)
 Saves the data into this PlaygroundSave. More...
 
PlaygroundSave Clone ()
 Returns a copy of this PlaygroundSave. More...
 

Public Attributes

string name
 The name of this PlaygroundSave. More...
 
float time
 The global time when this PlaygroundSave was created. More...
 
float lifetime
 The lifetime of the particle system. More...
 
int particleCount
 The particle count of the particle system. More...
 
float version = 0
 The version this snapshot was made with. More...
 
PlaygroundParticlesC settings
 The cached settings of the particle system (Particles are stored in settings.snapshotData). More...
 
PlaygroundTransformC transform
 The stored transform information. More...
 
Material material
 The stored material. More...
 
int loadMode = 0
 The method to load data from this PlaygroundSave. 0 = Settings+Particles, 1 = Settings only, 2 = Particles only More...
 
bool loadTransform = true
 Should the stored transform information load? More...
 
bool loadMaterial = true
 Should the stored material load? More...
 
bool setMaterialAfterTransition = true
 Should the material load before or after transition? More...
 
float transitionMultiplier = 1f
 The multiplier of transition time. More...
 
INDIVIDUALTRANSITIONTYPEC transitionType
 The transition type of this PlaygroundSave. More...
 
bool unfolded = false
 

Detailed Description

Holds information for a particle system Snapshot.

Member Function Documentation

PlaygroundSave ParticlePlayground.PlaygroundSave.Clone ( )

Returns a copy of this PlaygroundSave.

bool ParticlePlayground.PlaygroundSave.IsLoading ( )

Determines whether this PlaygroundSave is loading.

Returns
true if this PlaygroundSave is loading; otherwise, false.
bool ParticlePlayground.PlaygroundSave.IsSaving ( )

Determines whether this PlaygroundSave is saving.

Returns
true if this PlaygroundSave is saving; otherwise, false.
void ParticlePlayground.PlaygroundSave.Load ( PlaygroundParticlesC  loadTo)

Loads the data from this PlaygroundSave.

Parameters
loadToLoad to.
void ParticlePlayground.PlaygroundSave.Save ( PlaygroundParticlesC  playgroundParticles)

Saves the data into this PlaygroundSave.

Parameters
playgroundParticlesPlayground particles.

Member Data Documentation

float ParticlePlayground.PlaygroundSave.lifetime

The lifetime of the particle system.

bool ParticlePlayground.PlaygroundSave.loadMaterial = true

Should the stored material load?

int ParticlePlayground.PlaygroundSave.loadMode = 0

The method to load data from this PlaygroundSave. 0 = Settings+Particles, 1 = Settings only, 2 = Particles only

bool ParticlePlayground.PlaygroundSave.loadTransform = true

Should the stored transform information load?

Material ParticlePlayground.PlaygroundSave.material

The stored material.

string ParticlePlayground.PlaygroundSave.name

The name of this PlaygroundSave.

int ParticlePlayground.PlaygroundSave.particleCount

The particle count of the particle system.

bool ParticlePlayground.PlaygroundSave.setMaterialAfterTransition = true

Should the material load before or after transition?

PlaygroundParticlesC ParticlePlayground.PlaygroundSave.settings

The cached settings of the particle system (Particles are stored in settings.snapshotData).

float ParticlePlayground.PlaygroundSave.time

The global time when this PlaygroundSave was created.

PlaygroundTransformC ParticlePlayground.PlaygroundSave.transform

The stored transform information.

float ParticlePlayground.PlaygroundSave.transitionMultiplier = 1f

The multiplier of transition time.

INDIVIDUALTRANSITIONTYPEC ParticlePlayground.PlaygroundSave.transitionType

The transition type of this PlaygroundSave.

float ParticlePlayground.PlaygroundSave.version = 0

The version this snapshot was made with.


The documentation for this class was generated from the following file: