1. Epic GamesDeveloper
  3. UParticleModuleRequired

UParticleModuleRequired

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Particles

Inheritance Hierarchy

References

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

Syntax

UCLASS (EditInlineNew, HideCategories=(Object, Cascade), Meta=(DisplayName="Required"), MinimalAPI)  
class UParticleModuleRequired : public UParticleModule

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta float AlphaThreshold Alpha channel values larger than the threshold are considered occupied and will be contained in the bounding geometry.
Public variable UProperty Category, EditAnywhere uint8: 1 bDelayFirstLoopOnly If true, the emitter will be delayed only on the first loop.
Public variable UProperty Category, EditAnywhere uint8: 1 bDurationRecalcEachLoop If true, recalculate the emitter duration on each loop.
Public variable UProperty Category, EditAnywhere uint8: 1 bEmitterDelayUseRange If true, select the emitter delay from the range [EmitterDelayLow..EmitterDelay]
Public variable UProperty Category, EditAnywhere uint8: 1 bEmitterDurationUseRange If true, select the emitter duration from the range [EmitterDurationLow..EmitterDuration]
Public variable UProperty Category, EditAnywhere uint8: 1 bKillOnCompleted If true, kill the emitter when it completes
Public variable UProperty Category, EditAnywhere uint8: 1 bKillOnDeactivate If true, kill the emitter when the particle system is deactivated
Public variable UProperty Category, EditAnywhere uint8: 1 bOrbitModuleAffectsVelocityAlignment Ensures that movement generated from the orbit module is applied to velocity-aligned particles
Public variable UProperty Category, EditAnywhere TEnumAsByte< enum ESubUVBoundingVertexCount > BoundingMode More bounding vertices results in reduced overdraw, but adds more triangle overhead.
Public variable UProperty Category, EditAnywhere uint8: 1 bOverrideSystemMacroUV Override the system MacroUV settings
Public variable UProperty Category, EditAnywhere uint8: 1 bOverrideUseVelocityForMotionBlur  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bRemoveHMDRoll If true, removes the HMD view roll (e.g. in VR)
Public variable UProperty Category, EditAnywhere uint8: 1 bScaleUV Whether to scale the UV or not - ie, the model wasn't setup with sub uvs
Public variable UProperty Category, EditAnywhere uint8: 1 bSupportLargeWorldCoordinates If true, gpu simulation positions are offset to support double precision vectors.
Public variable UProperty export, noclear TArray< FParticleBurst > BurstList The array of burst entries.
Public variable UProperty Category, EditAnywhere uint8: 1 bUseLegacyEmitterTime If true, the EmitterTime for the emitter will be calculated by modulating the SecondsSinceCreation by the EmitterDuration.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bUseLocalSpace If true, update the emitter in local space
Public variable UProperty Category, EditAnywhere uint8: 1 bUseMaxDrawCount If true, use the MaxDrawCount to limit the number of particles rendered.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bUseVelocityForMotionBlur When supported by the vertex factory will use particle velocity for motion blur approximation.
Public variable UProperty Category, EditAnywhere TObjectPtr< UTexture2D > CutoutTexture Texture to generate bounding geometry from.
Public variable UProperty Category, EditAnywhere float EmitterDelay Delay-related.
Public variable UProperty Category, EditAnywhere float EmitterDelayLow The low end of the emitter delay if using a range.
Public variable UProperty Category, EditAnywhere, Meta float EmitterDuration How long, in seconds, the emitter will run before looping.
Public variable UProperty Category, EditAnywhere, Meta float EmitterDurationLow The low end of the emitter duration if using a range.
Public variable UProperty Category, EditAnywhere int32 EmitterLoops The number of times to loop the emitter. 0 indicates loop continuously
Public variable UProperty Category, EditAnywhere TEnumAsByte< enum EEmitterNormalsMode > EmitterNormalsMode Normal generation mode for this emitter LOD.
Public variable UProperty Category, EditAnywhere FVector EmitterOrigin  
Public variable UProperty Category, EditAnywhere FRotator EmitterRotation  
Public variable UProperty Category, EditAnywhere TEnumAsByte< EParticleSubUVInterpMethod > InterpolationMethod SubUV-related.
Public variable UProperty Category, EditAnywhere FVector MacroUVPosition Local space position that UVs generated with the ParticleMacroUV material node will be centered on.
Public variable UProperty Category, EditAnywhere float MacroUVRadius World space radius that UVs generated with the ParticleMacroUV material node will tile based on.
Public variable UProperty Category, EditAnywhere TObjectPtr< class UMaterialInterface > Material General. The material to utilize for the emitter at this LOD level.
Public variable UProperty Category, EditAnywhere int32 MaxDrawCount The maximum number of particles to DRAW for this emitter.
Public variable UProperty Category, EditAnywhere, Meta float MaxFacingCameraBlendDistance The distance at which PSA_FacingCameraDistanceBlend is fully PSA_FacingCameraPosition
Public variable UProperty Category, EditAnywhere, Meta float MinFacingCameraBlendDistance The distance at which PSA_FacingCameraDistanceBlend is fully PSA_Square
Public variable UProperty Category, EditAnywhere TArray< FName > NamedMaterialOverrides Named material overrides for this emitter.
Public variable UProperty Category, EditAnywhere FVector NormalsCylinderDirection When EmitterNormalsMode is ENM_Cylindrical, particle normals are created to face away from the cylinder going through NormalsSphereCenter in the direction NormalsCylinderDirection.
Public variable UProperty Category, EditAnywhere FVector NormalsSphereCenter When EmitterNormalsMode is ENM_Spherical, particle normals are created to face away from NormalsSphereCenter.
Public variable UProperty Category, EditAnywhere TEnumAsByte< enum EOpacitySourceMode > OpacitySourceMode  
Public variable UProperty TEnumAsByte< EParticleBurstMethod > ParticleBurstMethod The method to utilize when burst-emitting particles
Public variable UProperty Category, EditAnywhere int32 RandomImageChanges The number of times to change a random image over the life of the particle.
Public variable UProperty float RandomImageTime The amount of time (particle-relative, 0.0 to 1.0) to 'lock' on a random sub image 0.0 = change every frame 1.0 = select a random image at spawn and hold for the life of the particle
Public variable UProperty Category, EditAnywhere TEnumAsByte< EParticleScreenAlignment > ScreenAlignment The screen alignment to utilize for the emitter at this LOD level.
Public variable UProperty Category, EditAnywhere TEnumAsByte< EParticleSortMode > SortMode The sorting mode to use for this emitter.
Public variable UProperty FRawDistributionFloat SpawnRate Spawn-related. The rate at which to spawn particles
Public variable UProperty Category, EditAnywhere int32 SubImages_Horizontal The number of sub-images horizontally in the texture
Public variable UProperty Category, EditAnywhere int32 SubImages_Vertical The number of sub-images vertically in the texture
Public variable UProperty Category, EditAnywhere EParticleUVFlipMode UVFlippingMode Controls UV Flipping for this emitter.

Constructors

  Type Name Description
Public function  

UParticleModuleRequired ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function FParticleRequiredModule *  
Public function Const FRHIShaderResourceView *  
Public function Const const FVector2f *

GetFrameData ( int32 FrameIndex
)

  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function void Initializes the default values for this property
Public function Const bool  
Public function Const bool  

Overridden from UParticleModule

  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 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 Const EModuleType Retrieve the ModuleType of this module.
Public function Virtual bool

IsValidForLODLevel ( UParticleLODLevel* LODLevel,
FString& OutErrorString
)

 Returns true if the module is valid for the provided LOD level.
Public function Virtual void For Cascade.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called to finish destroying the object.
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally
Public function Virtual void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page