1. Epic GamesDeveloper
  3. UParticleSystemComponent

UParticleSystemComponent

A particle emitter.

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (ClassGroup=(Rendering), HideCategories=Object, HideCategories=Physics,  
       HideCategories=Collision, ShowCategories=Trigger, EditInlineNew,  
       Meta=(BlueprintSpawnableComponent, DisplayName="Cascade Particle System Component"),  
       MinimalAPI)  
class UParticleSystemComponent : public UFXSystemComponent

Remarks

A particle emitter.

Variables

  Type Name Description
Public variable float AccumLODDistanceCheckTime LOD updating...
Public variable float AccumTickTime Used to accumulate total tick time to determine whether system can be skipped ticking if not visible.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EAttachmentRule AutoAttachLocationRule Options for how we handle our location when we attach to the AutoAttachParent, if bAutoManageAttachment is true.
Public variable UProperty Category, Meta BlueprintReadWrite visibleinstanceonly TWeakObjectPtr< USceneComponent > AutoAttachParent Component we automatically attach to when activated, if bAutoManageAttachment is true.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EAttachmentRule AutoAttachRotationRule Options for how we handle our rotation when we attach to the AutoAttachParent, if bAutoManageAttachment is true.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EAttachmentRule AutoAttachScaleRule Options for how we handle our scale when we attach to the AutoAttachParent, if bAutoManageAttachment is true.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FName AutoAttachSocketName Socket we automatically attach to on the AutoAttachParent, if bAutoManageAttachment is true.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint8: 1 bAllowRecycling If true, this Particle System will be available for recycling after it has completed.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bAutoAttachWeldSimulatedBodies Option for how we handle bWeldSimulatedBodies when we attach to the AutoAttachParent, if bAutoManageAttachment is true.
Public variable uint8: 1 bAutoDestroy  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly uint8: 1 bAutoManageAttachment True if we should automatically attach to AutoAttachParent when activated, and detach from our parent when completed.
Public variable uint8: 1 bDeactivateTriggered If true, someone has requested this component deactivate.
Public variable uint8: 1 bForcedInActive This is set when any of our "don't tick me" timeout values have fired
Public variable uint8: 1 bForceLODUpdateFromRenderer If true, force an LOD update from the renderer.
Public variable uint8: 1 bHasBeenActivated This flag will be set the first time the PSysComp is activated...
Public variable uint8: 1 bIsDuringRegister  
Public variable uint8: 1 bIsManagingSignificance If this component is having it's significance managed by gameplay code.
Public variable uint8: 1 bIsViewRelevanceDirty If true, the ViewRelevanceFlags are dirty and should be recached
Public variable uint8: 1 bJustRegistered Indicates that the component has not been ticked since being registered.
Public variable UProperty Transient duplicatetransient bool bOldPositionValid  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bOverrideLODMethod Indicates that the component's LODMethod overrides the Template's
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bResetOnDetach  
Public variable uint8: 1 bResetTriggered If true, someone has requested this component reset.
Public variable UProperty uint8: 1 bSkipUpdateDynamicDataDuringTick Flag indicating that dynamic updating of render data should NOT occur during Tick.
Public variable uint8: 1 bSuppressSpawning  
Public variable UProperty uint8: 1 bUpdateOnDedicatedServer Whether to update the particle system on dedicated servers
Public variable TArray< struct FParticleEventBurstData > BurstEvents The Burst events that occurred in this PSysComp.
Public variable UProperty uint8: 1 bWarmingUp  
Public variable uint8: 1 bWasActive True if this was active before being unregistered or otherwise reset, if so reactivate it
Public variable uint8: 1 bWasCompleted  
Public variable uint8: 1 bWasDeactivated  
Public variable uint8: 1 bWasManagingSignificance If this component was previously having it's significance managed by gameplay code.
Public variable TArray< FMaterialRelevance > CachedViewRelevanceFlags The view relevance flags for each LODLevel.
Public variable TArray< struct FParticleEventCollideData > CollisionEvents The Collision events that occurred in this PSysComp.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float CustomTimeDilation Scales DeltaTime in UParticleSystemComponent::Tick(...)
Public variable TArray< struct FParticleEventDeathData > DeathEvents The Death events that occurred in this PSysComp.
Public variable UProperty int32 EditorDetailMode Used for applying Cascade's detail mode setting to in-level particle systems
Public variable UProperty int32 EditorLODLevel INTERNAL. Used by the editor to set the LODLevel
Public variable float EmitterDelay This is created at start up and then added to each emitter
Public variable TArray< struct FParticleEmitterInstance * > EmitterInstances  
Public variable UProperty Transient duplicatetransient TArray< TObjectPtr< class UMaterialInterface > > EmitterMaterials  
Public variable FFXSystem * FXSystem  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< struct FParticleSysParam > InstanceParameters Array holding name instance parameters for this ParticleSystemComponent.
Public variable TArray< struct FParticleEventKismetData > KismetEvents The Kismet events that occurred for this PSysComp.
Public variable float LastSignificantTime Time in seconds since we were last considered significant.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TEnumAsByte< enum ParticleSystemLODMethod > LODMethod The method of LOD level determination to utilize for this particle system
Public variable UProperty float MaxTimeBeforeForceUpdateTransform Time between forced UpdateTransforms for systems that use dynamically calculated bounds, Which is effectively how often the bounds are shrunk.
Public variable UProperty Transient duplicatetransient FVector OldPosition  
Public variable UProperty BlueprintAssignable FParticleBurstSignature OnParticleBurst  
Public variable UProperty BlueprintAssignable FParticleCollisionSignature OnParticleCollide  
Public variable UProperty BlueprintAssignable FParticleDeathSignature OnParticleDeath  
Public variable UProperty BlueprintAssignable FParticleSpawnSignature OnParticleSpawn  
Public variable UProperty BlueprintAssignable FOnSystemFinished OnSystemFinished Called when the particle system is done.
Public variable UProperty Transient duplicatetransient FVector PartSysVelocity  
Public variable EPSCPoolMethod PoolingMethod If this PSC is pooling.
Public variable FRandomStream RandomStream Stream of random values to use with this component
Public variable FRenderCommandFence * ReleaseResourcesFence Command fence used to shut down properly
Public variable int32 ReplayClipIDNumber Clip ID number we're either playing back or capturing to, depending on the value of ReplayState.
Public variable UProperty TArray< TObjectPtr< class UParticleSystemReplay > > ReplayClips Array of replay clips for this particle system component.
Public variable int32 ReplayFrameIndex The current replay frame for playback
Public variable TEnumAsByte< enum ParticleReplayState > ReplayState Current particle 'replay state'.
Public variable UProperty EParticleSignificanceLevel RequiredSignificance The significance this component requires of it's emitters for them to be enabled.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float SecondsBeforeInactive Number of seconds of emitter not being rendered that need to pass before it no longer gets ticked/ becomes inactive.
Public variable UProperty Transient duplicatetransient TArray< TObjectPtr< class USkeletalMeshComponent > > SkelMeshComponents The skeletal mesh components used with the socket location module.
Public variable TArray< struct FParticleEventSpawnData > SpawnEvents The Spawn events that occurred in this PSysComp.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< class UParticleSystem > Template  
Public variable UProperty Transient duplicatetransient float WarmupTickRate  
Public variable UProperty Transient duplicatetransient float WarmupTime  

