1. Epic GamesDeveloper
  3. UParticleModuleBeamModifier

UParticleModuleBeamModifier

API > API/Runtime > API/Runtime/Engine

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

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UParticleModuleBeamModifier ( const FObjectInitializer& ObjectInitializer
)

   Particles/Beam/ParticleModuleBeamModifier.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAbsoluteTangent uint32 If true, don't transform the tangent modifier into the tangent basis. Particles/Beam/ParticleModuleBeamModifier.h
  • EditAnywhere
  • Category=Tangent
ModifierType TEnumAsByte< enum BeamModifierType > Whether this module modifies the Source or the Target. Particles/Beam/ParticleModuleBeamModifier.h
  • EditAnywhere
  • Category=Modifier
Position FRawDistributionVector The value to use when modifying the position. Particles/Beam/ParticleModuleBeamModifier.h
  • EditAnywhere
  • Category=Position
PositionOptions FBeamModifierOptions The options associated with the position. Particles/Beam/ParticleModuleBeamModifier.h
  • EditAnywhere
  • Category=Position
Strength FRawDistributionFloat The value to use when modifying the Strength. Particles/Beam/ParticleModuleBeamModifier.h
  • EditAnywhere
  • Category=Strength
StrengthOptions FBeamModifierOptions The options associated with the Strength. Particles/Beam/ParticleModuleBeamModifier.h
  • EditAnywhere
  • Category=Strength
Tangent FRawDistributionVector The value to use when modifying the Tangent. Particles/Beam/ParticleModuleBeamModifier.h
  • EditAnywhere
  • Category=Tangent
TangentOptions FBeamModifierOptions The options associated with the Tangent. Particles/Beam/ParticleModuleBeamModifier.h
  • EditAnywhere
  • Category=Tangent

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 @ todo document Particles/Beam/ParticleModuleBeamModifier.h  

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

 @ todo document Particles/Beam/ParticleModuleBeamModifier.h  

void InitializeDefaults()

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

Overridden from UParticleModule

Name Remarks Include Path Unreal Specifiers

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

 Add all curve-editable Objects within this module to the curve editor. Particles/Beam/ParticleModuleBeamModifier.h  

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/ParticleModuleBeamModifier.h  

virtual void GetCurveObjects ( TArray< FParticleCurvePair >& OutCurves
)

 Fill an array with each Object property that fulfills the FCurveEdInterface interface. Particles/Beam/ParticleModuleBeamModifier.h  

virtual void GetParticleSysParamsUtilized ( TArray< FString >& ParticleSysParamList
)

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

virtual uint32 RequiredBytes ( UParticleModuleTypeDataBase* TypeData
)

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

virtual void Spawn ( const FSpawnContext& Context
)

   Particles/Beam/ParticleModuleBeamModifier.h  

virtual void Update ( const FUpdateContext& Context
)

   Particles/Beam/ParticleModuleBeamModifier.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Particles/Beam/ParticleModuleBeamModifier.h  

virtual void PostInitProperties()

   Particles/Beam/ParticleModuleBeamModifier.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page