UParticleModuleBeamModifier

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Particles/Beam/ParticleModuleBeamModifier.h

Include

#include "Particles/Beam/ParticleModuleBeamModifier.h"

Syntax

class UParticleModuleBeamModifier : public UParticleModuleBeamBase

Variables

Name Description

Public variable

uint32: 1

 

bAbsoluteTangent

If true, don't transform the tangent modifier into the tangent basis.

Public variable

TEnumAsByte< en...

 

ModifierType

Whether this module modifies the Source or the Target.

Public variable

FRawDistributio...

 

Position

The value to use when modifying the position.

Public variable

FBeamModifierOp...

 

PositionOptions

The options associated with the position.

Public variable

FRawDistributio...

 

Strength

The value to use when modifying the Strength.

Public variable

FBeamModifierOp...

 

StrengthOptions

The options associated with the Strength.

Public variable

FRawDistributio...

 

Tangent

The value to use when modifying the Tangent.

Public variable

FBeamModifierOp...

 

TangentOptions

The options associated with the Tangent.

Constructors

Name Description

Public function

UParticleModuleBeamModifier

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

GetDataPointerOffsets

(
    FParticleEmitterInstance* Owne...,
    const uint8* ParticleBase,
    int32& CurrentOffset,
    int32& BeamDataOffset,
    int32& SourceModifierOffset,
    int32& TargetModifierOffset
)

@ todo document

Public function

void

 

GetDataPointers

(
    FParticleEmitterInstance* Owne...,
    const uint8* ParticleBase,
    int32& CurrentOffset,
    FBeam2TypeDataPayload*& BeamDa...,
    FBeamParticleModifierPayloadData&#...,
    FBeamParticleModifierPayloadData&#...
)

@ todo document

Public function

void

 

InitializeDefaults()

Initializes the default values for this property

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

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

 

GetCurveObjects

(
    TArray< FParticleCurvePair >& OutC...
)

Fill an array with each Object property that fulfills the FCurveEdInterface interface.

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.

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