Constructors

  Type Name Description
Public function  

UParticleSystemComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Auto-populate the instance parameters based on contained modules.
Public function UFunction BlueprintCallable, Category void

BeginTrails ( FName InFirstSocketName,
FName InSecondSocketName,
ETrailWidthMode InWidthMode,
float InWidth
)

 Begins all trail emitters in this component.
Public function Const bool True if this component can be occluded.
Public function Const bool True if this component can be considered invisible and potentially culled.
Public function bool  
Public function bool Return true if this psys can tick in any thread
Protected function void Clears dynamic data on the rendering thread.
Public function void

ClearParameter ( FName ParameterName,
enum EParticleSysParamType ParameterType
)

 Clears the specified parameter, returning it to the default value set in the template
Public function void  
Public function void Decide if this psys can tick in any thread, and set bIsElligibleForAsyncTick
Public function void Possibly parallel phase of TickComponent
Public function void Cache the view-relevance for each emitter at each LOD level if needed.
Protected function FParticleDynamicData * Creates dynamic particle data for rendering the particle system this frame.
Protected function Static FDynamicEmitterDataBase *

CreateDynamicDataFromReplay ( FParticleEmitterInstance* EmitterInstance,
const FDynamicEmitterReplayDataBase* EmitterReplayData,
bool bSelected,
ERHIFeatureLevel::Type InFeatureLevel
)

 Static: Supplied with a chunk of replay data, this method will create dynamic emitter data that can be used to render the particle system
