Class ParticleSystemComponent

A particle emitter.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
PrimitiveComponent
ParticleSystemComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class ParticleSystemComponent : PrimitiveComponent

Properties

| Improve this Doc View Source

AutoAttachSocketName

Socket we automatically attach to on the AutoAttachParent, if bAutoManageAttachment is true.

Declaration
public Name AutoAttachSocketName { get; set; }
Property Value
Type Description
Name
Remarks

@see bAutoManageAttachment

| Improve this Doc View Source

bAllowRecycling

Declaration
public bool bAllowRecycling { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bAutoManageAttachment

Declaration
public bool bAutoManageAttachment { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bOverrideLODMethod

Declaration
public bool bOverrideLODMethod { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bResetOnDetach

Declaration
public bool bResetOnDetach { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bSkipUpdateDynamicDataDuringTick

Declaration
public bool bSkipUpdateDynamicDataDuringTick { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bUpdateOnDedicatedServer

Declaration
public bool bUpdateOnDedicatedServer { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bWarmingUp

Declaration
public bool bWarmingUp { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CustomTimeDilation

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

Declaration
public float CustomTimeDilation { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static ParticleSystemComponent DefaultObject { get; }
Property Value
Type Description
ParticleSystemComponent
| Improve this Doc View Source

EditorDetailMode

Used for applying Cascade's detail mode setting to in-level particle systems

Declaration
public int EditorDetailMode { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

EditorLODLevel

INTERNAL. Used by the editor to set the LODLevel

Declaration
public int EditorLODLevel { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

EmitterMaterials

Emitter Materials

Declaration
public ObjectArrayField<MaterialInterface> EmitterMaterials { get; }
Property Value
Type Description
ObjectArrayField<MaterialInterface>
| Improve this Doc View Source

LODMethod

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

Declaration
public byte LODMethod { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

MaxTimeBeforeForceUpdateTransform

Time between forced UpdateTransforms for systems that use dynamically calculated bounds, Which is effectively how often the bounds are shrunk.

Declaration
public float MaxTimeBeforeForceUpdateTransform { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

OldPosition

Old Position

Declaration
public Vector OldPosition { get; set; }
Property Value
Type Description
Vector
| Improve this Doc View Source

PartSysVelocity

Part Sys Velocity

Declaration
public Vector PartSysVelocity { get; set; }
Property Value
Type Description
Vector
| Improve this Doc View Source

ReplayClips

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!

Declaration
public ObjectArrayField<ParticleSystemReplay> ReplayClips { get; }
Property Value
Type Description
ObjectArrayField<ParticleSystemReplay>
| Improve this Doc View Source

SecondsBeforeInactive

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

Declaration
public float SecondsBeforeInactive { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

SkelMeshComponents

The skeletal mesh components used with the socket location module.

Declaration
public ObjectArrayField<SkeletalMeshComponent> SkelMeshComponents { get; }
Property Value
Type Description
ObjectArrayField<SkeletalMeshComponent>
Remarks

This is to prevent them from being garbage collected.

| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

Template

Template

Declaration
public ParticleSystem Template { get; }
Property Value
Type Description
ParticleSystem
| Improve this Doc View Source

WarmupTickRate

Warmup Tick Rate

Declaration
public float WarmupTickRate { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

WarmupTime

Warmup Time

Declaration
public float WarmupTime { get; set; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

BeginTrails(Name, Name, Byte, Single)

Begins all trail emitters in this component.

Declaration
public void BeginTrails(Name InFirstSocketName, Name InSecondSocketName, byte InWidthMode, float InWidth)
Parameters
Type Name Description
Name InFirstSocketName
Name InSecondSocketName
System.Byte InWidthMode
System.Single InWidth
Remarks

@param InFirstSocketName The name of the first socket for the trail. @param InSecondSocketName The name of the second socket for the trail. @param InWidthMode How the width value is applied to the trail. @param InWidth The width of the trail.

| Improve this Doc View Source

CreateNamedDynamicMaterialInstance(Name, MaterialInterface)

Creates a Dynamic Material Instance for the specified named material override, optionally from the supplied material.

Declaration
public MaterialInstanceDynamic CreateNamedDynamicMaterialInstance(Name InName, MaterialInterface SourceMaterial)
Parameters
Type Name Description
Name InName
MaterialInterface SourceMaterial
Returns
Type Description
MaterialInstanceDynamic
Remarks

@param Name - The slot name of the material to replace. If invalid, the material is unchanged and NULL is returned.

| Improve this Doc View Source

EndTrails()

Ends all trail emitters in this component.

Declaration
public void EndTrails()
| Improve this Doc View Source

GenerateParticleEvent(Name, Single, Vector, Vector, Vector)

Record a kismet event.

Declaration
public void GenerateParticleEvent(Name InEventName, float InEmitterTime, Vector InLocation, Vector InDirection, Vector InVelocity)
Parameters
Type Name Description
Name InEventName
System.Single InEmitterTime
Vector InLocation
Vector InDirection
Vector InVelocity
Remarks

@param InEventName The name of the event that fired. @param InEmitterTime The emitter time when the event fired. @param InLocation The location of the particle when the event fired. @param InVelocity The velocity of the particle when the event fired. @param InNormal Normal vector of the collision in coordinate system of the returner. Zero=none.

| Improve this Doc View Source

GetBeamEndPoint(Int32)

Get the beam end point @

Declaration
public (Vector, bool) GetBeamEndPoint(int EmitterIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
Returns
Type Description
System.ValueTuple<Vector, System.Boolean>
Remarks

param EmitterIndex The index of the emitter to get the value of

@return true EmitterIndex is valid and End point is set - OutEndPoint is valid false EmitterIndex invalid or End point is not set - OutEndPoint is invalid

| Improve this Doc View Source

GetBeamSourcePoint(Int32, Int32)

Get the beam source point @

Declaration
public (Vector, bool) GetBeamSourcePoint(int EmitterIndex, int SourceIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
System.Int32 SourceIndex
Returns
Type Description
System.ValueTuple<Vector, System.Boolean>
Remarks

param EmitterIndex The index of the emitter to get @param SourceIndex Which beam within the emitter to get @param OutSourcePoint Value of source point

@return true EmitterIndex and SourceIndex are valid - OutSourcePoint is valid false EmitterIndex or SourceIndex is invalid - OutSourcePoint is invalid

| Improve this Doc View Source

GetBeamSourceStrength(Int32, Int32)

Get the beam source strength @

Declaration
public (float, bool) GetBeamSourceStrength(int EmitterIndex, int SourceIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
System.Int32 SourceIndex
Returns
Type Description
System.ValueTuple<System.Single, System.Boolean>
Remarks

param EmitterIndex The index of the emitter to get @param SourceIndex Which beam within the emitter to get @param OutSourceStrength Value of source tangent

@return true EmitterIndex and SourceIndex are valid - OutSourceStrength is valid false EmitterIndex or SourceIndex is invalid - OutSourceStrength is invalid

| Improve this Doc View Source

GetBeamSourceTangent(Int32, Int32)

Get the beam source tangent @

Declaration
public (Vector, bool) GetBeamSourceTangent(int EmitterIndex, int SourceIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
System.Int32 SourceIndex
Returns
Type Description
System.ValueTuple<Vector, System.Boolean>
Remarks

param EmitterIndex The index of the emitter to get @param SourceIndex Which beam within the emitter to get @param OutTangentPoint Value of source tangent

@return true EmitterIndex and SourceIndex are valid - OutTangentPoint is valid false EmitterIndex or SourceIndex is invalid - OutTangentPoint is invalid

| Improve this Doc View Source

GetBeamTargetPoint(Int32, Int32)

Get the beam target point @

Declaration
public (Vector, bool) GetBeamTargetPoint(int EmitterIndex, int TargetIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
System.Int32 TargetIndex
Returns
Type Description
System.ValueTuple<Vector, System.Boolean>
Remarks

param EmitterIndex The index of the emitter to get @param TargetIndex Which beam within the emitter to get @param OutTargetPoint Value of target point

@return true EmitterIndex and TargetIndex are valid - OutTargetPoint is valid false EmitterIndex or TargetIndex is invalid - OutTargetPoint is invalid

| Improve this Doc View Source

GetBeamTargetStrength(Int32, Int32)

Get the beam target strength @

Declaration
public (float, bool) GetBeamTargetStrength(int EmitterIndex, int TargetIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
System.Int32 TargetIndex
Returns
Type Description
System.ValueTuple<System.Single, System.Boolean>
Remarks

param EmitterIndex The index of the emitter to get @param TargetIndex Which beam within the emitter to get @param OutTargetStrength Value of target tangent

@return true EmitterIndex and TargetIndex are valid - OutTargetStrength is valid false EmitterIndex or TargetIndex is invalid - OutTargetStrength is invalid

| Improve this Doc View Source

GetBeamTargetTangent(Int32, Int32)

Get the beam target tangent @

Declaration
public (Vector, bool) GetBeamTargetTangent(int EmitterIndex, int TargetIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
System.Int32 TargetIndex
Returns
Type Description
System.ValueTuple<Vector, System.Boolean>
Remarks

param EmitterIndex The index of the emitter to get @param TargetIndex Which beam within the emitter to get @param OutTangentPoint Value of target tangent

@return true EmitterIndex and TargetIndex are valid - OutTangentPoint is valid false EmitterIndex or TargetIndex is invalid - OutTangentPoint is invalid

| Improve this Doc View Source

GetNamedMaterial(Name)

Returns a named material. If this named material is not found, returns NULL.

Declaration
public MaterialInterface GetNamedMaterial(Name InName)
Parameters
Type Name Description
Name InName
Returns
Type Description
MaterialInterface
| Improve this Doc View Source

GetNumActiveParticles()

Get the current number of active particles in this system

Declaration
public int GetNumActiveParticles()
Returns
Type Description
System.Int32
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static ParticleSystemComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
ParticleSystemComponent
| Improve this Doc View Source

ReleaseToPool()

Deactivates this system and releases it to the pool on completion.

Declaration
public void ReleaseToPool()
Remarks

Usage of this PSC reference after this call is unsafe. You should clear out your references to it.

| Improve this Doc View Source

SetActorParameter(Name, Actor)

Set a named actor instance parameter on this ParticleSystemComponent.

Declaration
public void SetActorParameter(Name ParameterName, Actor Param)
Parameters
Type Name Description
Name ParameterName
Actor Param
Remarks

Updates the parameter if it already exists, or creates a new entry if not.

| Improve this Doc View Source

SetAutoAttachmentParameters(SceneComponent, Name, EAttachmentRule, EAttachmentRule, EAttachmentRule)

Set AutoAttachParent, AutoAttachSocketName, AutoAttachLocationRule, AutoAttachRotationRule, AutoAttachScaleRule to the specified parameters.

Declaration
public void SetAutoAttachmentParameters(SceneComponent Parent, Name SocketName, EAttachmentRule LocationRule, EAttachmentRule RotationRule, EAttachmentRule ScaleRule)
Parameters
Type Name Description
SceneComponent Parent
Name SocketName
EAttachmentRule LocationRule
EAttachmentRule RotationRule
EAttachmentRule ScaleRule
Remarks

Does not change bAutoManageAttachment; that must be set separately. @param Parent Component to attach to. @param SocketName Socket on Parent to attach to. @param LocationRule Option for how we handle our location when we attach to Parent. @param RotationRule Option for how we handle our rotation when we attach to Parent. @param ScaleRule Option for how we handle our scale when we attach to Parent. @see bAutoManageAttachment, AutoAttachParent, AutoAttachSocketName, AutoAttachLocationRule, AutoAttachRotationRule, AutoAttachScaleRule

| Improve this Doc View Source

SetAutoAttachParams(SceneComponent, Name, Byte)

DEPRECATED: Set AutoAttachParent, AutoAttachSocketName, AutoAttachLocationType to the specified parameters.

Declaration
public void SetAutoAttachParams(SceneComponent Parent, Name SocketName, byte LocationType)
Parameters
Type Name Description
SceneComponent Parent
Name SocketName
System.Byte LocationType
Remarks

Does not change bAutoManageAttachment; that must be set separately. @param Parent Component to attach to. @param SocketName Socket on Parent to attach to. @param LocationType Option for how we handle our location when we attach to Parent. @see bAutoManageAttachment, AutoAttachParent, AutoAttachSocketName, AutoAttachLocationType

| Improve this Doc View Source

SetBeamEndPoint(Int32, Vector)

Set the beam end point @

Declaration
public void SetBeamEndPoint(int EmitterIndex, Vector NewEndPoint)
Parameters
Type Name Description
System.Int32 EmitterIndex
Vector NewEndPoint
Remarks

param EmitterIndex The index of the emitter to set it on @param NewEndPoint The value to set it to

| Improve this Doc View Source

SetBeamSourcePoint(Int32, Vector, Int32)

Set the beam source point @

Declaration
public void SetBeamSourcePoint(int EmitterIndex, Vector NewSourcePoint, int SourceIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
Vector NewSourcePoint
System.Int32 SourceIndex
Remarks

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

| Improve this Doc View Source

SetBeamSourceStrength(Int32, Single, Int32)

Set the beam source strength @

Declaration
public void SetBeamSourceStrength(int EmitterIndex, float NewSourceStrength, int SourceIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
System.Single NewSourceStrength
System.Int32 SourceIndex
Remarks

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

| Improve this Doc View Source

SetBeamSourceTangent(Int32, Vector, Int32)

Set the beam source tangent @

Declaration
public void SetBeamSourceTangent(int EmitterIndex, Vector NewTangentPoint, int SourceIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
Vector NewTangentPoint
System.Int32 SourceIndex
Remarks

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

| Improve this Doc View Source

SetBeamTargetPoint(Int32, Vector, Int32)

Set the beam target point @

Declaration
public void SetBeamTargetPoint(int EmitterIndex, Vector NewTargetPoint, int TargetIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
Vector NewTargetPoint
System.Int32 TargetIndex
Remarks

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

| Improve this Doc View Source

SetBeamTargetStrength(Int32, Single, Int32)

Set the beam target strength @

Declaration
public void SetBeamTargetStrength(int EmitterIndex, float NewTargetStrength, int TargetIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
System.Single NewTargetStrength
System.Int32 TargetIndex
Remarks

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

| Improve this Doc View Source

SetBeamTargetTangent(Int32, Vector, Int32)

Set the beam target tangent @

Declaration
public void SetBeamTargetTangent(int EmitterIndex, Vector NewTangentPoint, int TargetIndex)
Parameters
Type Name Description
System.Int32 EmitterIndex
Vector NewTangentPoint
System.Int32 TargetIndex
Remarks

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

| Improve this Doc View Source

SetColorParameter(Name, LinearColor)

Set a named color instance parameter on this ParticleSystemComponent.

Declaration
public void SetColorParameter(Name ParameterName, LinearColor Param)
Parameters
Type Name Description
Name ParameterName
LinearColor Param
Remarks

Updates the parameter if it already exists, or creates a new entry if not.

| Improve this Doc View Source

SetEmitterEnable(Name, Boolean)

Enables/Disables a sub-emitter @

Declaration
public void SetEmitterEnable(Name EmitterName, bool bNewEnableState)
Parameters
Type Name Description
Name EmitterName
System.Boolean bNewEnableState
Remarks

param EmitterName The name of the sub-emitter to set it on @param bNewEnableState The value to set it to

| Improve this Doc View Source

SetFloatParameter(Name, Single)

Change a named float parameter

Declaration
public void SetFloatParameter(Name ParameterName, float Param)
Parameters
Type Name Description
Name ParameterName
System.Single Param
| Improve this Doc View Source

SetMaterialParameter(Name, MaterialInterface)

Set a named material instance parameter on this ParticleSystemComponent.

Declaration
public void SetMaterialParameter(Name ParameterName, MaterialInterface Param)
Parameters
Type Name Description
Name ParameterName
MaterialInterface Param
Remarks

Updates the parameter if it already exists, or creates a new entry if not.

| Improve this Doc View Source

SetTemplate(ParticleSystem)

Change the ParticleSystem used by this ParticleSystemComponent

Declaration
public void SetTemplate(ParticleSystem NewTemplate)
Parameters
Type Name Description
ParticleSystem NewTemplate
| Improve this Doc View Source

SetTrailSourceData(Name, Name, Byte, Single)

Sets the defining data for all trails in this component.

Declaration
public void SetTrailSourceData(Name InFirstSocketName, Name InSecondSocketName, byte InWidthMode, float InWidth)
Parameters
Type Name Description
Name InFirstSocketName
Name InSecondSocketName
System.Byte InWidthMode
System.Single InWidth
Remarks

@param InFirstSocketName The name of the first socket for the trail. @param InSecondSocketName The name of the second socket for the trail. @param InWidthMode How the width value is applied to the trail. @param InWidth The width of the trail.

| Improve this Doc View Source

SetVectorParameter(Name, Vector)

Set a named vector instance parameter on this ParticleSystemComponent.

Declaration
public void SetVectorParameter(Name ParameterName, Vector Param)
Parameters
Type Name Description
Name ParameterName
Vector Param
Remarks

Updates the parameter if it already exists, or creates a new entry if not.

Operators

| Improve this Doc View Source

Implicit(IntPtr to ParticleSystemComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator ParticleSystemComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
ParticleSystemComponent