1. Epic GamesDeveloper
  3. UParticleModuleBeamModifier

UParticleModuleBeamModifier

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Particles > API/Runtime/Engine/Particles/Beam

Inheritance Hierarchy

References

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

Syntax

UCLASS (EditInlineNew, HideCategories=Object, Meta=(DisplayName="Beam Modifier"))  
class UParticleModuleBeamModifier : public UParticleModuleBeamBase

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere uint32: 1 bAbsoluteTangent If true, don't transform the tangent modifier into the tangent basis.
Public variable UProperty Category, EditAnywhere TEnumAsByte< enum BeamModifierType > ModifierType Whether this module modifies the Source or the Target.
Public variable UProperty Category, EditAnywhere FRawDistributionVector Position The value to use when modifying the position.
Public variable UProperty Category, EditAnywhere FBeamModifierOptions PositionOptions The options associated with the position.
Public variable UProperty Category, EditAnywhere FRawDistributionFloat Strength The value to use when modifying the Strength.
Public variable UProperty Category, EditAnywhere FBeamModifierOptions StrengthOptions The options associated with the Strength.
Public variable UProperty Category, EditAnywhere FRawDistributionVector Tangent The value to use when modifying the Tangent.
Public variable UProperty Category, EditAnywhere FBeamModifierOptions TangentOptions The options associated with the Tangent.

Constructors

  Type Name Description
Public function  

UParticleModuleBeamModifier ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

GetDataPointerOffsets ( FParticleEmitterInstance* Owner,
const uint8* ParticleBase,
int32& CurrentOffset,
int32& BeamDataOffset,
int32& SourceModifierOffset,
int32& TargetModifierOffset
)

 @ todo document
Public function void

GetDataPointers ( FParticleEmitterInstance* Owner,
const uint8* ParticleBase,
int32& CurrentOffset,
FBeam2TypeDataPayload*& BeamDataPayload,
FBeamParticleModifierPayloadData*& SourceModifierPayload,
FBeamParticleModifierPayloadData*& TargetModifierPayload
)

 @ todo document
Public function void Initializes the default values for this property

Overridden from UParticleModule

  Type Name Description
Public function Virtual bool

AddModuleCurvesToEditor ( UInterpCurveEdSetup* EdSetup,
TArray< const FCurveEdEntry* >& OutCurveEntries
)

 Add all curve-editable Objects within this module to the curve editor.
Public function Virtual void Helper function used by the editor to auto-populate a placed AEmitter with any instance parameters that are utilized.
Public function Virtual void Fill an array with each Object property that fulfills the FCurveEdInterface interface.
Public function Virtual void

GetParticleSysParamsUtilized ( TArray< FString >& ParticleSysParamList
)

 Retrieve the ParticleSysParams associated with this module.
Public function Virtual uint32 Returns the number of bytes that the module requires in the particle payload block.
Public function Virtual void

Spawn ( FParticleEmitterInstance* Owner,
int32 Offset,
float SpawnTime,
FBaseParticle* ParticleBase
)

 Called on a particle that is freshly spawned by the emitter.
Public function Virtual void

Update ( FParticleEmitterInstance* Owner,
int32 Offset,
float DeltaTime
)

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

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page