Public function Virtual UFunction BlueprintCallable, Category UMaterialInstanceDynamic * Creates a Dynamic Material Instance for the specified named material override, optionally from the supplied material.
Public function void  
Public function void Deactivate the system
Public function Virtual int32

DetermineLODLevelForLocation ( const FVector& EffectLocation
)

 This will determine which LOD to use based off the specific ParticleSystem passed in and the distance to where that PS is being displayed.
Public function Virtual Const bool  
Public function UFunction BlueprintCallable, Category void Ends all trail emitters in this component.
Public function void After the possibly parallel phase of TickComponent, we fire events, etc
Public function UParticleSystemReplay *

FindReplayClipForIDNumber ( const int32 InClipIDNumber
)

 Finds the replay clip of the specified ID number
Public function Const void

ForceAsyncWorkCompletion ( EForceAsyncWorkCompletion Behavior,
bool bDefinitelyGameThread
)

 If there is async work outstanding, force it to be completed now
Public function void

ForceAsyncWorkCompletion ( EForceAsyncWorkCompletion Behavior,
bool bDefinitelyGameThread,
bool InSkipUpdateDynamicDataDuringTick
)

 If there is async work outstanding, force it to be completed now
Public function void  
Public function void Force the component to update its bounding box.
Public function UFunction BlueprintCallable, Category void

GenerateParticleEvent ( const FName InEventName,
const float InEmitterTime,
const FVector InLocation,
const FVector InDirection,
const FVector InVelocity
)

 Record a kismet event.
Public function Virtual bool

GetActorParameter ( const FName InName,
AActor*& OutActor
)

 Retrieve the Actor parameter value for the given name.
Public function Virtual bool

GetAnyVectorParameter ( const FName InName,
FVector& OutVector
)

 Retrieve the Vector parameter value for the given name...also looks for colors and floats and returns those
Public function Const float Returns the approximate distance squared from this component to the passed location.
Public function const FBoxSphereBounds &  
Public function const FTransform &  
Public function const TArray< struct FParticleSysParam > &  
Public function const FVector &  
Public function Virtual Const UFunction BlueprintCallable, Category bool

GetBeamEndPoint ( int32 EmitterIndex,
FVector& OutEndPoint
)

 Get the beam end point
Public function Virtual Const UFunction BlueprintCallable, Category bool

GetBeamSourcePoint ( int32 EmitterIndex,
int32 SourceIndex,
FVector& OutSourcePoint
)

 Get the beam source point
Public function Virtual Const UFunction BlueprintCallable, Category bool

GetBeamSourceStrength ( int32 EmitterIndex,
int32 SourceIndex,
float& OutSourceStrength
)

 Get the beam source strength
Public function Virtual Const UFunction BlueprintCallable, Category bool

GetBeamSourceTangent ( int32 EmitterIndex,
int32 SourceIndex,
FVector& OutTangentPoint
)

 Get the beam source tangent
Public function Virtual Const UFunction BlueprintCallable, Category bool

GetBeamTargetPoint ( int32 EmitterIndex,
int32 TargetIndex,
FVector& OutTargetPoint
)

 Get the beam target point
Public function Virtual Const UFunction BlueprintCallable, Category bool

GetBeamTargetStrength ( int32 EmitterIndex,
int32 TargetIndex,
float& OutTargetStrength
)

 Get the beam target strength
Public function Virtual Const UFunction BlueprintCallable, Category bool

GetBeamTargetTangent ( int32 EmitterIndex,
int32 TargetIndex,
FVector& OutTangentPoint
)

 Get the beam target tangent
Public function Virtual bool

