Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UParticleModuleOrbit |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Particles/Orbit/ParticleModuleOrbit.h |
| Include Path | #include "Particles/Orbit/ParticleModuleOrbit.h" |
Syntax
UCLASS (EditInlineNew, HideCategories=(Object, Orbit), MinimalAPI, Meta=(DisplayName="Orbit"))
class UParticleModuleOrbit : public UParticleModuleOrbitBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UParticleModule → UParticleModuleOrbitBase → UParticleModuleOrbit
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UParticleModuleOrbit
(
const FObjectInitializer& ObjectInitializer |
Particles/Orbit/ParticleModuleOrbit.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChainMode | TEnumAsByte< enum EOrbitChainMode > | Orbit modules will chain together in the order they appear in the module stack. | Particles/Orbit/ParticleModuleOrbit.h |
|
| OffsetAmount | FRawDistributionVector | The amount to offset the sprite from the particle position. | Particles/Orbit/ParticleModuleOrbit.h |
|
| OffsetOptions | FOrbitOptions | The options associated with the OffsetAmount look-up. | Particles/Orbit/ParticleModuleOrbit.h |
|
| RotationAmount | FRawDistributionVector | The amount (in 'turns') to rotate the offset about the particle position. | Particles/Orbit/ParticleModuleOrbit.h |
|
| RotationOptions | FOrbitOptions | The options associated with the RotationAmount look-up. | Particles/Orbit/ParticleModuleOrbit.h |
|
| RotationRateAmount | FRawDistributionVector | The rate (in 'turns') at which to rotate the offset about the particle positon. | Particles/Orbit/ParticleModuleOrbit.h |
|
| RotationRateOptions | FOrbitOptions | The options associated with the RotationRateAmount look-up. | Particles/Orbit/ParticleModuleOrbit.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void InitializeDefaults() |
Initializes the default values for this property | Particles/Orbit/ParticleModuleOrbit.h |
Overridden from UParticleModule
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CompileModule
(
FParticleEmitterBuildInfo& EmitterInfo |
Called once to compile the effects of this module on runtime simulation. | Particles/Orbit/ParticleModuleOrbit.h | |
virtual bool IsValidForLODLevel
(
UParticleLODLevel* LODLevel, |
Returns true if the module is valid for the provided LOD level. | Particles/Orbit/ParticleModuleOrbit.h | |
virtual uint32 RequiredBytes
(
UParticleModuleTypeDataBase* TypeData |
Returns the number of bytes that the module requires in the particle payload block. | Particles/Orbit/ParticleModuleOrbit.h | |
virtual uint32 RequiredBytesPerInstance() |
Returns the number of bytes the module requires in the emitters 'per-instance' data block. | Particles/Orbit/ParticleModuleOrbit.h | |
virtual void Spawn
(
const FSpawnContext& Context |
Particles/Orbit/ParticleModuleOrbit.h | ||
virtual void Update
(
const FUpdateContext& Context |
Particles/Orbit/ParticleModuleOrbit.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Particles/Orbit/ParticleModuleOrbit.h | ||
virtual void PostInitProperties() |
Particles/Orbit/ParticleModuleOrbit.h |