Classes
class	array
	Result for an object found in CGame.IsBoxCollidingGeometryProxy. More...

class	ParticleSource
	Entity which has the particle instance as an ObjectComponent. More...

Typedefs
typedef array< ParticleSource >	ParticleSourceArray

Enumerations
enum	ParticleAutoDestroyFlags { ON_END , ON_STOP , ALL }
	Flags to pass to ParticleSource.SetParticleAutoDestroyFlags. More...

Variables
enum ParticleAutoDestroyFlags	NONE
	Flags to pass to ParticleSource.PlayParticleEx.

enum ParticleAutoDestroyFlags	RESET
	Reset state after stopping.

enum ParticleAutoDestroyFlags	IMMEDIATE
	Flag will make the particle stop immediately, taking it out of simulation and clearing VISIBLE flag.

enum ParticleAutoDestroyFlags	VISIBLE
	Is default behaviour, but can be used in conjuction with IMMEDIATE which hides it when this flag is not present.

enum ParticleAutoDestroyFlags	PAUSE
	(SPF_IMMEDIATE \| SPF_VISIBLE) "Freezes" the particle while keeping it visible

enum ParticleAutoDestroyFlags	FULL
	Mode for GetParticle.

enum ParticleAutoDestroyFlags	NO_EXT
	Full path without ext ("graphics/particles/smoking_barrel_small")

enum ParticleAutoDestroyFlags	FILE
	Filename only ("smoking_barrel_small")

enum ParticleAutoDestroyFlags	PLAY_ON_CREATION
	Makes the particle start playing immediately after being created.

enum ParticleAutoDestroyFlags	FORCE_WORLD_ROT
	Only applicable when there is a parent, this will force the localOri to be in world space instead of local.

enum ParticleAutoDestroyFlags	KEEP_PARENT_ON_END
	By default, a particle unparents when it ends, this disables this behaviour.

Typedef Documentation

◆ ParticleSourceArray

Definition at line 103 of file ParticleSource.c.

Enumerator
ON_END	Destroy when the Particle ends (looping particle never ends)
ON_STOP	Destroy when particle stops.
ALL	ON_END \| ON_STOP.

Definition at line 2 of file ParticleSource.c.

{
  NONE,
  ON_END,
  ON_STOP,
  ALL,
}

Filename only ("smoking_barrel_small")

Only applicable when there is a parent, this will force the localOri to be in world space instead of local.

Mode for GetParticle.

Full path with ext ("graphics/particles/smoking_barrel_small.ptc")

Flag will make the particle stop immediately, taking it out of simulation and clearing VISIBLE flag.

Note: By default the particle will gradually fade; Note that when using IMMEDIATE, it is possible to call PlayParticle and it will resume from the moment it stopped Which is not possible by default, as the gradual fade is accomplished by nulling the lifetime