Engine.ParticleSystemComponent

Extends

PrimitiveComponent

Modifiers

native ( Particle ) hidecategories ( Object ) hidecategories ( Physics ) hidecategories ( Collision ) editinlinenew dependson ( ParticleSystem )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Core.Component
   |   
   +-- Engine.ActorComponent
      |   
      +-- Engine.PrimitiveComponent
         |   
         +-- Engine.ParticleSystemComponent

Direct Known Subclasses:

CascadeParticleSystemComponent, UTParticleSystemComponent

Delegates Summary
		OnSystemFinished (ParticleSystemComponent PSystem)

Functions Summary
		ActivateSystem ()
		ClearParameter (name ParameterName, optional EParticleSysParamType ParameterType)
		DeactivateSystem ()
	int	GetEditorLODLevel ()
	int	GetLODLevel ()
	bool	GetSkipUpdateDynamicDataDuringTick ()
		KillParticlesForced ()
		ResetToDefaults ()
		RewindEmitterInstance (int EmitterIndex)
		RewindEmitterInstances ()
		SetActive (bool bNowActive)
		SetActorParameter (name ParameterName, actor Param)
		SetBeamDistance (int EmitterIndex, float Distance)
		SetBeamEndPoint (int EmitterIndex, vector NewEndPoint)
		SetBeamSourcePoint (int EmitterIndex, vector NewSourcePoint, int SourceIndex)
		SetBeamSourceStrength (int EmitterIndex, float NewSourceStrength, int SourceIndex)
		SetBeamSourceTangent (int EmitterIndex, vector NewTangentPoint, int SourceIndex)
		SetBeamTargetPoint (int EmitterIndex, vector NewTargetPoint, int TargetIndex)
		SetBeamTargetStrength (int EmitterIndex, float NewTargetStrength, int TargetIndex)
		SetBeamTargetTangent (int EmitterIndex, vector NewTangentPoint, int TargetIndex)
		SetBeamTessellationFactor (int EmitterIndex, float NewFactor)
		SetBeamType (int EmitterIndex, int NewMethod)
		SetColorParameter (name ParameterName, color Param)
		SetEditorLODLevel (int InLODLevel)
		SetFloatParameter (name ParameterName, float Param)
		SetKillOnCompleted (int EmitterIndex, bool bKill)
		SetKillOnDeactivate (int EmitterIndex, bool bKill)
		SetLODLevel (int InLODLevel)
		SetMaterialParameter (name ParameterName, MaterialInterface Param)
		SetSkipUpdateDynamicDataDuringTick (bool bInSkipUpdateDynamicDataDuringTick)
		SetTemplate (ParticleSystem NewTemplate)
		SetVectorParameter (name ParameterName, vector Param)

AccumTickTime Source code

Used to accumulate total tick time to determine whether system can be skipped ticking if not visible.

bDeferredBeamUpdate Source code

Set this to TRUE to have beam emitters defer their update until the data is being passed to the render thread.

bForcedInActive Source code

This is set when any of our "don't tick me" timeout values have fired

bIsActive Source code

INTERNAL Set to TRUE when InitParticles has been called. Set to FALSE when ResetParticles has been called. Used to quick-out of Tick and Render calls (when caching PSysComps and emitter instances).

bIsCachedInPool Source code

bCanBeCachedInPool If this is true, when the PSC completes it will do the following: bHidden = TRUE This is used for Particles which are cached in a pool where you need to make certain to NOT kill off the EmitterInstances so we do not re allocate. @see ActivateSystem() where it rewinds the indiv emitters if they need it

bIsViewRelevanceDirty Source code

If TRUE, the ViewRelevanceFlags are dirty and should be recached

bIsWarmingUp Source code

This is set when the particle system component is warming up

bJustAttached Source code

Indicates that the component has not been ticked since being attached.

bSkipUpdateDynamicDataDuringTick Source code

Flag indicating that dynamic updating of render data should NOT occur during Tick. This is used primarily to allow for warming up and simulated effects to a certain state.

bSuppressSpawning Source code

bUpdateComponentInTick Source code

Set this to TRUE to have the PSysComponent update during the tick if 'dirty'.

bUpdateOnDedicatedServer Source code

whether to update the particle system on dedicated servers

bWarmingUp Source code

bWasCompleted Source code

bWasDeactivated Source code

CachedViewRelevanceFlags Source code

The view relevance flags for each LODLevel.

EditorLODLevel Source code

INTERNAL. Used by the editor to set the LODLevel

EmitterInstances Source code

LODLevel Source code

OldPosition Source code

PartSysVelocity Source code

SMComponents Source code

The static mesh components for a mesh emitter. This is to prevent the SMCs from being garbage collected.

SMMaterialInterfaces Source code

WarmupTime Source code

LOD

bOverrideLODMethod Source code

indicates that the component's LODMethod overrides the Template's

LODMethod Source code

