Skip to content

ParticleSystemComponent

Class in Engine · Engine.ParticleSystemComponent · native, editinlinenew

Object › Component › ActorComponent › PrimitiveComponent › ParticleSystemComponent

Using it from Lua
h7.find_all("ParticleSystemComponent")            -- live instances
h7.find_class("Engine.ParticleSystemComponent")   -- the class
h7.hook("Engine.ParticleSystemComponent.ActivateSystem", fn)

Enums

EParticleEventType

EPET_Any = 0, EPET_Spawn = 1, EPET_Death = 2, EPET_Collision = 3, EPET_WorldAttractorCollision = 4, EPET_Kismet = 5

EParticleSysParamType

PSPT_None = 0, PSPT_Scalar = 1, PSPT_ScalarRand = 2, PSPT_Vector = 3, PSPT_VectorRand = 4, PSPT_Color = 5, PSPT_Actor = 6, PSPT_Material = 7

ParticleReplayState

PRS_Disabled = 0, PRS_Capturing = 1, PRS_Replaying = 2

Structs

ParticleEmitterInstance

ParticleEmitterInstanceMotionBlurInfo

FieldType
ParticleMBInfoMapMap_Mirror

ParticleEventAttractorCollideData

Struct extends ParticleEventCollideData

ParticleEventCollideData

Struct extends ParticleEventData

FieldType
ParticleTimefloat
Normalvector
Timefloat
Itemint
BoneNamename

ParticleEventData

FieldType
Typeint
EventNamename
EmitterTimefloat
Locationvector
Directionvector
Velocityvector

ParticleEventDeathData

Struct extends ParticleEventData

FieldType
ParticleTimefloat

ParticleEventKismetData

Struct extends ParticleEventData

FieldType
UsePSysCompLocationbool
Normalvector

ParticleEventSpawnData

Struct extends ParticleEventData

ParticleSysParam

FieldType
Namename
ParamTypeEParticleSysParamType
Scalarfloat
Scalar_Lowfloat
Vectorvector
Vector_Lowvector
Colorcolor
Actoractor
MaterialMaterialInterface

ViewParticleEmitterInstanceMotionBlurInfo

FieldType
EmitterInstanceMBInfoMapMap_Mirror

Properties

NameTypeNotes
AccumLODDistanceCheckTimefloattransient
AccumTickTimefloattransient
AttractorCollisionEventsarray<ParticleEventAttractorCollideData>transient
bAutoActivatebool
bDeferredBeamUpdatebool
bForcedInActivebooltransient
bHasBeenActivatedbooltransient
bIsActivebooltransient
bIsCachedInPoolbool
bIsViewRelevanceDirtybooltransient
bIsWarmingUpbooltransient
bJustAttachedbooltransient
bLODUpdatePendingbooltransient
bOverrideLODMethodbool
bRecacheViewRelevancebooltransient
bResetOnDetachbool
bSkipBoundsUpdatebool
bSkipSpawnCountCheckbooltransient
bSkipUpdateDynamicDataDuringTickbool
bSuppressSpawningboolconst, transient
bUpdateComponentInTickbool
bUpdateOnDedicatedServerbool
bWarmingUpbool
bWasCompletedboolconst, transient
bWasDeactivatedboolconst, transient
CachedViewRelevanceFlagsarray<MaterialViewRelevance>const, transient
CollisionEventsarray<ParticleEventCollideData>transient
CustomTimeDilationfloat
DeathEventsarray<ParticleEventDeathData>transient
EditorDetailModeint
EditorLODLevelint
EmitterDelayfloattransient
EmitterInstancesarrayconst, transient, native
InstanceParametersarray<ParticleSysParam>
KismetEventsarray<ParticleEventKismetData>transient
LightEnvironmentClassclass<ParticleLightEnvironmentComponent>
LightEnvironmentSharedInstigatorActortransient
LODLevelinttransient, private
LODMethodParticleSystemLODMethod
MaxLightEnvironmentPooledReusesinttransient
MaxTimeBeforeForceUpdateTransformfloat
OldPositionvector
PartSysVelocityvector
ReleaseResourcesFencepointerconst, transient, native
ReplayClipIDNumberintconst, transient
ReplayClipsarray<ParticleSystemReplay>const
ReplayFrameIndexintconst, transient
ReplayStateParticleReplayStateconst, transient
SecondsBeforeInactivefloat
SkelMeshComponentsarray<SkeletalMeshComponent>const, transient, private
SMComponentsarray<StaticMeshComponent>const, transient, private
SMMaterialInterfacesarray<MaterialInterface>const, transient, private
SpawnEventsarray<ParticleEventSpawnData>transient
TemplateParticleSystemconst
TimeSinceLastForceUpdateTransformfloattransient, private
ViewMBInfoArrayarray<ViewParticleEmitterInstanceMotionBlurInfo>const, transient, native
WarmupTickRatefloat
WarmupTimefloat

Functions

