UParticleModuleBeamSource

Windows
MacOS
Linux

Inheritance Hierarchy

Syntax

class UParticleModuleBeamSource : public UParticleModuleBeamBase

Variables

Name Description

Public variable

uint32: 1

 

bLockSource

Whether to lock the source to the life of the particle.

Public variable

uint32: 1

 

bLockSourceStength

Whether to lock the source to the life of the particle.

Public variable

uint32: 1

 

bLockSourceTangent

Whether to lock the source to the life of the particle.

Public variable

uint32: 1

 

bSourceAbsolute

Whether to treat the as an absolute position in world space.

Public variable

int32

 

LastSelectedParticleIndex

Public variable

FRawDistributio...

 

Source

Default source-point to use.

Public variable

TEnumAsByte< en...

 

SourceMethod

The method flag.

Public variable

FName

 

SourceName

The strength of the tangent from the source point for each beam.

Public variable

FRawDistributio...

 

SourceStrength

The strength of the tangent from the source point for each beam.

Public variable

FRawDistributio...

 

SourceTangent

The tangent for the source point for each beam.

Public variable

TEnumAsByte< en...

 

SourceTangentMethod

The method to use for the source tangent.

Constructors

Name Description

Public function

UParticleModuleBeamSource

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

GetDataPointerOffsets

(
    FParticleEmitterInstance* Owne...,
    const uint8* ParticleBase,
    int32& CurrentOffset,
    int32& ParticleSourceOffset,
    int32& BranchSourceOffset
)

Public function

void

 

GetDataPointers

(
    FParticleEmitterInstance* Owne...,
    const uint8* ParticleBase,
    int32& CurrentOffset,
    FBeamParticleSourceTargetPayloadDat...,
    FBeamParticleSourceBranchPayloadDat...
)

Public function

void

 

InitializeDefaults()

Initializes the default values for this property

Public function

bool

 

ResolveSourceData

(
    FParticleBeam2EmitterInstance*...,
    FBeam2TypeDataPayload* BeamDat...,
    const uint8* ParticleBase,
    int32& CurrentOffset,
    int32 ParticleIndex,
    bool bSpawning,
    FBeamParticleModifierPayloadData&#...
)

Overridden from UParticleModule

Name Description

Public function Virtual

void

 

AutoPopulateInstanceProperties

(
    UParticleSystemComponent* PSys...
)

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

Public function Virtual

void

 

GetParticleSysParamsUtilized

(
    TArray< FString >& ParticleSysPara...
)

Retrieve the ParticleSysParams associated with this module.

Public function Virtual

uint32

 

RequiredBytes

(
    UParticleModuleTypeDataBase* T...
)

Returns the number of bytes that the module requires in the particle payload block.

Public function Virtual

void

 

Spawn

(
    FParticleEmitterInstance* Owne...,
    int32 Offset,
    float SpawnTime,
    FBaseParticle* ParticleBase
)

Called on a particle that is freshly spawned by the emitter.

Public function Virtual

void

 

Update

(
    FParticleEmitterInstance* Owne...,
    int32 Offset,
    float DeltaTime
)

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

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

References

Module

Engine

Header

Runtime/Engine/Classes/Particles/Beam/ParticleModuleBeamSource.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback