My program doesn't have bugs. It just develops random features.

UE3:ParticleSystemComponent (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> Component >> ActorComponent >> PrimitiveComponent >> ParticleSystemComponent

Contents

Package: 
Engine
Direct subclasses:
CascadeParticleSystemComponent, UTParticleSystemComponent
This class in other games:
UT3


Properties[edit]

Property group 'LOD'[edit]

bOverrideLODMethod[edit]

Type: bool

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

LODMethod[edit]

Type: ParticleSystem.ParticleSystemLODMethod

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

Property group 'ParticleSystemComponent'[edit]

bAutoActivate[edit]

Type: bool

If true, activate on creation.

Default value: True

bResetOnDetach[edit]

Type: bool


CustomTimeDilation[edit]

Type: float

Scales DeltaTime in UParticleSystemComponent::Tick(...)

Default value: 1.0

InstanceParameters[edit]

Type: array<ParticleSysParam>

Modifiers: editinline

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

ReplayClips[edit]

Type: array<ParticleSystemReplay>

Modifiers: const, editinline

Array of replay clips for this particle system component. These are serialized to disk. You really should never add anything to this in the editor. It's exposed so that you can delete clips if you need to, but be careful when doing so!

SecondsBeforeInactive[edit]

Type: float

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

Default value: 1.0

Template[edit]

Type: ParticleSystem

Modifiers: const


Internal variables[edit]

See ParticleSystemComponent internal variables.

Default values[edit]

Property Value
bTickInEditor True

Enums[edit]

EParticleEventType[edit]

Event type

EPET_Any 
Any - allow any event
EPET_Spawn 
Spawn - a particle spawn event
EPET_Death 
Death - a particle death event
EPET_Collision 
Collision - a particle collision event
EPET_Kismet 
Kismet - an event generated by Kismet

EParticleSysParamType[edit]

Enum for specifying type of a name instance parameter.

PSPT_None 
PSPT_Scalar 
PSPT_Vector 
PSPT_Color 
PSPT_Actor 
PSPT_Material 

ParticleReplayState[edit]

Particle system replay state

PRS_Disabled 
Replay system is disabled. Particles are simulated and rendered normally.
PRS_Capturing 
Capture all particle data to the clip specified by ReplayClipIDNumber. The frame to capture

must be specified using the ReplayFrameIndex

PRS_Replaying 
Replay captured particle state from the clip specified by ReplayClipIDNumber. The frame to play

must be specified using the ReplayFrameIndex

Structs[edit]

ParticleEmitterInstance[edit]

(No member variables.)

ParticleEmitterInstanceMotionBlurInfo[edit]

Modifiers: native

Stores motion blur transform info for particles

Object.Map_Mirror{TMap<INT, struct FMeshElementMotionBlurInfo>} ParticleMBInfoMap 
Maps unique particle Id to its motion blur info

ParticleEventCollideData[edit]

Extends: ParticleEventData

Modifiers: native

Collision particle event data.

float ParticleTime 
The particle time at collision.
Object.Vector Normal 
Normal vector in coordinate system of the returner. Zero=none.
float Time 
Time until hit, if line check.
int Item 
Primitive data item which was hit, INDEX_NONE=none.
name BoneName 
Name of bone we hit (for skeletal meshes).

ParticleEventData[edit]

Modifiers: native

The base class for all particle event data.

int Type 
The type of event that was generated.
name EventName 
The name of the event.
float EmitterTime 
The emitter time at the event.
Object.Vector Location 
The location of the event.
Object.Vector Direction 
The direction of the particle at the time of the event.
Object.Vector Velocity 
The velocity at the time of the event.

ParticleEventDeathData[edit]

Extends: ParticleEventData

Modifiers: native

Killed particle event data.

float ParticleTime 
The particle time at its death.

ParticleEventKismetData[edit]

Extends: ParticleEventData

Modifiers: native

Kismet particle event data.

bool UsePSysCompLocation 
If TRUE, use the particle system component location as spawn location.
Object.Vector Normal 
Normal vector in coordinate system of the returner. Zero=none.

ParticleEventSpawnData[edit]

Extends: ParticleEventData

Modifiers: native

Spawn particle event data.

(No new member variables.)

ParticleSysParam[edit]

Modifiers: native

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

name Name 
No UObject reference
EParticleSysParamType ParamType 
float Scalar 
Object.Vector Vector 
Object.Color Color 
Actor Actor 
MaterialInterface Material 

ViewParticleEmitterInstanceMotionBlurInfo[edit]

Modifiers: native

Stores motion blur transform info for emitter instances

Object.Map_Mirror{TMap<const struct FParticleMeshEmitterInstance*, struct FParticleEmitterInstanceMotionBlurInfo>} EmitterInstanceMBInfoMap 
Maps unique emitter instance via ptr to its particle motion blur info

Delegates[edit]

OnSystemFinished[edit]

delegate OnSystemFinished (ParticleSystemComponent PSystem)


Native functions[edit]

ActivateSystem[edit]

native final function ActivateSystem (bool bFlagAsJustAttached)


ClearParameter[edit]

native final function ClearParameter (name ParameterName, optional EParticleSysParamType ParameterType)

clears the specified parameter, returning it to the default value set in the template

Parameters:

  • ParameterName - name of parameter to remove
  • ParameterType - type of parameter to remove; if omitted or PSPT_None is specified, all parameters with the given name are removed

DeactivateSystem[edit]

native final function DeactivateSystem ()


DetermineLODLevelForLocation[edit]

native function int DetermineLODLevelForLocation (Object.Vector EffectLocation)

This will determine which LOD to use based off the specific ParticleSystem passed in and the distance to where that PS is being displayed.

NOTE: This is distance based LOD not perf based. Perf and distance are orthogonal concepts.

GetActorParameter[edit]

native function bool GetActorParameter (const name InName, out Actor OutActor)

Retrieve the Actor parameter value for the given name.

Parameters:

  • InName - Name of the parameter
  • OutActor - The value of the parameter found

Returns:

TRUE Parameter was found - OutActor is valid FALSE Parameter was not found - OutActor is invalid

GetColorParameter[edit]

native function bool GetColorParameter (const name InName, out Object.Color OutColor)

Retrieve the Color parameter value for the given name.

Parameters:

  • InName - Name of the parameter
  • OutColor - The value of the parameter found

Returns:

TRUE Parameter was found - OutColor is valid FALSE Parameter was not found - OutColor is invalid

GetEditorLODLevel[edit]

native final function int GetEditorLODLevel ()


GetFloatParameter[edit]

native function bool GetFloatParameter (const name InName, out float OutFloat)

Retrieve the Float parameter value for the given name.

Parameters:

  • InName - Name of the parameter
  • OutFloat - The value of the parameter found

Returns:

TRUE Parameter was found - OutFloat is valid FALSE Parameter was not found - OutFloat is invalid

GetLODLevel[edit]

native final function int GetLODLevel ()

GetLODLevel - gets the LOD level currently set.

GetMaterialParameter[edit]

native function bool GetMaterialParameter (const name InName, out MaterialInterface OutMaterial)

Retrieve the Material parameter value for the given name.

Parameters:

  • InName - Name of the parameter
  • OutMaterial - The value of the parameter found

Returns:

TRUE Parameter was found - OutMaterial is valid FALSE Parameter was not found - OutMaterial is invalid

GetSkipUpdateDynamicDataDuringTick[edit]

native final function bool GetSkipUpdateDynamicDataDuringTick ()

Function for retrieving the bSkipUpdateDynamicDataDuringTick flag.

GetVectorParameter[edit]

native function bool GetVectorParameter (const name InName, out Object.Vector OutVector)

Retrieve the Vector parameter value for the given name.

Parameters:

  • InName - Name of the parameter
  • OutVector - The value of the parameter found

Returns:

TRUE Parameter was found - OutVector is valid FALSE Parameter was not found - OutVector is invalid

KillParticlesForced[edit]

native final function KillParticlesForced ()


ResetToDefaults[edit]

native final function ResetToDefaults ()

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

RewindEmitterInstance[edit]

native function RewindEmitterInstance (int EmitterIndex)

Rewind emitter instances.

RewindEmitterInstances[edit]

native function RewindEmitterInstances ()


SetActive[edit]

native final function SetActive (bool bNowActive)

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

Parameters:

  • bNowActive - whether the system should be active

SetActorParameter[edit]

native final function SetActorParameter (name ParameterName, Actor Param)


SetBeamDistance[edit]

native function SetBeamDistance (int EmitterIndex, float Distance)

Set the beam distance

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • Distance - The value to set it to

SetBeamEndPoint[edit]

native function SetBeamEndPoint (int EmitterIndex, Object.Vector NewEndPoint)

Set the beam end point

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • NewEndPoint - The value to set it to

SetBeamSourcePoint[edit]

native function SetBeamSourcePoint (int EmitterIndex, Object.Vector NewSourcePoint, int SourceIndex)

Set the beam source point

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • NewSourcePoint - The value to set it to
  • SourceIndex - Which beam within the emitter to set it on

SetBeamSourceStrength[edit]

native function SetBeamSourceStrength (int EmitterIndex, float NewSourceStrength, int SourceIndex)

Set the beam source strength

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • NewSourceStrength - The value to set it to
  • SourceIndex - Which beam within the emitter to set it on

SetBeamSourceTangent[edit]

native function SetBeamSourceTangent (int EmitterIndex, Object.Vector NewTangentPoint, int SourceIndex)

Set the beam source tangent

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • NewTangentPoint - The value to set it to
  • SourceIndex - Which beam within the emitter to set it on

SetBeamTargetPoint[edit]

native function SetBeamTargetPoint (int EmitterIndex, Object.Vector NewTargetPoint, int TargetIndex)

Set the beam target point

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • NewTargetPoint - The value to set it to
  • TargetIndex - Which beam within the emitter to set it on

SetBeamTargetStrength[edit]

native function SetBeamTargetStrength (int EmitterIndex, float NewTargetStrength, int TargetIndex)

Set the beam target strength

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • NewTargetStrength - The value to set it to
  • TargetIndex - Which beam within the emitter to set it on

SetBeamTargetTangent[edit]

native function SetBeamTargetTangent (int EmitterIndex, Object.Vector NewTangentPoint, int TargetIndex)

Set the beam target tangent

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • NewTangentPoint - The value to set it to
  • TargetIndex - Which beam within the emitter to set it on

SetBeamTessellationFactor[edit]

native function SetBeamTessellationFactor (int EmitterIndex, float NewFactor)

Set the beam tessellation factor

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • NewFactor - The value to set it to

SetBeamType[edit]

native function SetBeamType (int EmitterIndex, int NewMethod)

Set the beam type

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • NewMethod - The new method/type of beam to generate

SetColorParameter[edit]

native final function SetColorParameter (name ParameterName, Object.Color Param)


SetEditorLODLevel[edit]

native final function SetEditorLODLevel (int InLODLevel)


SetFloatParameter[edit]

native final function SetFloatParameter (name ParameterName, float Param)


SetKillOnCompleted[edit]

native function SetKillOnCompleted (int EmitterIndex, bool bKill)

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

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • bKill - The value to set it to

SetKillOnDeactivate[edit]

native function SetKillOnDeactivate (int EmitterIndex, bool bKill)

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

Parameters:

  • EmitterIndex - The index of the emitter to set it on
  • bKill - value to set KillOnDeactivate to

SetLODLevel[edit]

native final function SetLODLevel (int InLODLevel)

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

SetMaterialParameter[edit]

native final function SetMaterialParameter (name ParameterName, MaterialInterface Param)


SetSkipUpdateDynamicDataDuringTick[edit]

native final function SetSkipUpdateDynamicDataDuringTick (bool bInSkipUpdateDynamicDataDuringTick)

Function for setting the bSkipUpdateDynamicDataDuringTick flag.

SetStopSpawning[edit]

native final function SetStopSpawning (int InEmitterIndex, bool bInStopSpawning)

Calls SetStopSpawning with the given emitter instance passing in the given value.

Parameters:

  • InEmitterIndex - The index of the emitter instance to call SetHaltSpawning on; -1 for ALL
  • bInStopSpawning - The value to pass into the EmitterInstance SetHaltSpawning call

SetTemplate[edit]

native final function SetTemplate (ParticleSystem NewTemplate)


SetVectorParameter[edit]

native final function SetVectorParameter (name ParameterName, Object.Vector Param)