The method of LOD level determination to utilize for this particle system

ParticleSystemComponent

bAutoActivate Source code

If true, activate on creation.

bResetOnDetach Source code

InstanceParameters Source code

Array holding name instance parameters for this ParticleSystemComponent. Parameters can be used in Cascade using DistributionFloat/VectorParticleParameters.

SecondsBeforeInactive Source code

Number of seconds of emitter not being rendered that need to pass before it no longer gets ticked/ becomes inactive.

Template Source code

EParticleSysParamType Source code

Enum for specifying type of a name instance parameter.

ParticleEmitterInstance Source code

ParticleSysParam Source code

Struct used for a particular named instance parameter for this ParticleSystemComponent.

OnSystemFinished Source code

ActivateSystem Source code

ClearParameter Source code

clears the specified parameter, returning it to the default value set in the template
@param ParameterName name of parameter to remove
@param ParameterType type of parameter to remove; if omitted or PSPT_None is specified, all parameters with the given name are removed

DeactivateSystem Source code

GetEditorLODLevel Source code

GetLODLevel Source code

GetLODLevel - gets the LOD level currently set.

GetSkipUpdateDynamicDataDuringTick Source code

Function for retrieving the bSkipUpdateDynamicDataDuringTick flag.

KillParticlesForced Source code

ResetToDefaults Source code

stops the emitter, detaches the component, and resets the component's properties to the values of its template

RewindEmitterInstance Source code

Rewind emitter instances.

RewindEmitterInstances Source code

SetActive Source code

calls ActivateSystem() or DeactivateSystem() only if the component is not already activated/deactivated necessary because ActivateSystem() resets already active emitters so it shouldn't be called multiple times on looping effects
@param bNowActive - whether the system should be active

SetActorParameter Source code

SetBeamDistance Source code

Set the beam distance
@param EmitterIndex The index of the emitter to set it on
@param Distance The value to set it to

SetBeamEndPoint Source code

Set the beam end point
@param EmitterIndex The index of the emitter to set it on
@param NewEndPoint The value to set it to

SetBeamSourcePoint Source code

Set the beam source point
@param EmitterIndex The index of the emitter to set it on
@param NewSourcePoint The value to set it to
@param SourceIndex Which beam within the emitter to set it on

SetBeamSourceStrength Source code

Set the beam source strength
@param EmitterIndex The index of the emitter to set it on
@param NewSourceStrength The value to set it to
@param SourceIndex Which beam within the emitter to set it on

SetBeamSourceTangent Source code

Set the beam source tangent
@param EmitterIndex The index of the emitter to set it on
@param NewTangentPoint The value to set it to
@param SourceIndex Which beam within the emitter to set it on

SetBeamTargetPoint Source code

Set the beam target point
@param EmitterIndex The index of the emitter to set it on
@param NewTargetPoint The value to set it to
@param TargetIndex Which beam within the emitter to set it on

SetBeamTargetStrength Source code

Set the beam target strength
@param EmitterIndex The index of the emitter to set it on
@param NewTargetStrength The value to set it to
@param TargetIndex Which beam within the emitter to set it on

SetBeamTargetTangent Source code

Set the beam target tangent
@param EmitterIndex The index of the emitter to set it on
@param NewTangentPoint The value to set it to
@param TargetIndex Which beam within the emitter to set it on

SetBeamTessellationFactor Source code

Set the beam tessellation factor
@param EmitterIndex The index of the emitter to set it on
@param NewFactor The value to set it to

SetBeamType Source code

Set the beam type
@param EmitterIndex The index of the emitter to set it on
@param NewMethod The new method/type of beam to generate

SetColorParameter Source code

SetEditorLODLevel Source code

SetFloatParameter Source code

SetKillOnCompleted Source code

SetKillOnDeactivate is used to set the KillOnCompleted( flag. If true, when the particle system is completed, it will immediately kill the emitter instance. Set this to true for cached ParticleSystems
@param EmitterIndex The index of the emitter to set it on
@param bKill The value to set it to

SetKillOnDeactivate Source code

SetKillOnDeactivate is used to set the KillOnDeactivate flag. If true, when the particle system is deactivated, it will immediately kill the emitter instance. If false, the emitter instance live particles will complete their lifetime. Set this to true for cached ParticleSystems
@param EmitterIndex The index of the emitter to set it on
@param bKill value to set KillOnDeactivate to

SetLODLevel Source code

SetLODLevel - sets the LOD level to use for this instance.

SetMaterialParameter Source code

SetSkipUpdateDynamicDataDuringTick Source code

Function for setting the bSkipUpdateDynamicDataDuringTick flag.

SetTemplate Source code

SetVectorParameter Source code

defaultproperties
{
   bAutoActivate=True
   bTickInEditor=True
   Name="Default__ParticleSystemComponent"
   ObjectArchetype=PrimitiveComponent'Engine.Default__PrimitiveComponent'
}