Classes
class	ParticleEffectEntityClass
class	ParticleEffectEntitySpawnParams
class	ReplicatedParticleEffectEntityClass

Enumerations
enum	EParticleEffectState { STOPPED , PLAYING , PAUSED , STOPPING_EMISSION , STOPPED , PLAYING , PAUSED , STOPPING_EMISSION }
enum	EParticleEffectState { STOPPED , PLAYING , PAUSED , STOPPING_EMISSION , STOPPED , PLAYING , PAUSED , STOPPING_EMISSION }

Functions
ParticleEffectEntityClass GenericEntityClass	SpawnParticleEffect (ResourceName effectPath, notnull ParticleEffectEntitySpawnParams spawnParams)
proto external EParticleEffectState	GetState ()
proto external float	GetTotalSimulationTime ()
	It returns the time since it started playing in seconds.
proto external bool	HasActiveParticles ()
proto external void	SetUseFrameEvent (bool useFrameEvent)
proto external void	SetPlayOnHeadlessClient (bool playOnHeadlessClient)
proto external void	SetEffectPath (ResourceName effectPath)
proto external void	SetDeleteWhenStopped (bool deleteWhenStopped)
	Tells if we should be deleted when it is finished or when the emission is stopped.
proto external void	SetUseParentAsVelocitySource (bool useParentAsVelocitySource)
proto external void	SetFollowParent (IEntity parent, vector localTransform[4], int pivotId=-1)
	Follow the parent, if pivotId != -1, local transform is local to the pivot otherwise local to the entity.
proto external void	Play ()
	Play the current particle. If paused, then it resumes it.
proto external void	Stop ()
	Stop the current particle.
proto external void	Pause ()
	Pause the current particle.
proto external void	StopEmission ()
	Stop the emitters' emission, but update ourselves until it hasn't active particles.
proto external IEntity	GetLeadingParent ()
event void	OnUpdateEffect (float timeSlice)
event void	OnStateChanged (EParticleEffectState oldState, EParticleEffectState newState)

Detailed Description

Enumeration Type Documentation

◆ EParticleEffectState [1/2]

enum EParticleEffectState

Enumerator
STOPPED
PLAYING
PAUSED
STOPPING_EMISSION
STOPPED
PLAYING
PAUSED
STOPPING_EMISSION

Definition at line 12 of file EParticleEffectState.c.

◆ EParticleEffectState [2/2]

enum EParticleEffectState

Enumerator
STOPPED
PLAYING
PAUSED
STOPPING_EMISSION
STOPPED
PLAYING
PAUSED
STOPPING_EMISSION

Definition at line 12 of file EParticleEffectState.c.

Function Documentation

◆ GetLeadingParent()

proto external IEntity GetLeadingParent ( )

◆ GetState()

proto external EParticleEffectState GetState ( )

Returns

Definition at line 32 of file SCR_BaseEntitiesEditorUIEffect.c.

◆ GetTotalSimulationTime()

proto external float GetTotalSimulationTime ( )

It returns the time since it started playing in seconds.

◆ HasActiveParticles()

proto external bool HasActiveParticles ( )

◆ OnStateChanged()

event void OnStateChanged	(	EParticleEffectState	oldState,
		EParticleEffectState	newState )

Definition at line 11 of file SCR_ReplicatedParticleEffectEntity.c.

◆ OnUpdateEffect()

event void OnUpdateEffect ( float timeSlice )

◆ Pause()

proto external void Pause ( )

Pause the current particle.

◆ Play()

proto external void Play ( )

Play the current particle. If paused, then it resumes it.

Start playing the animation. Call 'Prepare' first if you need to change the setup of a component!

Definition at line 85 of file SCR_AudioSource.c.

◆ SetDeleteWhenStopped()

proto external void SetDeleteWhenStopped ( bool deleteWhenStopped )

Tells if we should be deleted when it is finished or when the emission is stopped.

◆ SetEffectPath()

proto external void SetEffectPath ( ResourceName effectPath )

◆ SetFollowParent()

proto external void SetFollowParent	(	IEntity	parent,
		vector	localTransform[4],
		int	pivotId = -1 )

Follow the parent, if pivotId != -1, local transform is local to the pivot otherwise local to the entity.

◆ SetPlayOnHeadlessClient()

proto external void SetPlayOnHeadlessClient ( bool playOnHeadlessClient )

◆ SetUseFrameEvent()

proto external void SetUseFrameEvent ( bool useFrameEvent )

Set if we should use FRAME instead of the VISIBLE event flag to be updated. This means if we should update only when we are rendered, or not.

◆ SetUseParentAsVelocitySource()

proto external void SetUseParentAsVelocitySource ( bool useParentAsVelocitySource )

◆ SpawnParticleEffect()

ParticleEffectEntityClass GenericEntityClass SpawnParticleEffect	(	ResourceName	effectPath,
		notnull ParticleEffectEntitySpawnParams	spawnParams )

Spawn a particle effect from an effectPath given as parameter.

Parameters

effectPath Could be a .ptc path or a prefab path

◆ Stop()

proto external void Stop ( )

Stop the current particle.

Stop tracking time in this menu, prepare for sending data.

Stop the animation.