Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UParticleModuleRequired |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Particles/ParticleModuleRequired.h |
| Include Path | #include "Particles/ParticleModuleRequired.h" |
Syntax
UCLASS (EditInlineNew, HideCategories=(Object, Cascade), Meta=(DisplayName="Required"), MinimalAPI)
class UParticleModuleRequired : public UParticleModule
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UParticleModule → UParticleModuleRequired
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UParticleModuleRequired
(
const FObjectInitializer& ObjectInitializer |
Particles/ParticleModuleRequired.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AlphaThreshold | float | Alpha channel values larger than the threshold are considered occupied and will be contained in the bounding geometry. | Particles/ParticleModuleRequired.h |
|
| bDelayFirstLoopOnly | uint8 | If true, the emitter will be delayed only on the first loop. | Particles/ParticleModuleRequired.h |
|
| bDurationRecalcEachLoop | uint8 | If true, recalculate the emitter duration on each loop. | Particles/ParticleModuleRequired.h |
|
| bEmitterDelayUseRange | uint8 | If true, select the emitter delay from the range [EmitterDelayLow..EmitterDelay] | Particles/ParticleModuleRequired.h |
|
| bEmitterDurationUseRange | uint8 | If true, select the emitter duration from the range [EmitterDurationLow..EmitterDuration] | Particles/ParticleModuleRequired.h |
|
| bKillOnCompleted | uint8 | If true, kill the emitter when it completes | Particles/ParticleModuleRequired.h |
|
| bKillOnDeactivate | uint8 | If true, kill the emitter when the particle system is deactivated | Particles/ParticleModuleRequired.h |
|
| bOrbitModuleAffectsVelocityAlignment | uint8 | Ensures that movement generated from the orbit module is applied to velocity-aligned particles | Particles/ParticleModuleRequired.h |
|
| BoundingMode | TEnumAsByte< enum ESubUVBoundingVertexCount > | More bounding vertices results in reduced overdraw, but adds more triangle overhead. | Particles/ParticleModuleRequired.h |
|
| bOverrideSystemMacroUV | uint8 | Override the system MacroUV settings | Particles/ParticleModuleRequired.h |
|
| bOverrideUseVelocityForMotionBlur | uint8 | Particles/ParticleModuleRequired.h |
|
|
| bRemoveHMDRoll | uint8 | If true, removes the HMD view roll (e.g. in VR) | Particles/ParticleModuleRequired.h |
|
| bScaleUV | uint8 | Whether to scale the UV or not - ie, the model wasn't setup with sub uvs | Particles/ParticleModuleRequired.h |
|
| bSupportLargeWorldCoordinates | uint8 | If true, gpu simulation positions are offset to support double precision vectors. | Particles/ParticleModuleRequired.h |
|
| BurstList | TArray< FParticleBurst > | The array of burst entries. | Particles/ParticleModuleRequired.h |
|
| bUseLegacyEmitterTime | uint8 | If true, the EmitterTime for the emitter will be calculated by modulating the SecondsSinceCreation by the EmitterDuration. | Particles/ParticleModuleRequired.h |
|
| bUseLocalSpace | uint8 | If true, update the emitter in local space | Particles/ParticleModuleRequired.h |
|
| bUseMaxDrawCount | uint8 | If true, use the MaxDrawCount to limit the number of particles rendered. | Particles/ParticleModuleRequired.h |
|
| bUseVelocityForMotionBlur | uint8 | When supported by the vertex factory will use particle velocity for motion blur approximation. | Particles/ParticleModuleRequired.h |
|
| CutoutTexture | TObjectPtr< UTexture2D > | Texture to generate bounding geometry from. | Particles/ParticleModuleRequired.h |
|
| EmitterDelay | float | Delay-related. | Particles/ParticleModuleRequired.h |
|
| EmitterDelayLow | float | The low end of the emitter delay if using a range. | Particles/ParticleModuleRequired.h |
|
| EmitterDuration | float | How long, in seconds, the emitter will run before looping. | Particles/ParticleModuleRequired.h |
|
| EmitterDurationLow | float | The low end of the emitter duration if using a range. | Particles/ParticleModuleRequired.h |
|
| EmitterLoops | int32 | The number of times to loop the emitter. 0 indicates loop continuously | Particles/ParticleModuleRequired.h |
|
| EmitterNormalsMode | TEnumAsByte< enum EEmitterNormalsMode > | Normal generation mode for this emitter LOD. | Particles/ParticleModuleRequired.h |
|
| EmitterOrigin | FVector | Particles/ParticleModuleRequired.h |
|
|
| EmitterRotation | FRotator | Particles/ParticleModuleRequired.h |
|
|
| InterpolationMethod | TEnumAsByte< EParticleSubUVInterpMethod > | SubUV-related. | Particles/ParticleModuleRequired.h |
|
| MacroUVPosition | FVector | Local space position that UVs generated with the ParticleMacroUV material node will be centered on. | Particles/ParticleModuleRequired.h |
|
| MacroUVRadius | float | World space radius that UVs generated with the ParticleMacroUV material node will tile based on. | Particles/ParticleModuleRequired.h |
|
| Material | TObjectPtr< class UMaterialInterface > | General. The material to utilize for the emitter at this LOD level. | Particles/ParticleModuleRequired.h |
|
| MaxDrawCount | int32 | The maximum number of particles to DRAW for this emitter. | Particles/ParticleModuleRequired.h |
|
| MaxFacingCameraBlendDistance | float | The distance at which PSA_FacingCameraDistanceBlend is fully PSA_FacingCameraPosition | Particles/ParticleModuleRequired.h |
|
| MinFacingCameraBlendDistance | float | The distance at which PSA_FacingCameraDistanceBlend is fully PSA_Square | Particles/ParticleModuleRequired.h |
|
| NamedMaterialOverrides | TArray< FName > | Named material overrides for this emitter. | Particles/ParticleModuleRequired.h |
|
| NormalsCylinderDirection | FVector | When EmitterNormalsMode is ENM_Cylindrical, particle normals are created to face away from the cylinder going through NormalsSphereCenter in the direction NormalsCylinderDirection. | Particles/ParticleModuleRequired.h |
|
| NormalsSphereCenter | FVector | When EmitterNormalsMode is ENM_Spherical, particle normals are created to face away from NormalsSphereCenter. | Particles/ParticleModuleRequired.h |
|
| OpacitySourceMode | TEnumAsByte< enum EOpacitySourceMode > | Particles/ParticleModuleRequired.h |
|
|
| ParticleBurstMethod | TEnumAsByte< EParticleBurstMethod > | The method to utilize when burst-emitting particles | Particles/ParticleModuleRequired.h | |
| RandomImageChanges | int32 | The number of times to change a random image over the life of the particle. | Particles/ParticleModuleRequired.h |
|
| RandomImageTime | float | 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 | Particles/ParticleModuleRequired.h | |
| ScreenAlignment | TEnumAsByte< EParticleScreenAlignment > | The screen alignment to utilize for the emitter at this LOD level. | Particles/ParticleModuleRequired.h |
|
| SortMode | TEnumAsByte< EParticleSortMode > | The sorting mode to use for this emitter. | Particles/ParticleModuleRequired.h |
|
| SpawnRate | FRawDistributionFloat | Spawn-related. The rate at which to spawn particles | Particles/ParticleModuleRequired.h | |
| SubImages_Horizontal | int32 | The number of sub-images horizontally in the texture | Particles/ParticleModuleRequired.h |
|
| SubImages_Vertical | int32 | The number of sub-images vertically in the texture | Particles/ParticleModuleRequired.h |
|
| UVFlippingMode | EParticleUVFlipMode | Controls UV Flipping for this emitter. | Particles/ParticleModuleRequired.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BoundingGeometryBuffer | FSubUVBoundingGeometryBuffer * | Used on platforms that support instancing, the bounding geometry is fetched from a vertex shader instead of on the CPU. | Particles/ParticleModuleRequired.h | |
| DerivedData | FSubUVDerivedData | Derived data for this asset, generated off of SubUVTexture. | Particles/ParticleModuleRequired.h | |
| ReleaseFence | FRenderCommandFence | Tracks progress of BoundingGeometryBuffer release during destruction. | Particles/ParticleModuleRequired.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FParticleRequiredModule * CreateRendererResource() |
Particles/ParticleModuleRequired.h | ||
FRHIShaderResourceView * GetBoundingGeometrySRV() |
Particles/ParticleModuleRequired.h | ||
const FVector2f * GetFrameData
(
int32 FrameIndex |
Particles/ParticleModuleRequired.h | ||
int32 GetNumBoundingTriangles() |
Particles/ParticleModuleRequired.h | ||
int32 GetNumBoundingVertices() |
Particles/ParticleModuleRequired.h | ||
int32 GetNumFrames() |
Particles/ParticleModuleRequired.h | ||
void InitializeDefaults() |
Initializes the default values for this property | Particles/ParticleModuleRequired.h | |
bool IsBoundingGeometryValid() |
Particles/ParticleModuleRequired.h | ||
bool ShouldUseVelocityForMotionBlur() |
Particles/ParticleModuleRequired.h |
Overridden from UParticleModule
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AddModuleCurvesToEditor
(
UInterpCurveEdSetup* EdSetup, |
Add all curve-editable Objects within this module to the curve editor. | Particles/ParticleModuleRequired.h | |
virtual bool GenerateLODModuleValues
(
UParticleModule* SourceModule, |
Helper function used by the editor to auto-generate LOD values from a source module and a percentage value used to scale its values. | Particles/ParticleModuleRequired.h | |
virtual EModuleType GetModuleType() |
Retrieve the ModuleType of this module. | Particles/ParticleModuleRequired.h | |
virtual bool IsValidForLODLevel
(
UParticleLODLevel* LODLevel, |
Returns true if the module is valid for the provided LOD level. | Particles/ParticleModuleRequired.h | |
virtual void SetToSensibleDefaults
(
UParticleEmitter* Owner |
For Cascade. | Particles/ParticleModuleRequired.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Particles/ParticleModuleRequired.h | ||
virtual void FinishDestroy() |
Particles/ParticleModuleRequired.h | ||
virtual bool IsReadyForFinishDestroy() |
Particles/ParticleModuleRequired.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Particles/ParticleModuleRequired.h | ||
virtual void PostInitProperties() |
Particles/ParticleModuleRequired.h | ||
virtual void PostLoad() |
Particles/ParticleModuleRequired.h | ||
virtual void PreEditChange
(
FProperty* PropertyAboutToChange |
Particles/ParticleModuleRequired.h | ||
virtual void Serialize
(
FStructuredArchive::FRecord Record |
Particles/ParticleModuleRequired.h |