GetColorParameter ( const FName InName,
FLinearColor& OutColor
)

 Retrieve the Color parameter value for the given name.
Public function Const int32 Decide which detail mode should be applied to this particle system.
Public function Const int32  
Public function Virtual bool

GetFloatParameter ( const FName InName,
float& OutFloat
)

 Retrieve the Float parameter value for the given name.
Public function Virtual int32 Get the LOD level of the particle system
Public function Const const FVector3f &  
Public function Const int32  
Public function FPSCTickData &  
Public function Virtual bool

GetMaterialParameter ( const FName InName,
UMaterialInterface*& OutMaterial
)

 Retrieve the Material parameter value for the given name.
Public function Virtual Const UFunction BlueprintCallable, Category UMaterialInterface *

GetNamedMaterial ( FName InName
)

 Returns a named material. If this named material is not found, returns NULL.
Public function Virtual Const int32 Returns the index into the EmitterMaterials array for this named.
Public function Virtual Const FName Returns the name associated with the passed in material, returns NAME_None if it is not found
Public function Const UFunction BlueprintCallable, Category int32 Get the current number of active particles in this system
Public function Virtual void

GetOwnedTrailEmitters ( TrailEmitterArray& OutTrailEmitters,
const void* InOwner,
bool bSetOwner
)

 Fills the passed array with all trail emitters associated with a particular object.
Public function FParticlePerfStatsContext  
Public function const TArray< FVector > &  
Public function const TArray< float > &  
Public function Virtual bool

GetVectorParameter ( const FName InName,
FVector& OutVector
)

 Retrieve the Vector parameter value for the given name.
Public function Const FParticleSystemWorldManager *  
Public function bool  
Public function void  
Public function Virtual void If particles have not already been initialised (ie. EmitterInstances created) do it now.
Public function Const int32  
Public function Const int32  
Public function Const bool  
Public function void  
Public function void  
Public function void

OnSignificanceChanged ( bool bSignificant,
bool bApplyToEmitters,
bool bAsync
)

 When the overall significance for the component is changed.
Protected function void Orients the Z axis of the ParticleSystemComponent toward the camera while preserving the X axis direction
Public function Virtual bool

ParticleLineCheck ( FHitResult& Hit,
AActor* SourceActor,
const FVector& End,
const FVector& Start,
const FVector& HalfExtent,
const FCollisionObjectQueryParams& ObjectParams
)

 Collision Handling...
Public function void

ReportEventBurst ( const FName InEventName,
const float InEmitterTime,
const int32 ParticleCount,
const FVector InLocation,
const TArray< class UParticleModuleEventSendToGame* >& InEventData
)

 Record a bursting event.
Public function void

ReportEventCollision ( const FName InEventName,
const float InEmitterTime,
const FVector InLocation,
const FVector InDirection,
const FVector InVelocity,
const TArray< class UParticleModuleEventSendToGame* >& InEventData,
const float InParticleTime,
const FVector InNormal,
const float InTime,
const int32 InItem,
const FName InBoneName,
UPhysicalMaterial* PhysMat
)

 Record a collision event.
Public function void

ReportEventDeath ( const FName InEventName,
const float InEmitterTime,
const FVector InLocation,
const FVector InVelocity,
const TArray< class UParticleModuleEventSendToGame* >& InEventData,
const float InParticleTime
)

 Record a death event.
Public function void

ReportEventSpawn ( const FName InEventName,
const float InEmitterTime,
const FVector InLocation,
const FVector InVelocity,
const TArray< class UParticleModuleEventSendToGame* >& InEventData
)

 Event reporting... Record a spawning event.
Public function void  
Public function void  
Public function void

ResetParticles ( bool bEmptyInstances
)

  
Public function void Stops the emitter, unregisters the component, and resets the component's properties to the values of its template
Public function Virtual void  
Public function UFunction BlueprintCallable, Category, Meta void

SetAutoAttachParams ( USceneComponent* Parent,
FName SocketName,
EAttachLocation::Type LocationType
)

 DEPRECATED: Set AutoAttachParent, AutoAttachSocketName, AutoAttachLocationType to the specified parameters.
Public function Virtual UFunction BlueprintCallable, Category void

