1. Epic GamesDeveloper
  3. UParticleModuleBeamSource

UParticleModuleBeamSource

API > API/Runtime > API/Runtime/Engine

   
Name UParticleModuleBeamSource
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Particles/Beam/ParticleModuleBeamSource.h
Include Path #include "Particles/Beam/ParticleModuleBeamSource.h"

Syntax

UCLASS (EditInlineNew, HideCategories=Object, MinimalAPI, Meta=(DisplayName="Source"))  
class UParticleModuleBeamSource : public UParticleModuleBeamBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UParticleModuleBeamSource ( const FObjectInitializer& ObjectInitializer
)

   Particles/Beam/ParticleModuleBeamSource.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bLockSource uint32 Whether to lock the source to the life of the particle. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source
bLockSourceStength uint32 Whether to lock the source to the life of the particle. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source
bLockSourceTangent uint32 Whether to lock the source to the life of the particle. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source
bSourceAbsolute uint32 Whether to treat the as an absolute position in world space. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source
LastSelectedParticleIndex int32   Particles/Beam/ParticleModuleBeamSource.h  
Source FRawDistributionVector Default source-point to use. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source
SourceMethod TEnumAsByte< enum Beam2SourceTargetMethod > The method flag. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source
SourceName FName The strength of the tangent from the source point for each beam. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source
SourceStrength FRawDistributionFloat The strength of the tangent from the source point for each beam. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source
SourceTangent FRawDistributionVector The tangent for the source point for each beam. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source
SourceTangentMethod TEnumAsByte< enum Beam2SourceTargetTangentMethod > The method to use for the source tangent. Particles/Beam/ParticleModuleBeamSource.h
  • EditAnywhere
  • Category=Source

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GetDataPointerOffsets ( FParticleEmitterInstance* Owner,
const uint8* ParticleBase,
int32& CurrentOffset,
int32& ParticleSourceOffset,
int32& BranchSourceOffset
)

   Particles/Beam/ParticleModuleBeamSource.h  

void GetDataPointers ( FParticleEmitterInstance* Owner,
const uint8* ParticleBase,
int32& CurrentOffset,
FBeamParticleSourceTargetPayloadData*& ParticleSource,
FBeamParticleSourceBranchPayloadData*& BranchSource
)

   Particles/Beam/ParticleModuleBeamSource.h  

void InitializeDefaults()

 Initializes the default values for this property Particles/Beam/ParticleModuleBeamSource.h  

bool ResolveSourceData ( const FContext& Context,
FParticleBeam2EmitterInstance* BeamInst,
FBeam2TypeDataPayload* BeamData,
const uint8* ParticleBase,
int32& CurrentOffset,
int32 ParticleIndex,
bool bSpawning,
FBeamParticleModifierPayloadData* ModifierData
)

   Particles/Beam/ParticleModuleBeamSource.h  

Overridden from UParticleModule

Name Remarks Include Path Unreal Specifiers

virtual void AutoPopulateInstanceProperties ( UParticleSystemComponent* PSysComp
)

 Helper function used by the editor to auto-populate a placed AEmitter with any instance parameters that are utilized. Particles/Beam/ParticleModuleBeamSource.h  

virtual void GetParticleSysParamsUtilized ( TArray< FString >& ParticleSysParamList
)

 Retrieve the ParticleSysParams associated with this module. Particles/Beam/ParticleModuleBeamSource.h  

virtual uint32 RequiredBytes ( UParticleModuleTypeDataBase* TypeData
)

 Returns the number of bytes that the module requires in the particle payload block. Particles/Beam/ParticleModuleBeamSource.h  

virtual void Spawn ( const FSpawnContext& Context
)

   Particles/Beam/ParticleModuleBeamSource.h  

virtual void Update ( const FUpdateContext& Context
)

   Particles/Beam/ParticleModuleBeamSource.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Particles/Beam/ParticleModuleBeamSource.h  

virtual void PostInitProperties()

   Particles/Beam/ParticleModuleBeamSource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page