Data Structures
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. More...

enum ParticleAutoDestroyFlags	RESET
	Reset state after stopping. More...

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

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

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

enum ParticleAutoDestroyFlags	FULL
	Mode for GetParticle. More...

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

enum ParticleAutoDestroyFlags	FILE
	Filename only ("smoking_barrel_small") More...

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

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. More...

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

Typedef Documentation

◆ ParticleSourceArray

typedef array<ParticleSource> ParticleSourceArray

Definition at line 103 of file particlesource.c.

Enumeration Type Documentation

◆ ParticleAutoDestroyFlags

enum ParticleAutoDestroyFlags

Flags to pass to ParticleSource.SetParticleAutoDestroyFlags.

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.

Variable Documentation

◆ FILE

enum ParticleAutoDestroyFlags FILE

Filename only ("smoking_barrel_small")

◆ FORCE_WORLD_ROT

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.

◆ FULL

enum ParticleAutoDestroyFlags FULL

Mode for GetParticle.

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

◆ IMMEDIATE

IMMEDIATE

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

It gets added in immediately, which means that when called while an invoker is running, it will call this newly added call in the same run.

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; Default flag, as that is the original behaviour, although it might cause endless Insert chain now... (still better than undefined behaviour); In case of "Possible endless Insert detected" VME, either create an exit, remove the IMMEDIATE flag or make the insert UNIQUE; The Endless Insert is detected by seeing if "amount of calls > initial size + 128"

Definition at line 138 of file tools.c.

◆ KEEP_PARENT_ON_END

enum ParticleAutoDestroyFlags KEEP_PARENT_ON_END

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

◆ NO_EXT

enum ParticleAutoDestroyFlags NO_EXT

Full path without ext ("graphics/particles/smoking_barrel_small")

◆ NONE

@ NONE

Flags to pass to ParticleSource.PlayParticleEx.

No automatic destroying.

Flags to pass to ParticleSource.StopParticle.

No flags

Definition at line 5 of file particlesource.c.

◆ PAUSE

enum ParticleAutoDestroyFlags PAUSE

(SPF_IMMEDIATE | SPF_VISIBLE) "Freezes" the particle while keeping it visible

◆ PLAY_ON_CREATION

enum ParticleAutoDestroyFlags PLAY_ON_CREATION

Makes the particle start playing immediately after being created.

◆ RESET

enum ParticleAutoDestroyFlags RESET

Reset state after stopping.

◆ VISIBLE

enum ParticleAutoDestroyFlags VISIBLE

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

Data Structures

Typedefs

Enumerations

Variables