SetBeamEndPoint ( int32 EmitterIndex,
FVector NewEndPoint
)

 Beam-related script functions. Set the beam end point
Public function Virtual UFunction BlueprintCallable, Category void

SetBeamSourcePoint ( int32 EmitterIndex,
FVector NewSourcePoint,
int32 SourceIndex
)

 Set the beam source point
Public function Virtual UFunction BlueprintCallable, Category void

SetBeamSourceStrength ( int32 EmitterIndex,
float NewSourceStrength,
int32 SourceIndex
)

 Set the beam source strength
Public function Virtual UFunction BlueprintCallable, Category void

SetBeamSourceTangent ( int32 EmitterIndex,
FVector NewTangentPoint,
int32 SourceIndex
)

 Set the beam source tangent
Public function Virtual UFunction BlueprintCallable, Category void

SetBeamTargetPoint ( int32 EmitterIndex,
FVector NewTargetPoint,
int32 TargetIndex
)

 Set the beam target point
Public function Virtual UFunction BlueprintCallable, Category void

SetBeamTargetStrength ( int32 EmitterIndex,
float NewTargetStrength,
int32 TargetIndex
)

 Set the beam target strength
Public function Virtual UFunction BlueprintCallable, Category void

SetBeamTargetTangent ( int32 EmitterIndex,
FVector NewTangentPoint,
int32 TargetIndex
)

 Set the beam target tangent
Public function void

SetFloatRandParameter ( FName ParameterName,
float Param,
float ParamLow
)

 Set a named random float instance parameter on this ParticleSystemComponent.
Public function Virtual void

SetLODLevel ( int32 InLODLevel
)

 Set the LOD level of the particle system
Public function void

SetManagerHandle ( int32 InHandle
)

  
Public function void

SetManagingSignificance ( bool bManageSignificance
)

 Called from game code when the component begins having it's significance managed.
Public function UFunction BlueprintCallable, Category void

SetMaterialParameter ( FName ParameterName,
UMaterialInterface* Param
)

 Set a named material instance parameter on this ParticleSystemComponent.
Public function void

SetPendingManagerAdd ( bool bValue
)

  
Public function void

SetPendingManagerRemove ( bool bValue
)

  
Public function void Called from game code when the significance required for a component changes.
Public function UFunction BlueprintCallable, Category void

SetTemplate ( UParticleSystem* NewTemplate
)

 Change the ParticleSystem used by this ParticleSystemComponent
Public function UFunction BlueprintCallable, Category void

SetTrailSourceData ( FName InFirstSocketName,
FName InSecondSocketName,
ETrailWidthMode InWidthMode,
float InWidth
)

 Sets the defining data for all trails in this component.
Public function void

SetVectorRandParameter ( FName ParameterName,
const FVector& Param,
const FVector& ParamLow
)

 Set a named random vector instance parameter on this ParticleSystemComponent.
Public function void

SetVectorUnitRandParameter ( FName ParameterName,
const FVector& Param,
const FVector& ParamLow
)

 Set a named random unit vector instance parameter on this ParticleSystemComponent.
Public function Const bool  
Public function Const bool Whether this component should have it's significance managed by game code.
Protected function Virtual void  
Public function void

UpdateInstances ( bool bEmptyInstances
)

  
Protected function Virtual void  

Overridden from UFXSystemComponent

  Type Name Description
Public function Virtual void

ActivateSystem ( bool bFlagAsJustAttached
)

 Activate the system
Public function Virtual void Forces component to deactivate immediately.
Public function Virtual Const uint32 Returns an approximate memory usage value for this component.
Public function Virtual Const UFXSystemAsset * Get the referenced FXSystem asset.
Public function Virtual void Deactivates this system and releases it to the pool on completion.
Public function Virtual void

SetActorParameter ( FName ParameterName,
AActor* Param
)

 Set a named actor instance parameter on this ParticleSystemComponent.
Public function Virtual void

SetAutoAttachmentParameters ( USceneComponent* Parent,
FName SocketName,
EAttachmentRule LocationRule,
EAttachmentRule RotationRule,
EAttachmentRule ScaleRule
)

 Set AutoAttachParent, AutoAttachSocketName, AutoAttachLocationRule, AutoAttachRotationRule, AutoAttachScaleRule to the specified parameters.
