Chunks.Graphics.ParticleEffect Class Reference

A resource describing a particle effect that can have randomized parameters. More...

Inheritance diagram for Chunks.Graphics.ParticleEffect:

Public Member Functions
	ParticleEffect ()
	Constructs a new particle effect with default paramters. More...

Public Attributes
int	FrameCount => _frameIndices.Count
	The total number of frames of animation in this particle effect. More...

Protected Member Functions
override void	OnReadDefinition (JToken token, string directory)
	When overridden in an inheriting class, handles reading information about the resource from a json token. More...

Properties
ParticleRenderMode	RenderMode [get, set]
Curve	Lifetime [get, set]
	A curve defining the range of lifetimes for particles. More...
Curve	EmissionRate [get, set]
	A curve defining the range of emission rates for particles. More...
Curve	BurstCount [get, set]
	A curve defining the range of burst counts for particles. More...
Curve	StartSize [get, set]
	A curve defining the range of starting sizes for particles. More...
Curve	SpawnRadius [get, set]
	A curve defining the range of spawn radii for particles. More...
Curve	StartSpeed [get, set]
	A curve defining the range of initial speeds for particles. More...
Curve	SpeedDecay [get, set]
	A curve defining the range of the rate of speed decay for particles. More...
Curve	StartRotation [get, set]
	A curve defining the range of initial rotations for particles. More...
Curve	RotationSpeed [get, set]
	A curve defining the range of rotation speeds for particles. More...

Detailed Description

A resource describing a particle effect that can have randomized parameters.

Constructor & Destructor Documentation

Chunks.Graphics.ParticleEffect.ParticleEffect

(

)

Constructs a new particle effect with default paramters.

Member Function Documentation

override void Chunks.Graphics.ParticleEffect.OnReadDefinition ( JToken  token, string  directory  )

protected

When overridden in an inheriting class, handles reading information about the resource from a json token.

Parameters

token	Token to load the resource from
directory	Location of the loaded json file's parent directory

Member Data Documentation

int Chunks.Graphics.ParticleEffect.FrameCount => _frameIndices.Count

The total number of frames of animation in this particle effect.

Property Documentation

Curve Chunks.Graphics.ParticleEffect.BurstCount

getset

A curve defining the range of burst counts for particles.

Curve Chunks.Graphics.ParticleEffect.EmissionRate

getset

A curve defining the range of emission rates for particles.

Curve Chunks.Graphics.ParticleEffect.Lifetime

getset

A curve defining the range of lifetimes for particles.

ParticleRenderMode Chunks.Graphics.ParticleEffect.RenderMode

getset

Curve Chunks.Graphics.ParticleEffect.RotationSpeed

getset

A curve defining the range of rotation speeds for particles.

Curve Chunks.Graphics.ParticleEffect.SpawnRadius

getset

A curve defining the range of spawn radii for particles.

Curve Chunks.Graphics.ParticleEffect.SpeedDecay

getset

A curve defining the range of the rate of speed decay for particles.

Curve Chunks.Graphics.ParticleEffect.StartRotation

getset

A curve defining the range of initial rotations for particles.

Curve Chunks.Graphics.ParticleEffect.StartSize

getset

A curve defining the range of starting sizes for particles.

Curve Chunks.Graphics.ParticleEffect.StartSpeed

getset

A curve defining the range of initial speeds for particles.

---

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

• Source/Chunks/Graphics/ParticleEffect.cs
• Source/Chunks/Graphics/ParticleEffectReflection.cs