1. Epic GamesDeveloper
  3. UParticleModule

UParticleModule

Unreal Engine C++ API Reference > Runtime > Engine > Particles

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Particles/ParticleModule.h
Include #include "Particles/ParticleModule.h"

Syntax

class UParticleModule : public UObject

Variables

  Type Name Description
Public variable uint8: 1 b3DDrawMode If true, the module should render its 3D visualization helper
Public variable uint8: 1 bCurvesAsColor If true, the module displays FVector curves as colors
Public variable uint8: 1 bEditable If true, the module has had editing enabled on it
Public variable uint8: 1 bEnabled If true, the module is enabled
Public variable uint8: 1 bFinalUpdateModule If true, the module performs operations on particles during final update
Public variable uint8: 1 bRequiresLoopingNotification If true, the module should be told when looping
Public variable uint8: 1 bSpawnModule If true, the module performs operations on particles during Spawning
Public variable uint8: 1 bSupported3DDrawMode If true, the module supports rendering a 3D visualization helper
Public variable uint8: 1 bSupportsRandomSeed If true, the module supports RandomSeed setting
Public variable uint8: 1 bUpdateForGPUEmitter If true, the module performs operations on particles during update and/or final update for GPU emitters
Public variable uint8: 1 bUpdateModule If true, the module performs operations on particles during Updating
Public variable uint8: 1 LODDuplicate If true, this flag indicates that auto-generation for LOD will result in an exact duplicate of the module, regardless of the percentage.
Public variable uint8 LODValidity The LOD levels this module is present in.
Public variable FColor ModuleEditorColor The color to draw the modules curves in the curve editor.

Constructors

  Type Name Description
Public function  

UParticleModule ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual bool

AddModuleCurvesToEditor ( UInterpCurveEdSetup* EdSetup,
TArray< const FCurveEdEntry* >& OutCurveEntries
)

 Add all curve-editable Objects within this module to the curve editor.
Public function Virtual void Helper function used by the editor to auto-populate a placed AEmitter with any instance parameters that are utilized.
Public function Virtual bool Return false if this emitter requires a game thread tick
Public function void Helper function for updating the curve editor when the module editor color changes.
Public function Virtual void Called once to compile the effects of this module on runtime simulation.
Public function Virtual bool

ConvertFloatDistribution ( UDistributionFloat* FloatDist,
UDistributionFloat* SourceFloatDist,
float Percentage
)

 Store the given percentage of the SourceFloat distribution in the FloatDist
Public function Virtual bool

ConvertVectorDistribution ( UDistributionVector* VectorDist,
UDistributionVector* SourceVectorDist,
float Percentage
)

 Store the given percentage of the SourceVector distribution in the VectorDist
Public function Virtual void Called when an emitter instance is looping...
Public function Virtual void

FinalUpdate ( FParticleEmitterInstance* Owner,
int32 Offset,
float DeltaTime
)

 Called on an emitter when all other update operations have taken place INCLUDING bounding box cacluations!
Public function Virtual UParticleModule *

GenerateLODModule ( UParticleLODLevel* SourceLODLevel,
UParticleLODLevel* DestLODLevel,
float Percentage,
bool bGenerateModuleData,
bool bForceModuleConstruction
)

 Generates a new module for LOD levels, setting the values appropriately.
Public function Virtual bool

GenerateLODModuleValues ( UParticleModule* SourceModule,
float Percentage,
UParticleLODLevel* LODLevel
)

 Helper function used by the editor to auto-generate LOD values from a source module and a percentage value used to scale its values.
Public function Virtual void Fill an array with each Object property that fulfills the FCurveEdInterface interface.
Public function Virtual Const bool

GetCustomMenuEntryDisplayString ( int32 InEntryIndex,
FString& OutDisplayString
)

 Get the display name of the custom menu entry.
Public function Static FText

