VerticesEngine.Particles.vxParticleSystem Class Reference

The particle system instance. More...

Public Member Functions
void	CreatePool< T > (int poolSize)
	Creates a pool of particle type 'T' of size 'n'.
T	Spawn< T > (vxGameObject emitter)
	Spawns a particle of type T.

Properties
static vxParticleSystem	Instance [get]
	The particle system singleton.

Detailed Description

The particle system instance.

Member Function Documentation

CreatePool< T >()

void VerticesEngine.Particles.vxParticleSystem.CreatePool< T >

(

int

poolSize

)

Creates a pool of particle type 'T' of size 'n'.

How to use the Particle System Create Pool method. This should eb used in the 'LoadParticlePool()' method in your Scene.

// Create a pool of '' with 100 elements in it
vxParticleSystem.Instance.CreatePool<ParticleBlastCloud>(100);

Template Parameters

T	The type of particle. It must implement the vxIParticle interface

Parameters

poolSize

The number of particles in this pool size

Type Constraints

T

:

vxIParticle

Spawn< T >()

T VerticesEngine.Particles.vxParticleSystem.Spawn< T >

(

vxGameObject

emitter

)

Spawns a particle of type T.

How to use the Spawn method.

// Spawns a new particle of type 'ParticleBlasCloudFire' using the <see cref="vxGameObject"/> emitter.
vxParticleSystem.Instance.Spawn<ParticleBlastCloudFire>(emitter);

Template Parameters

T	Spawns a of particle. It must implement the vxIParticle interface

Parameters

emitter

Returns

Type Constraints

T

:

vxIParticle

---

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

• /github/workspace/src/VerticesEngine/src.shared/Entities/Particles/vxParticleSystem.cs