Public function Virtual void

SetBoolParameter ( FName ParameterName,
bool Param
)

 Set a named float instance parameter on this ParticleSystemComponent.
Public function Virtual void

SetColorParameter ( FName ParameterName,
FLinearColor Param
)

 Set a named color instance parameter on this ParticleSystemComponent.
Public function Virtual void

SetEmitterEnable ( FName EmitterName,
bool bNewEnableState
)

 Enables/Disables a sub-emitter
Public function Virtual void

SetFloatParameter ( FName ParameterName,
float Param
)

 Change a named float parameter
Public function Virtual void

SetIntParameter ( FName ParameterName,
int Param
)

 Set a named float instance parameter on this ParticleSystemComponent.
Public function Virtual void

SetUseAutoManageAttachment ( bool bAutoManage
)

 Sets whether we should automatically attach to AutoAttachParent when activated, and detach from our parent when completed.
Public function Virtual void

SetVectorParameter ( FName ParameterName,
FVector Param
)

 Set a named vector instance parameter on this ParticleSystemComponent.

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const FBodyInstance *

GetBodyInstance ( FName BoneName,
bool bGetWelded,
int32 Index
)

 Returns BodyInstance of the component.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const UMaterialInterface *

GetMaterialByName ( FName MaterialSlotName
)

 Returns the material used by the element in the slot with the specified name.
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const void Enumerates the streaming textures/meshes used by the primitive.
Public function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

 Retrieves the materials used in this component
Public function Virtual void

SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.
Public function Virtual void

SetMaterialByName ( FName MaterialSlotName,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Public function Virtual bool

GetMaterialPropertyPath ( int32 ElementIndex,
UObject*& OutOwner,
FString& OutPropertyPath,
FProperty*& OutProperty
)

 Returns full material property path and UObject owner property object Path examples: Material property path with array element and inner struct Materials[0].InnerStruct.Material Material property path with array element Materials[0] Simple material property path Materials
Public function Virtual void Called when AttachParent changes, to allow the scene to update its attachment state.
Public function Virtual void

OnChildAttached ( USceneComponent* ChildComponent
)

 Called after a child scene component is attached to this component.
Public function Virtual void

OnChildDetached ( USceneComponent* ChildComponent
)

 Called after a child scene component is detached from this component.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

Activate ( bool bReset
)

 Activates the SceneComponent, should be overridden by native child classes.
Public function Virtual Const UObject const * Give a readable name for this component, including asset name if applicable
Public function Virtual void

ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

 Called by owner actor on position shifting Component should update all relevant data structures to reflect new actor location
Public function Virtual void Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
Protected function Virtual void Used to create any rendering thread information for this component
Public function Virtual void Deactivates the SceneComponent.
Protected function Virtual void Used to shut down any rendering thread structure for this component
Public function Virtual Const bool Returns whether this component has tick enabled or not
Public function Virtual Const bool Overridable check for a component to indicate to its Owner that it should prevent the Actor from auto destroying when finished
Public function Virtual void Allows components to handle an EOF update happening mid tick.
Protected function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Protected function Virtual void Called when a component is unregistered.
Protected function Virtual void Called to send dynamic data for this component to the rendering thread
Protected function Virtual void Called to send a transform update for this component to the rendering thread
Public function Virtual void

SetComponentTickEnabled ( bool bEnabled
)

 Set this component's tick functions to be enabled or disabled.
Protected function Virtual Const bool Return true if this component is in a state where it can be activated normally.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

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 Const FString This function actually does the work for the GetDetailedInfo() and is virtual.
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyThatWillChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Enums

  Type Name Description
Public enum EForceAsyncWorkCompletion    

Typedefs

Name Description
TrailEmitterArray Array of trail emitters.

Constants

Name Description
OnSystemPreActivationChange Static delegate called for all systems on an activation change.

Deprecated Variables

  Type Name Description
Public variable UProperty TEnumAsByte< EAttachLocation::Type > AutoAttachLocationType_DEPRECATED DEPRECATED: Options for how we handle our location when we attach to the AutoAttachParent, if bAutoManageAttachment is true.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page