GetDistributionNotAllowedOnGPUText ( const FString& ModuleName,
const FString& PropertyName
)

 Generates the FText to display to the user informing them that a module is using a distribution that is not allowed on GPU emitters.
Public function Static void

GetDistributionsRestrictedOnGPU ( TArray< FString >& OutRestrictedDistributions
)

 Gets a list of the names of distributions not allowed on GPU emitters.
Public function Virtual Const EModuleType Retrieve the ModuleType of this module.
Public function Virtual Const int32 Custom Cascade module menu entries support Get the number of custom entries this module has.
Public function Virtual void

GetParticleParametersUtilized ( TArray< FString >& ParticleParameterList
)

 Retrieve the distributions that use ParticleParameters in this module.
Public function Virtual void

GetParticleSysParamsUtilized ( TArray< FString >& ParticleSysParamList
)

 Retrieve the ParticleSysParams associated with this module.
Public function Virtual FParticleRandomSeedInfo * Retrieve the random seed info for this module.
Public function FRandomStream & Retreive the random stream that should be used for the provided instance.
Public function bool Are the modules curves displayed in the curve editor?
Public function Static bool

IsDistributionAllowedOnGPU ( const UDistribution* Distribution
)

 Checks if a distribution is allowed on the GPU.
Public function Virtual bool Returns whether the module is SizeMultipleLife or not.
Public function Const bool Returns whether this module is used in any GPU emitters.
Public function Virtual Const bool

IsUsedInLODLevel ( int32 SourceLODIndex
)

 Returns true if the module validiy flags indicate this module is used in the given LOD level.
Public function Virtual bool

IsValidForLODLevel ( UParticleLODLevel* LODLevel,
FString& OutErrorString
)

 Returns true if the module is valid for the provided LOD level.
Public function bool Does the module contain curves?
Public function Virtual bool

PerformCustomMenuEntry ( int32 InEntryIndex
)

 Perform the custom menu entry option.
Public function Virtual uint32

PrepPerInstanceBlock ( FParticleEmitterInstance* Owner,
void* InstData
)

 Allows the module to prep its 'per-instance' data block.
Public function Virtual uint32 Prepare a random seed instance payload...
Public function Virtual void

RefreshModule ( UInterpCurveEdSetup* EdSetup,
UParticleEmitter* InEmitter,
int32 InLODLevel
)

 Refresh the module...
Public function void Remove all curve-editable Objects within this module from the curve editor.
Public function Virtual void Render the modules 3D visualization helper primitive.
Public function Virtual uint32 Returns the number of bytes that the module requires in the particle payload block.
Public function Virtual uint32 Returns the number of bytes the module requires in the emitters 'per-instance' data block.
Public function Const bool Returns whether the module requires notification when an emitter loops.
Public function Virtual bool

SetRandomSeedEntry ( int32 InIndex,
int32 InRandomSeed
)

 Set the random seed info entry at the given index to the given seed
Public function Virtual void For Cascade.
Public function void Set the transaction flag on the module and any members which require it
Public function Virtual void

Spawn ( FParticleEmitterInstance* Owner,
int32 Offset,
float SpawnTime,
FBaseParticle* ParticleBase
)

 Called on a particle that is freshly spawned by the emitter.
Public function Const bool Returns whether the module supports the RandomSeed functionality
Public function Virtual Const bool Return true if this module impacts rotation of Mesh emitters
Public function Virtual void

Update ( FParticleEmitterInstance* Owner,
int32 Offset,
float DeltaTime
)

 Called on a particle that is being updated by its emitter.
Public function Virtual bool

WillGeneratedModuleBeIdentical ( UParticleLODLevel* SourceLODLevel,
UParticleLODLevel* DestLODLevel,
float Percentage
)

 Returns true if the results of LOD generation for the given percentage will result in a duplicate of the module.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void

PostLoadSubobjects ( FObjectInstancingGraph* OuterInstanceGraph
)

 Instances components for objects being loaded from disk, if necessary.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page