Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UParticleModuleTypeDataBeam2 |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Particles/TypeData/ParticleModuleTypeDataBeam2.h |
| Include Path | #include "Particles/TypeData/ParticleModuleTypeDataBeam2.h" |
Syntax
UCLASS (EditInlineNew, DontCollapseCategories, HideCategories=Object, MinimalAPI,
Meta=(DisplayName="Beam Data"))
class UParticleModuleTypeDataBeam2 : public UParticleModuleTypeDataBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UParticleModule → UParticleModuleTypeDataBase → UParticleModuleTypeDataBeam2
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UParticleModuleTypeDataBeam2
(
const FObjectInitializer& ObjectInitializer |
Particles/TypeData/ParticleModuleTypeDataBeam2.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAlwaysOn | uint32 | If true, there will ALWAYS be a beam... | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| BeamMethod | TEnumAsByte< enum EBeam2Method > | General Beam Variables. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| BranchParentName | FName | Beam Branching Variables. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| Distance | FRawDistributionFloat | Beam Distance Variables. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| InterpolationPoints | int32 | Indicates whether the beam should be interpolated. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| LOD_BeamModule_Noise | TArray< UParticleModuleBeamNoise * > | Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
| LOD_BeamModule_Source | TArray< UParticleModuleBeamSource * > | Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
| LOD_BeamModule_SourceModifier | TArray< UParticleModuleBeamModifier * > | Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
| LOD_BeamModule_Target | TArray< UParticleModuleBeamTarget * > | Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
| LOD_BeamModule_TargetModifier | TArray< UParticleModuleBeamModifier * > | Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
| MaxBeamCount | int32 | The number of live beams | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| RenderDirectLine | uint32 | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
|
| RenderGeometry | uint32 | Beam Rendering Variables. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| RenderLines | uint32 | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
|
| RenderTessellation | uint32 | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
|
| Sheets | int32 | The number of sheets to render | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| Speed | float | The speed at which the beam should move from source to target when firing up. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| TaperFactor | FRawDistributionFloat | Tapering factor, 0 = source of beam, 1 = target | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| TaperMethod | TEnumAsByte< enum EBeamTaperMethod > | 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 | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| TaperScale | FRawDistributionFloat | Tapering scaling This is intended to be either a constant, uniform or a ParticleParam. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| TextureTile | int32 | The number of times to tile the texture along each beam. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| TextureTileDistance | float | The distance per texture tile. 1st UV set only. 2nd UV set does not Tile. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
| UpVectorStepSize | int32 | The approach to use for determining the Up vector(s) for the beam. | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetDataPointerOffsets
(
FParticleEmitterInstance* Owner, |
GetDataPointerOffsets Retrieves the offsets to the data stored in the particle payload. | Particles/TypeData/ParticleModuleTypeDataBeam2.h | |
virtual void GetDataPointers
(
FParticleEmitterInstance* Owner, |
GetDataPointers Retrieves the data pointers stored in the particle payload. | Particles/TypeData/ParticleModuleTypeDataBeam2.h | |
void GetNoiseRange
(
FVector& NoiseMin, |
GetNoiseRange Retrieves the range of noise | Particles/TypeData/ParticleModuleTypeDataBeam2.h | |
void InitializeDefaults() |
Initializes the default values for this property | Particles/TypeData/ParticleModuleTypeDataBeam2.h |
Overridden from UParticleModuleTypeDataBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CacheModuleInfo
(
UParticleEmitter* Emitter |
Cache any desired module pointers inside this type data | Particles/TypeData/ParticleModuleTypeDataBeam2.h | |
virtual void CollectPSOPrecacheData
(
const UParticleEmitter* Emitter, |
Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
virtual FParticleEmitterInstance * CreateInstance
(
UParticleEmitter* InEmitterParent, |
Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
virtual EPrimitiveType GetPrimitiveType() |
Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
virtual const FVertexFactoryType * GetVertexFactoryType() |
Particles/TypeData/ParticleModuleTypeDataBeam2.h |
Overridden from UParticleModule
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AddModuleCurvesToEditor
(
UInterpCurveEdSetup* EdSetup, |
Add all curve-editable Objects within this module to the curve editor. | Particles/TypeData/ParticleModuleTypeDataBeam2.h | |
virtual bool CanTickInAnyThread() |
Return false if this emitter requires a game thread tick | Particles/TypeData/ParticleModuleTypeDataBeam2.h | |
virtual uint32 RequiredBytes
(
UParticleModuleTypeDataBase* TypeData |
Returns the number of bytes that the module requires in the particle payload block. | Particles/TypeData/ParticleModuleTypeDataBeam2.h | |
virtual void Spawn
(
const FSpawnContext& Context |
Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
virtual void Update
(
const FUpdateContext& Context |
Particles/TypeData/ParticleModuleTypeDataBeam2.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Particles/TypeData/ParticleModuleTypeDataBeam2.h | ||
virtual void PostInitProperties() |
Particles/TypeData/ParticleModuleTypeDataBeam2.h |