1. Epic GamesDeveloper
  3. UParticleModuleCollision

UParticleModuleCollision

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (EditInlineNew, HideCategories=Object, MinimalAPI, Meta=(DisplayName="Actor Collision"))  
class UParticleModuleCollision : public UParticleModuleCollisionBase

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere uint32: 1 bApplyPhysics If true, physic will be applied between a particle and the object it collides with.
Public variable UProperty Category, EditAnywhere uint32: 1 bCollideOnlyIfVisible If true, Particle collision only if particle system is currently being rendered.
Public variable UProperty Category, EditAnywhere uint32: 1 bDropDetail If true, when the World->bDropDetail flag is set, the module will be ignored.
Public variable UProperty Category, EditAnywhere uint32: 1 bIgnoreSourceActor If true, then the source actor is ignored in collision checks. Defaults to true.
Public variable UProperty Category, EditAnywhere uint32: 1 bIgnoreTriggerVolumes Any trigger volumes that are hit will be ignored.
Public variable UProperty Category, EditAnywhere uint32: 1 bOnlyVerticalNormalsDecrementCount If true, then collisions that do not have a vertical hit normal will still react, but UsedMaxCollisions count will not be decremented.
Public variable UProperty Category, EditAnywhere uint32: 1 bPawnsDoNotDecrementCount If true, then collisions with Pawns will still react, but the UsedMaxCollisions count will not be decremented.
Public variable UProperty Category, EditAnywhere TEnumAsByte< enum EParticleCollisionComplete > CollisionCompletionOption What to do once a particles MaxCollisions is reached.
Public variable UProperty Category, EditAnywhere TArray< TEnumAsByte< enum EObjectTypeQuery > > CollisionTypes Which ObjectTypes to collide with
Public variable UProperty Category, EditAnywhere FRawDistributionVector DampingFactor How much to slow the velocity of the particle after a collision.
Public variable UProperty Category, EditAnywhere FRawDistributionVector DampingFactorRotation How much to slow the rotation of the particle after a collision.
Public variable UProperty Category, EditAnywhere FRawDistributionFloat DelayAmount How long to delay before checking a particle for collisions.
Public variable UProperty Category, EditAnywhere float DirScalar The directional scalar value - used to scale the bounds to 'assist' in avoiding inter-penetration or large gaps.
Public variable UProperty Category, EditAnywhere float MaxCollisionDistance Max distance at which particle collision will occur.
Public variable UProperty Category, EditAnywhere FRawDistributionFloat MaxCollisions The maximum number of collisions a particle can have.
Public variable FCollisionObjectQueryParams ObjectParams ObjectParams created for array of CollisionTypes
Public variable UProperty Category, EditAnywhere FRawDistributionFloat ParticleMass The mass of the particle - for use when bApplyPhysics is true.
Public variable UProperty Category, EditAnywhere float VerticalFudgeFactor The fudge factor to use to determine vertical.

Constructors

  Type Name Description
Public function  

UParticleModuleCollision ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Initializes the default values for this property
Public function Virtual bool

PerformCollisionCheck ( FParticleEmitterInstance* Owner,
FBaseParticle* InParticle,
FHitResult& Hit,
AActor* SourceActor,
const FVector& End,
const FVector& Start,
const FVector& Extent
)

 Perform the desired collision check for this module.

Overridden from UParticleModule

  Type Name Description
Public function Virtual bool Return false if this emitter requires a game thread tick
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 uint32

PrepPerInstanceBlock ( FParticleEmitterInstance* Owner,
void* InstData
)

 Allows the module to prep its 'per-instance' data block.
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 Virtual void For Cascade.
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 Virtual void

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

 Called on a particle that is being updated by its emitter.

Overridden from UObject

  Type Name Description
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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page