UParticleModuleTypeDataBeam2

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Particles/TypeData/ParticleModuleTypeDataBeam2.h

Include

#include "Particles/TypeData/ParticleModuleTypeDataBeam2.h"

Syntax

class UParticleModuleTypeDataBeam2 : public UParticleModuleTypeDataBase

Variables

Name Description

Public variable

uint32: 1

 

bAlwaysOn

If true, there will ALWAYS be a beam...

Public variable

TEnumAsByte< en...

 

BeamMethod

General Beam Variables.

Public variable

FName

 

BranchParentName

Beam Branching Variables.

Public variable

FRawDistributio...

 

Distance

Beam Distance Variables.

Public variable

int32

 

InterpolationPoints

Indicates whether the beam should be interpolated.

Public variable

TArray< UPartic...

 

LOD_BeamModule_Noise

Public variable

TArray< UPartic...

 

LOD_BeamModule_Source

Public variable

TArray< UPartic...

 

LOD_BeamModule_SourceModifier

Public variable

TArray< UPartic...

 

LOD_BeamModule_Target

Public variable

TArray< UPartic...

 

LOD_BeamModule_TargetModifier

Public variable

int32

 

MaxBeamCount

The number of live beams

Public variable

uint32: 1

 

RenderDirectLine

Public variable

uint32: 1

 

RenderGeometry

Beam Rendering Variables.

Public variable

uint32: 1

 

RenderLines

Public variable

uint32: 1

 

RenderTessellation

Public variable

int32

 

Sheets

The number of sheets to render

Public variable

float

 

Speed

The speed at which the beam should move from source to target when firing up.

Public variable

FRawDistributio...

 

TaperFactor

Tapering factor, 0 = source of beam, 1 = target

Public variable

TEnumAsByte< en...

 

TaperMethod

Tapering mode - one of the following: PEBTM_None - No tapering is applied PEBTM_Full - Taper the beam relative to source>target, regardless of current beam length PEBTM_Partial - Taper the beam relative to source>location, 0=source,1=endpoint

Public variable

FRawDistributio...

 

TaperScale

Tapering scaling This is intended to be either a constant, uniform or a ParticleParam.

Public variable

int32

 

TextureTile

The number of times to tile the texture along each beam.

Public variable

float

 

TextureTileDistance

The distance per texture tile. 1st UV set only. 2nd UV set does not Tile.

Public variable

int32

 

UpVectorStepSize

The approach to use for determining the Up vector(s) for the beam.

Constructors

Name Description

Public function

UParticleModuleTypeDataBeam2

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

void

 

GetDataPointerOffsets

(
    FParticleEmitterInstance* Owne...,
    const uint8* ParticleBase,
    int32& CurrentOffset,
    int32& BeamDataOffset,
    int32& InterpolatedPointsOffset,
    int32& NoiseRateOffset,
    int32& NoiseDeltaTimeOffset,
    int32& TargetNoisePointsOffset,
    int32& NextNoisePointsOffset,
    int32& TaperCount,
    int32& TaperValuesOffset,
    int32& NoiseDistanceScaleOffset
)

GetDataPointerOffsets Retrieves the offsets to the data stored in the particle payload.

Public function Virtual

void

 

GetDataPointers

(
    FParticleEmitterInstance* Owne...,
    const uint8* ParticleBase,
    int32& CurrentOffset,
    FBeam2TypeDataPayload*& BeamDa...,
    FVector*& InterpolatedPoints,
    float*& NoiseRate,
    float*& NoiseDeltaTime,
    FVector*& TargetNoisePoints,
    FVector*& NextNoisePoints,
    float*& TaperValues,
    float*& NoiseDistanceScale,
    FBeamParticleModifierPayloadData&#...,
    FBeamParticleModifierPayloadData&#...
)

GetDataPointers Retrieves the data pointers stored in the particle payload.

Public function

void

 

GetNoiseRange

(
    FVector& NoiseMin,
    FVector& NoiseMax
)

GetNoiseRange Retrieves the range of noise

Public function

void

 

InitializeDefaults()

Initializes the default values for this property

Overridden from UParticleModuleTypeDataBase

Name Description

Public function Virtual

void

 

CacheModuleInfo

(
    UParticleEmitter* Emitter
)

Cache any desired module pointers inside this type data

Public function Virtual

FParticleEmi...

 

CreateInstance

(
    UParticleEmitter* InEmitterPar...,
    UParticleSystemComponent* InCo...
)

Overridden from UParticleModule

Name Description

Public function Virtual

bool

 

AddModuleCurvesToEditor

(
    UInterpCurveEdSetup* EdSetup,
    TArray< const FCurveEdEntry* >...
)

Add all curve-editable Objects within this module to the curve editor.

Public function Virtual

bool

 

CanTickInAnyThread()

Return false if this emitter requires a game thread tick

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.

Select Skin
Light
Dark

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