Chunks.Graphics.ParticleEmitter Class Reference

Component that can emit particles from its location. More...

Inheritance diagram for Chunks.Graphics.ParticleEmitter:

Public Member Functions
void	Emit (float effectScale=1f)
	Emits a burst of particles, optionally scaled in count, size, and velocity by effectScale . More...
void	Emit (int count, float velocityScale=1f, float sizeScale=1f)
	Emits a burst of count particles, optionally scaled in velocity and size. More...

Protected Member Functions
override void	OnInitialize ()
	Called only once, when the component is first attached to an entity and is ready to add or retrieve other components. More...
override void	OnDestroy ()
	Called when this component is removed, or the parent entity is destroyed. More...
override void	OnEnable ()
	Called each time this component goes from being disabled to enabled. More...
override void	OnDisable ()
	Called each time this component goes from being enabled to disabled. More...
override void	OnPhysicsUpdate ()
	Called at a fixed time step for any time dependant physics calculations. More...
override void	OnUpdate ()
	Called once per world update if this component and its parent entity are enabled. More...

Properties
ParticleEffect	ParticleEffect [get, set]
	The particle effect currently attached to this emitter. More...
bool	IsEmitting [get, set]
	Controls whether this emitter should continuously emit particles. More...
bool	InheritVelocity [get, set]
	Controls whether the initial velocity of new particles is added on to by this emitter's velocity. More...
Vector	InitialVelocity [get, set]
Vector	LocalOffset [get, set]
	Position offset to apply to each newly emitted particle, local to the emitter's transform. More...

Detailed Description

Component that can emit particles from its location.

Member Function Documentation

void Chunks.Graphics.ParticleEmitter.Emit

(

float

effectScale = 1f

)

Emits a burst of particles, optionally scaled in count, size, and velocity by effectScale .

Parameters

effectScale

Amount to scale particle count, size, and velocity by

void Chunks.Graphics.ParticleEmitter.Emit	(	int	count,
		float	velocityScale = 1f,
		float	sizeScale = 1f
	)

Emits a burst of count particles, optionally scaled in velocity and size.

Parameters

count	Number of particles to emit
velocityScale	Amount to scale each particle's initial velocity by
sizeScale	Amount to scale each particle's initial size by

override void Chunks.Graphics.ParticleEmitter.OnDestroy ( )

protected

Called when this component is removed, or the parent entity is destroyed.

override void Chunks.Graphics.ParticleEmitter.OnDisable ( )

protected

Called each time this component goes from being enabled to disabled.

override void Chunks.Graphics.ParticleEmitter.OnEnable ( )

protected

Called each time this component goes from being disabled to enabled.

override void Chunks.Graphics.ParticleEmitter.OnInitialize ( )

protected

Called only once, when the component is first attached to an entity and is ready to add or retrieve other components.

override void Chunks.Graphics.ParticleEmitter.OnPhysicsUpdate ( )

protected

Called at a fixed time step for any time dependant physics calculations.

override void Chunks.Graphics.ParticleEmitter.OnUpdate ( )

protected

Called once per world update if this component and its parent entity are enabled.

Property Documentation

bool Chunks.Graphics.ParticleEmitter.InheritVelocity

getset

Controls whether the initial velocity of new particles is added on to by this emitter's velocity.

Vector Chunks.Graphics.ParticleEmitter.InitialVelocity

getset

bool Chunks.Graphics.ParticleEmitter.IsEmitting

getset

Controls whether this emitter should continuously emit particles.

Vector Chunks.Graphics.ParticleEmitter.LocalOffset

getset

Position offset to apply to each newly emitted particle, local to the emitter's transform.

ParticleEffect Chunks.Graphics.ParticleEmitter.ParticleEffect

getset

The particle effect currently attached to this emitter.

---

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

• Source/Chunks/Graphics/ParticleEmitter.cs