NameDeclaration
ActivateSystemfinal native function ActivateSystem(bool bFlagAsJustAttached = false)
AddUniqueEditorSkelMeshCompfunction AddUniqueEditorSkelMeshComp(Component comp) (no declaration: types are approximate)
CleanupEmittersfunction CleanupEmitters() (no declaration: types are approximate)
ClearParameterfinal native function ClearParameter(name ParameterName, optional EParticleSysParamType ParameterType)
DeactivateSystemfinal native function DeactivateSystem()
DetermineLODLevelForLocationnative function int DetermineLODLevelForLocation(const out vector EffectLocation)
GetActorParameternative function bool GetActorParameter(const name InName, out actor OutActor)
GetColorParameternative function bool GetColorParameter(const name InName, out color OutColor)
GetEditorLODLevelfinal native function int GetEditorLODLevel()
GetFloatParameternative function bool GetFloatParameter(const name InName, out float OutFloat)
GetLODLevelfinal native function int GetLODLevel()
GetMaterialParameternative function bool GetMaterialParameter(const name InName, out MaterialInterface OutMaterial)
GetMaxLifespannative function float GetMaxLifespan()
GetSkipBoundsUpdatefinal native function bool GetSkipBoundsUpdate()
GetSkipUpdateDynamicDataDuringTickfinal native function bool GetSkipUpdateDynamicDataDuringTick()
GetVectorParameternative function bool GetVectorParameter(const name InName, out vector OutVector)
KillParticlesForcedfinal native function KillParticlesForced()
KillParticlesInEmitterfinal native function KillParticlesInEmitter(name InEmitterName)
OnSystemFinisheddelegate OnSystemFinished(ParticleSystemComponent PSystem)
ResetToDefaultsfinal native function ResetToDefaults()
RewindEmitterInstancenative function RewindEmitterInstance(int EmitterIndex)
RewindEmitterInstancesnative function RewindEmitterInstances()
SetActivefinal native function SetActive(bool bNowActive, optional bool bFlagAsJustAttached)
SetActorParameterfinal native function SetActorParameter(name ParameterName, actor Param)
SetBeamDistancenative function SetBeamDistance(int EmitterIndex, float Distance)
SetBeamEndPointnative function SetBeamEndPoint(int EmitterIndex, vector NewEndPoint)
SetBeamSourcePointnative function SetBeamSourcePoint(int EmitterIndex, vector NewSourcePoint, int SourceIndex)
SetBeamSourceStrengthnative function SetBeamSourceStrength(int EmitterIndex, float NewSourceStrength, int SourceIndex)
SetBeamSourceTangentnative function SetBeamSourceTangent(int EmitterIndex, vector NewTangentPoint, int SourceIndex)
SetBeamTargetPointnative function SetBeamTargetPoint(int EmitterIndex, vector NewTargetPoint, int TargetIndex)
SetBeamTargetStrengthnative function SetBeamTargetStrength(int EmitterIndex, float NewTargetStrength, int TargetIndex)
SetBeamTargetTangentnative function SetBeamTargetTangent(int EmitterIndex, vector NewTangentPoint, int TargetIndex)
SetBeamTessellationFactornative function SetBeamTessellationFactor(int EmitterIndex, float NewFactor)
SetBeamTypenative function SetBeamType(int EmitterIndex, int NewMethod)
SetColorParameterfinal native function SetColorParameter(name ParameterName, color Param)
SetEditorLODLevelfinal native function SetEditorLODLevel(int InLODLevel)
SetFloatParameterfinal native function SetFloatParameter(name ParameterName, float Param)
SetFloatRandParameterfinal native function SetFloatRandParameter(name ParameterName, float Param, float ParamLow)
SetKillOnCompletednative function SetKillOnCompleted(int EmitterIndex, bool bKill)
SetKillOnDeactivatenative function SetKillOnDeactivate(int EmitterIndex, bool bKill)
SetLODLevelfinal native function SetLODLevel(int InLODLevel)
SetMaterialParameterfinal native function SetMaterialParameter(name ParameterName, MaterialInterface Param)
SetSkipBoundsUpdatefinal native function SetSkipBoundsUpdate(bool bInSkipBoundsUpdate)
SetSkipUpdateDynamicDataDuringTickfinal native function SetSkipUpdateDynamicDataDuringTick(bool bInSkipUpdateDynamicDataDuringTick)
SetStopSpawningfinal native function SetStopSpawning(int InEmitterIndex, bool bInStopSpawning)
SetTemplatefinal native function SetTemplate(ParticleSystem NewTemplate)
SetVectorParameterfinal native function SetVectorParameter(name ParameterName, vector Param)
SetVectorRandParameterfinal native function SetVectorRandParameter(name ParameterName, const out vector Param, const out vector ParamLow)
SystemHasCompletednative function bool SystemHasCompleted()

Default values

LightEnvironmentClass=class'ParticleLightEnvironmentComponent'
MaxLightEnvironmentPooledReuses=10
bTickInEditor=true
MaxTimeBeforeForceUpdateTransform=5
bAutoActivate=true
bResetOnDetach=false
OldPosition=(X=0,Y=0,Z=0)
PartSysVelocity=(X=0,Y=0,Z=0)
WarmupTime=0
SecondsBeforeInactive=1.0
bSkipUpdateDynamicDataDuringTick=false
TickGroup=TG_DuringAsyncWork
bIsViewRelevanceDirty=true
CustomTimeDilation=1.f
EditorDetailMode=-1

Inherited

FromMembers
PrimitiveComponent107 properties, 46 functions
ActorComponent7 properties, 4 functions
Component2 properties, 0 functions
Object13 properties, 308 functions