Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Particles/ParticleModule.h |
Include |
#include "Particles/ParticleModule.h" |
class UParticleModule : public UObject
Name | Description | ||
---|---|---|---|
|
uint8: 1 |
b3DDrawMode |
If true, the module should render its 3D visualization helper |
|
uint8: 1 |
bCurvesAsColor |
If true, the module displays FVector curves as colors |
|
uint8: 1 |
bEditable |
If true, the module has had editing enabled on it |
|
uint8: 1 |
bEnabled |
If true, the module is enabled |
|
uint8: 1 |
bFinalUpdateModule |
If true, the module performs operations on particles during final update |
|
uint8: 1 |
bRequiresLoopingNotification |
If true, the module should be told when looping |
|
uint8: 1 |
bSpawnModule |
If true, the module performs operations on particles during Spawning |
|
uint8: 1 |
bSupported3DDrawMode |
If true, the module supports rendering a 3D visualization helper |
|
uint8: 1 |
bSupportsRandomSeed |
If true, the module supports RandomSeed setting |
|
uint8: 1 |
bUpdateForGPUEmitter |
If true, the module performs operations on particles during update and/or final update for GPU emitters |
|
uint8: 1 |
bUpdateModule |
If true, the module performs operations on particles during Updating |
|
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. |
|
LODValidity |
The LOD levels this module is present in. |
|
|
ModuleEditorColor |
The color to draw the modules curves in the curve editor. |
Name | Description | |
---|---|---|
|
UParticleModule ( |
Name | Description | ||
---|---|---|---|
|
AddModuleCurvesToEditor ( |
Add all curve-editable Objects within this module to the curve editor. |
|
|
AutoPopulateInstanceProperties ( |
Helper function used by the editor to auto-populate a placed AEmitter with any instance parameters that are utilized. |
|
|
CanTickInAnyThread() |
Return false if this emitter requires a game thread tick |
|
|
ChangeEditorColor ( |
Helper function for updating the curve editor when the module editor color changes. |
|
|
CompileModule ( |
Called once to compile the effects of this module on runtime simulation. |
|
|
ConvertFloatDistribution ( |
Store the given percentage of the SourceFloat distribution in the FloatDist |
|
|
ConvertVectorDistribution ( |
Store the given percentage of the SourceVector distribution in the VectorDist |
|
|
EmitterLoopingNotify ( |
Called when an emitter instance is looping... |
|
|
FinalUpdate ( |
Called on an emitter when all other update operations have taken place INCLUDING bounding box cacluations! |
|
|
UParticleMod... |
GenerateLODModule ( |
Generates a new module for LOD levels, setting the values appropriately. |
|
GenerateLODModuleValues ( |
Helper function used by the editor to auto-generate LOD values from a source module and a percentage value used to scale its values. |
|
|
GetCurveObjects ( |
Fill an array with each Object property that fulfills the FCurveEdInterface interface. |
|
|
GetCustomMenuEntryDisplayString |
Get the display name of the custom menu entry. |
|
|
GetDistributionNotAllowedOnGPUText |
Generates the FText to display to the user informing them that a module is using a distribution that is not allowed on GPU emitters. |
|
|
GetDistributionsRestrictedOnGPU |
Gets a list of the names of distributions not allowed on GPU emitters. |
|
|
GetModuleType() |
Retrieve the ModuleType of this module. |
|
|
GetNumberOfCustomMenuOptions() |
Custom Cascade module menu entries support Get the number of custom entries this module has. |
|
|
GetParticleParametersUtilized |
Retrieve the distributions that use ParticleParameters in this module. |
|
|
GetParticleSysParamsUtilized |
Retrieve the ParticleSysParams associated with this module. |
|
|
FParticleRan... |
GetRandomSeedInfo() |
Retrieve the random seed info for this module. |
|
FRandomStrea... |
GetRandomStream ( |
Retreive the random stream that should be used for the provided instance. |
|
IsDisplayedInCurveEd ( |
Are the modules curves displayed in the curve editor? |
|
|
IsDistributionAllowedOnGPU ( |
Checks if a distribution is allowed on the GPU. |
|
|
IsSizeMultiplyLife() |
Returns whether the module is SizeMultipleLife or not. |
|
|
IsUsedInGPUEmitter() |
Returns whether this module is used in any GPU emitters. |
|
|
IsUsedInLODLevel ( |
Returns true if the module validiy flags indicate this module is used in the given LOD level. |
|
|
IsValidForLODLevel ( |
Returns true if the module is valid for the provided LOD level. |
|
|
ModuleHasCurves() |
Does the module contain curves? |
|
|
PerformCustomMenuEntry ( |
Perform the custom menu entry option. |
|
|
PrepPerInstanceBlock ( |
Allows the module to prep its 'per-instance' data block. |
|
|
PrepRandomSeedInstancePayload ( |
Prepare a random seed instance payload... |
|
|
RefreshModule ( |
Refresh the module... |
|
|
RemoveModuleCurvesFromEditor ( |
Remove all curve-editable Objects within this module from the curve editor. |
|
|
Render3DPreview ( |
Render the modules 3D visualization helper primitive. |
|
|
RequiredBytes ( |
Returns the number of bytes that the module requires in the particle payload block. |
|
|
RequiredBytesPerInstance() |
Returns the number of bytes the module requires in the emitters 'per-instance' data block. |
|
|
RequiresLoopingNotification() |
Returns whether the module requires notification when an emitter loops. |
|
|
SetRandomSeedEntry |
Set the random seed info entry at the given index to the given seed |
|
|
SetToSensibleDefaults ( |
For Cascade. |
|
|
SetTransactionFlag() |
Set the transaction flag on the module and any members which require it |
|
|
Spawn ( |
Called on a particle that is freshly spawned by the emitter. |
|
|
SupportsRandomSeed() |
Returns whether the module supports the RandomSeed functionality |
|
|
TouchesMeshRotation() |
Return true if this module impacts rotation of Mesh emitters |
|
|
Update ( |
Called on a particle that is being updated by its emitter. |
|
|
WillGeneratedModuleBeIdentical ( |
Returns true if the results of LOD generation for the given percentage will result in a duplicate of the module. |
Name | Description | ||
---|---|---|---|
|
IsPostLoadThreadSafe() |
Called during async load to determine if PostLoad can be called on the loading thread. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostLoadSubobjects ( |
Instances components for objects being loaded from disk, if necessary. |